Billhighway Cloud API

StandardSignupFormPostRq

The following routes are available for this service:
POST	/signup/api/standardSignup

**StandardSignupFormPostRq** Parameters:
Name	Parameter	Data Type	Required
IsCreditCard	body	bool	No
MemberInfo	body	StandardSignupFormMemberInfo	No
VerificationInfo	body	ClientVerification	No
CcPaymentInfo	body	CcPaymentInformation	No
AchPaymentInfo	body	AchPaymentInformation	No
Contributions	body	List<ContributionItem>	No

**StandardSignupFormMemberInfo** Parameters:
Name	Parameter	Data Type	Required
BhUserID	form	int	No
BhGroupID	form	int	No
ClientUserID	form	string	No
ClientGroupID	form	string	No
NationalID	form	int	No
FirstName	form	string	No
MiddleName	form	string	No
LastName	form	string	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
State	form	string	No
PostalCode	form	string	No
Country	form	string	No
Email	form	string	No
Phone	form	string	No
PacContributionAmount	form	string	No
DateOfBirth	form	DateTime?	No
MemberTypeClientID	form	string	No
BillingTypeID	form	string	No
FiscalYear	form	int	No
OptedToPayCTADues	form	bool	No

**ClientVerification** Parameters:
Name	Parameter	Data Type	Required	Description
Provider	form	string	No
VerificationCode	form	string	No

**CcPaymentInformation** Parameters:
Name	Parameter	Data Type	Required
CardNumber	form	string	No
Cvv	form	string	No
ExpMonth	form	int	No
ExpYear	form	int	No
CardholderName	form	string	No
Country	form	string	No
BillingAddress	form	string	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
StateProvince	form	string	No
PostalCode	form	string	No

**AchPaymentInformation** Parameters:
Name	Parameter	Data Type	Required
AccountHolderName	form	string	No
CheckNumber	form	string	No
RoutingNumber	form	string	No
AccountNumber	form	string	No
AccountType	form	string	No

**ContributionItem** Parameters:
Name	Parameter	Data Type	Required
ChartOfAccountId	form	int	No
ChartOfAccountRefId	form	string	No
Amount	form	decimal	No

**StandardSignupFormPostRs** Parameters:
Name	Parameter	Data Type	Required	Description
Message	form	string	No

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>