Billhighway Cloud API

<back to all web services

StandardSignupFormPostRq

The following routes are available for this service:
POST/signup/api/standardSignup
StandardSignupFormPostRq Parameters:
NameParameterData TypeRequiredDescription
IsCreditCardbodyboolNo
MemberInfobodyStandardSignupFormMemberInfoNo
VerificationInfobodyClientVerificationNo
CcPaymentInfobodyCcPaymentInformationNo
AchPaymentInfobodyAchPaymentInformationNo
ContributionsbodyList<ContributionItem>No
StandardSignupFormMemberInfo Parameters:
NameParameterData TypeRequiredDescription
BhUserIDformintNo
BhGroupIDformintNo
ClientUserIDformstringNo
ClientGroupIDformstringNo
NationalIDformintNo
FirstNameformstringNo
MiddleNameformstringNo
LastNameformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
PostalCodeformstringNo
CountryformstringNo
EmailformstringNo
PhoneformstringNo
PacContributionAmountformstringNo
DateOfBirthformDateTime?No
MemberTypeClientIDformstringNo
BillingTypeIDformstringNo
FiscalYearformintNo
OptedToPayCTADuesformboolNo
ClientVerification Parameters:
NameParameterData TypeRequiredDescription
ProviderformstringNo
VerificationCodeformstringNo
CcPaymentInformation Parameters:
NameParameterData TypeRequiredDescription
CardNumberformstringNo
CvvformstringNo
ExpMonthformintNo
ExpYearformintNo
CardholderNameformstringNo
CountryformstringNo
BillingAddressformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateProvinceformstringNo
PostalCodeformstringNo
AchPaymentInformation Parameters:
NameParameterData TypeRequiredDescription
AccountHolderNameformstringNo
CheckNumberformstringNo
RoutingNumberformstringNo
AccountNumberformstringNo
AccountTypeformstringNo
ContributionItem Parameters:
NameParameterData TypeRequiredDescription
ChartOfAccountIdformintNo
ChartOfAccountRefIdformstringNo
AmountformdecimalNo
StandardSignupFormPostRs 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/api/standardSignup HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	IsCreditCard: False,
	MemberInfo: 
	{
		BhUserID: 0,
		BhGroupID: 0,
		ClientUserID: String,
		ClientGroupID: String,
		NationalID: 0,
		FirstName: String,
		MiddleName: String,
		LastName: String,
		Address1: String,
		Address2: String,
		City: String,
		State: String,
		PostalCode: String,
		Country: String,
		Email: String,
		Phone: String,
		PacContributionAmount: String,
		DateOfBirth: 0001-01-01,
		MemberTypeClientID: String,
		BillingTypeID: String,
		FiscalYear: 0,
		OptedToPayCTADues: False
	},
	VerificationInfo: 
	{
		Provider: String,
		VerificationCode: String
	},
	CcPaymentInfo: 
	{
		CardNumber: String,
		Cvv: String,
		ExpMonth: 0,
		ExpYear: 0,
		CardholderName: String,
		Country: String,
		BillingAddress: String,
		Address1: String,
		Address2: String,
		City: String,
		StateProvince: String,
		PostalCode: String
	},
	AchPaymentInfo: 
	{
		AccountHolderName: String,
		CheckNumber: String,
		RoutingNumber: String,
		AccountNumber: String,
		AccountType: String
	},
	Contributions: 
	[
		{
			ChartOfAccountId: 0,
			ChartOfAccountRefId: String,
			Amount: 0
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Message: String
}