Billhighway Cloud API

<back to all web services

UserObligationSignupPostRq

The following routes are available for this service:
POST/signup/obligation
UserObligationSignupPostRq Parameters:
NameParameterData TypeRequiredDescription
ModelStateIdbodyintNo
ChapBillCatIdbodyintNo
VoluntaryBiWeeklyContributionbodydecimalNo
OtherAmountbodydecimalNo
PayerNamebodystringNo
RoutingNumberbodystringNo
AchAccountTypebodystringNo
AchAccountNumberbodystringNo
AchConfirmAccountNumberbodystringNo
SignaturePadbodystringNo
ConfirmSignaturebodyboolNo
BhUserIDbodyintNo
ClientDocNobodystringNo
EmailbodystringNo
BhChapterIdbodyintNo
UserObligationSignupPostRs Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /signup/obligation HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ModelStateId: 0,
	ChapBillCatId: 0,
	VoluntaryBiWeeklyContribution: 0,
	OtherAmount: 0,
	PayerName: String,
	RoutingNumber: String,
	AchAccountType: String,
	AchAccountNumber: String,
	AchConfirmAccountNumber: String,
	SignaturePad: String,
	ConfirmSignature: False,
	BhUserID: 0,
	ClientDocNo: String,
	Email: String,
	BhChapterId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Message: String
}