Billhighway Cloud API

<back to all web services

StandardSignupFormPostRq

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

public class dtos
{

    public static class StandardSignupFormPostRq
    {
        public Boolean IsCreditCard = null;
        public StandardSignupFormMemberInfo MemberInfo = null;
        public ClientVerification VerificationInfo = null;
        public CcPaymentInformation CcPaymentInfo = null;
        public AchPaymentInformation AchPaymentInfo = null;
        public ArrayList<ContributionItem> Contributions = null;
        
        public Boolean getIsCreditCard() { return IsCreditCard; }
        public StandardSignupFormPostRq setIsCreditCard(Boolean value) { this.IsCreditCard = value; return this; }
        public StandardSignupFormMemberInfo getMemberInfo() { return MemberInfo; }
        public StandardSignupFormPostRq setMemberInfo(StandardSignupFormMemberInfo value) { this.MemberInfo = value; return this; }
        public ClientVerification getVerificationInfo() { return VerificationInfo; }
        public StandardSignupFormPostRq setVerificationInfo(ClientVerification value) { this.VerificationInfo = value; return this; }
        public CcPaymentInformation getCcPaymentInfo() { return CcPaymentInfo; }
        public StandardSignupFormPostRq setCcPaymentInfo(CcPaymentInformation value) { this.CcPaymentInfo = value; return this; }
        public AchPaymentInformation getAchPaymentInfo() { return AchPaymentInfo; }
        public StandardSignupFormPostRq setAchPaymentInfo(AchPaymentInformation value) { this.AchPaymentInfo = value; return this; }
        public ArrayList<ContributionItem> getContributions() { return Contributions; }
        public StandardSignupFormPostRq setContributions(ArrayList<ContributionItem> value) { this.Contributions = value; return this; }
    }

    public static class StandardSignupFormMemberInfo
    {
        public Integer BhUserID = null;
        public Integer BhGroupID = null;
        public String ClientUserID = null;
        public String ClientGroupID = null;
        public Integer NationalID = null;
        public String FirstName = null;
        public String MiddleName = null;
        public String LastName = null;
        public String Address1 = null;
        public String Address2 = null;
        public String City = null;
        public String State = null;
        public String PostalCode = null;
        public String Country = null;
        public String Email = null;
        public String Phone = null;
        public String PacContributionAmount = null;
        public Date DateOfBirth = null;
        public String MemberTypeClientID = null;
        public String BillingTypeID = null;
        public Integer FiscalYear = null;
        public Boolean OptedToPayCTADues = null;
        
        public Integer getBhUserID() { return BhUserID; }
        public StandardSignupFormMemberInfo setBhUserID(Integer value) { this.BhUserID = value; return this; }
        public Integer getBhGroupID() { return BhGroupID; }
        public StandardSignupFormMemberInfo setBhGroupID(Integer value) { this.BhGroupID = value; return this; }
        public String getClientUserID() { return ClientUserID; }
        public StandardSignupFormMemberInfo setClientUserID(String value) { this.ClientUserID = value; return this; }
        public String getClientGroupID() { return ClientGroupID; }
        public StandardSignupFormMemberInfo setClientGroupID(String value) { this.ClientGroupID = value; return this; }
        public Integer getNationalID() { return NationalID; }
        public StandardSignupFormMemberInfo setNationalID(Integer value) { this.NationalID = value; return this; }
        public String getFirstName() { return FirstName; }
        public StandardSignupFormMemberInfo setFirstName(String value) { this.FirstName = value; return this; }
        public String getMiddleName() { return MiddleName; }
        public StandardSignupFormMemberInfo setMiddleName(String value) { this.MiddleName = value; return this; }
        public String getLastName() { return LastName; }
        public StandardSignupFormMemberInfo setLastName(String value) { this.LastName = value; return this; }
        public String getAddress1() { return Address1; }
        public StandardSignupFormMemberInfo setAddress1(String value) { this.Address1 = value; return this; }
        public String getAddress2() { return Address2; }
        public StandardSignupFormMemberInfo setAddress2(String value) { this.Address2 = value; return this; }
        public String getCity() { return City; }
        public StandardSignupFormMemberInfo setCity(String value) { this.City = value; return this; }
        public String getState() { return State; }
        public StandardSignupFormMemberInfo setState(String value) { this.State = value; return this; }
        public String getPostalCode() { return PostalCode; }
        public StandardSignupFormMemberInfo setPostalCode(String value) { this.PostalCode = value; return this; }
        public String getCountry() { return Country; }
        public StandardSignupFormMemberInfo setCountry(String value) { this.Country = value; return this; }
        public String getEmail() { return Email; }
        public StandardSignupFormMemberInfo setEmail(String value) { this.Email = value; return this; }
        public String getPhone() { return Phone; }
        public StandardSignupFormMemberInfo setPhone(String value) { this.Phone = value; return this; }
        public String getPacContributionAmount() { return PacContributionAmount; }
        public StandardSignupFormMemberInfo setPacContributionAmount(String value) { this.PacContributionAmount = value; return this; }
        public Date getDateOfBirth() { return DateOfBirth; }
        public StandardSignupFormMemberInfo setDateOfBirth(Date value) { this.DateOfBirth = value; return this; }
        public String getMemberTypeClientID() { return MemberTypeClientID; }
        public StandardSignupFormMemberInfo setMemberTypeClientID(String value) { this.MemberTypeClientID = value; return this; }
        public String getBillingTypeID() { return BillingTypeID; }
        public StandardSignupFormMemberInfo setBillingTypeID(String value) { this.BillingTypeID = value; return this; }
        public Integer getFiscalYear() { return FiscalYear; }
        public StandardSignupFormMemberInfo setFiscalYear(Integer value) { this.FiscalYear = value; return this; }
        public Boolean isOptedToPayCTADues() { return OptedToPayCTADues; }
        public StandardSignupFormMemberInfo setOptedToPayCTADues(Boolean value) { this.OptedToPayCTADues = value; return this; }
    }

