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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<UserObligationSignupPostRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringObligation.Request">
  <AchAccountNumber>String</AchAccountNumber>
  <AchAccountType>String</AchAccountType>
  <AchConfirmAccountNumber>String</AchConfirmAccountNumber>
  <BhChapterId>0</BhChapterId>
  <BhUserID>0</BhUserID>
  <ChapBillCatId>0</ChapBillCatId>
  <ClientDocNo>String</ClientDocNo>
  <ConfirmSignature>false</ConfirmSignature>
  <Email>String</Email>
  <ModelStateId>0</ModelStateId>
  <OtherAmount>0</OtherAmount>
  <PayerName>String</PayerName>
  <RoutingNumber>String</RoutingNumber>
  <SignaturePad>String</SignaturePad>
  <VoluntaryBiWeeklyContribution>0</VoluntaryBiWeeklyContribution>
</UserObligationSignupPostRq>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserObligationSignupPostRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringObligation.Response">
  <Message>String</Message>
</UserObligationSignupPostRs>