Billhighway Cloud API

<back to all web services

UserObligationSignupPostRq

The following routes are available for this service:
POST/signup/obligation
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class UserObligationSignupPostRq
    {
        public Integer ModelStateId = null;
        public Integer ChapBillCatId = null;
        public BigDecimal VoluntaryBiWeeklyContribution = null;
        public BigDecimal OtherAmount = null;
        public String PayerName = null;
        public String RoutingNumber = null;
        public String AchAccountType = null;
        public String AchAccountNumber = null;
        public String AchConfirmAccountNumber = null;
        public String SignaturePad = null;
        public Boolean ConfirmSignature = null;
        public Integer BhUserID = null;
        public String ClientDocNo = null;
        public String Email = null;
        public Integer BhChapterId = null;
        
        public Integer getModelStateId() { return ModelStateId; }
        public UserObligationSignupPostRq setModelStateId(Integer value) { this.ModelStateId = value; return this; }
        public Integer getChapBillCatId() { return ChapBillCatId; }
        public UserObligationSignupPostRq setChapBillCatId(Integer value) { this.ChapBillCatId = value; return this; }
        public BigDecimal getVoluntaryBiWeeklyContribution() { return VoluntaryBiWeeklyContribution; }
        public UserObligationSignupPostRq setVoluntaryBiWeeklyContribution(BigDecimal value) { this.VoluntaryBiWeeklyContribution = value; return this; }
        public BigDecimal getOtherAmount() { return OtherAmount; }
        public UserObligationSignupPostRq setOtherAmount(BigDecimal value) { this.OtherAmount = value; return this; }
        public String getPayerName() { return PayerName; }
        public UserObligationSignupPostRq setPayerName(String value) { this.PayerName = value; return this; }
        public String getRoutingNumber() { return RoutingNumber; }
        public UserObligationSignupPostRq setRoutingNumber(String value) { this.RoutingNumber = value; return this; }
        public String getAchAccountType() { return AchAccountType; }
        public UserObligationSignupPostRq setAchAccountType(String value) { this.AchAccountType = value; return this; }
        public String getAchAccountNumber() { return AchAccountNumber; }
        public UserObligationSignupPostRq setAchAccountNumber(String value) { this.AchAccountNumber = value; return this; }
        public String getAchConfirmAccountNumber() { return AchConfirmAccountNumber; }
        public UserObligationSignupPostRq setAchConfirmAccountNumber(String value) { this.AchConfirmAccountNumber = value; return this; }
        public String getSignaturePad() { return SignaturePad; }
        public UserObligationSignupPostRq setSignaturePad(String value) { this.SignaturePad = value; return this; }
        public Boolean isConfirmSignature() { return ConfirmSignature; }
        public UserObligationSignupPostRq setConfirmSignature(Boolean value) { this.ConfirmSignature = value; return this; }
        public Integer getBhUserID() { return BhUserID; }
        public UserObligationSignupPostRq setBhUserID(Integer value) { this.BhUserID = value; return this; }
        public String getClientDocNo() { return ClientDocNo; }
        public UserObligationSignupPostRq setClientDocNo(String value) { this.ClientDocNo = value; return this; }
        public String getEmail() { return Email; }
        public UserObligationSignupPostRq setEmail(String value) { this.Email = value; return this; }
        public Integer getBhChapterId() { return BhChapterId; }
        public UserObligationSignupPostRq setBhChapterId(Integer value) { this.BhChapterId = value; return this; }
    }

    public static class UserObligationSignupPostRs
    {
        public String Message = null;
        
        public String getMessage() { return Message; }
        public UserObligationSignupPostRs setMessage(String value) { this.Message = value; return this; }
    }

}

Java UserObligationSignupPostRq DTOs

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>