    public static class ClientVerification
    {
        public String Provider = null;
        public String VerificationCode = null;
        
        public String getProvider() { return Provider; }
        public ClientVerification setProvider(String value) { this.Provider = value; return this; }
        public String getVerificationCode() { return VerificationCode; }
        public ClientVerification setVerificationCode(String value) { this.VerificationCode = value; return this; }
    }

    public static class CcPaymentInformation
    {
        public String CardNumber = null;
        public String Cvv = null;
        public Integer ExpMonth = null;
        public Integer ExpYear = null;
        public String CardholderName = null;
        public String Country = null;
        public String BillingAddress = null;
        public String Address1 = null;
        public String Address2 = null;
        public String City = null;
        public String StateProvince = null;
        public String PostalCode = null;
        
        public String getCardNumber() { return CardNumber; }
        public CcPaymentInformation setCardNumber(String value) { this.CardNumber = value; return this; }
        public String getCvv() { return Cvv; }
        public CcPaymentInformation setCvv(String value) { this.Cvv = value; return this; }
        public Integer getExpMonth() { return ExpMonth; }
        public CcPaymentInformation setExpMonth(Integer value) { this.ExpMonth = value; return this; }
        public Integer getExpYear() { return ExpYear; }
        public CcPaymentInformation setExpYear(Integer value) { this.ExpYear = value; return this; }
        public String getCardholderName() { return CardholderName; }
        public CcPaymentInformation setCardholderName(String value) { this.CardholderName = value; return this; }
        public String getCountry() { return Country; }
        public CcPaymentInformation setCountry(String value) { this.Country = value; return this; }
        public String getBillingAddress() { return BillingAddress; }
        public CcPaymentInformation setBillingAddress(String value) { this.BillingAddress = value; return this; }
        public String getAddress1() { return Address1; }
        public CcPaymentInformation setAddress1(String value) { this.Address1 = value; return this; }
        public String getAddress2() { return Address2; }
        public CcPaymentInformation setAddress2(String value) { this.Address2 = value; return this; }
        public String getCity() { return City; }
        public CcPaymentInformation setCity(String value) { this.City = value; return this; }
        public String getStateProvince() { return StateProvince; }
        public CcPaymentInformation setStateProvince(String value) { this.StateProvince = value; return this; }
        public String getPostalCode() { return PostalCode; }
        public CcPaymentInformation setPostalCode(String value) { this.PostalCode = value; return this; }
    }

    public static class AchPaymentInformation
    {
        public String AccountHolderName = null;
        public String CheckNumber = null;
        public String RoutingNumber = null;
        public String AccountNumber = null;
        public String AccountType = null;
        
        public String getAccountHolderName() { return AccountHolderName; }
        public AchPaymentInformation setAccountHolderName(String value) { this.AccountHolderName = value; return this; }
        public String getCheckNumber() { return CheckNumber; }
        public AchPaymentInformation setCheckNumber(String value) { this.CheckNumber = value; return this; }
        public String getRoutingNumber() { return RoutingNumber; }
        public AchPaymentInformation setRoutingNumber(String value) { this.RoutingNumber = value; return this; }
        public String getAccountNumber() { return AccountNumber; }
        public AchPaymentInformation setAccountNumber(String value) { this.AccountNumber = value; return this; }
        public String getAccountType() { return AccountType; }
        public AchPaymentInformation setAccountType(String value) { this.AccountType = value; return this; }
    }

    public static class ContributionItem
    {
        public Integer ChartOfAccountId = null;
        public String ChartOfAccountRefId = null;
        public BigDecimal Amount = null;
        
        public Integer getChartOfAccountId() { return ChartOfAccountId; }
        public ContributionItem setChartOfAccountId(Integer value) { this.ChartOfAccountId = value; return this; }
        public String getChartOfAccountRefId() { return ChartOfAccountRefId; }
        public ContributionItem setChartOfAccountRefId(String value) { this.ChartOfAccountRefId = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public ContributionItem setAmount(BigDecimal value) { this.Amount = value; return this; }
    }

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

}

Java StandardSignupFormPostRq 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/api/standardSignup HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StandardSignupFormPostRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.StandardSignupForm.Request">
  <AchPaymentInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:AccountHolderName>String</d2p1:AccountHolderName>
    <d2p1:AccountNumber>String</d2p1:AccountNumber>
    <d2p1:AccountType>String</d2p1:AccountType>
    <d2p1:CheckNumber>String</d2p1:CheckNumber>
    <d2p1:RoutingNumber>String</d2p1:RoutingNumber>
  </AchPaymentInfo>
  <CcPaymentInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:Address1>String</d2p1:Address1>
    <d2p1:Address2>String</d2p1:Address2>
    <d2p1:BillingAddress>String</d2p1:BillingAddress>
    <d2p1:CardNumber>String</d2p1:CardNumber>
    <d2p1:CardholderName>String</d2p1:CardholderName>
    <d2p1:City>String</d2p1:City>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:Cvv>String</d2p1:Cvv>
    <d2p1:ExpMonth>0</d2p1:ExpMonth>
    <d2p1:ExpYear>0</d2p1:ExpYear>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:StateProvince>String</d2p1:StateProvince>
  </CcPaymentInfo>
  <Contributions xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringObligation">
    <d2p1:ContributionItem>
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:ChartOfAccountId>0</d2p1:ChartOfAccountId>
      <d2p1:ChartOfAccountRefId>String</d2p1:ChartOfAccountRefId>
    </d2p1:ContributionItem>
  </Contributions>
  <IsCreditCard>false</IsCreditCard>
  <MemberInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.StandardSignupForm">
    <d2p1:Address1>String</d2p1:Address1>
    <d2p1:Address2>String</d2p1:Address2>
    <d2p1:BhGroupID>0</d2p1:BhGroupID>
    <d2p1:BhUserID>0</d2p1:BhUserID>
    <d2p1:BillingTypeID>String</d2p1:BillingTypeID>
    <d2p1:City>String</d2p1:City>
    <d2p1:ClientGroupID>String</d2p1:ClientGroupID>
    <d2p1:ClientUserID>String</d2p1:ClientUserID>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:FiscalYear>0</d2p1:FiscalYear>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:MemberTypeClientID>String</d2p1:MemberTypeClientID>
    <d2p1:MiddleName>String</d2p1:MiddleName>
    <d2p1:NationalID>0</d2p1:NationalID>
    <d2p1:OptedToPayCTADues>false</d2p1:OptedToPayCTADues>
    <d2p1:PacContributionAmount>String</d2p1:PacContributionAmount>
    <d2p1:Phone>String</d2p1:Phone>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:State>String</d2p1:State>
  </MemberInfo>
  <VerificationInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:Provider>String</d2p1:Provider>
    <d2p1:VerificationCode>String</d2p1:VerificationCode>
  </VerificationInfo>
</StandardSignupFormPostRq>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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