Billhighway Cloud API

<back to all web services

StandardSignupFormPostRq

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

public class StandardSignupFormPostRq : Codable
{
    public var isCreditCard:Bool?
    public var memberInfo:StandardSignupFormMemberInfo?
    public var verificationInfo:ClientVerification?
    public var ccPaymentInfo:CcPaymentInformation?
    public var achPaymentInfo:AchPaymentInformation?
    public var contributions:[ContributionItem] = []

    required public init(){}
}

public class StandardSignupFormMemberInfo : Codable
{
    public var bhUserID:Int?
    public var bhGroupID:Int?
    public var clientUserID:String?
    public var clientGroupID:String?
    public var nationalID:Int?
    public var firstName:String?
    public var middleName:String?
    public var lastName:String?
    public var address1:String?
    public var address2:String?
    public var city:String?
    public var state:String?
    public var postalCode:String?
    public var country:String?
    public var email:String?
    public var phone:String?
    public var pacContributionAmount:String?
    public var dateOfBirth:Date?
    public var memberTypeClientID:String?
    public var billingTypeID:String?
    public var fiscalYear:Int?
    public var optedToPayCTADues:Bool?

    required public init(){}
}

public class ClientVerification : Codable
{
    public var provider:String?
    public var verificationCode:String?

    required public init(){}
}

public class CcPaymentInformation : Codable
{
    public var cardNumber:String?
    public var cvv:String?
    public var expMonth:Int?
    public var expYear:Int?
    public var cardholderName:String?
    public var country:String?
    public var billingAddress:String?
    public var address1:String?
    public var address2:String?
    public var city:String?
    public var stateProvince:String?
    public var postalCode:String?

    required public init(){}
}

public class AchPaymentInformation : Codable
{
    public var accountHolderName:String?
    public var checkNumber:String?
    public var routingNumber:String?
    public var accountNumber:String?
    public var accountType:String?

    required public init(){}
}

public class ContributionItem : Codable
{
    public var chartOfAccountId:Int?
    public var chartOfAccountRefId:String?
    public var amount:Double?

    required public init(){}
}

public class StandardSignupFormPostRs : Codable
{
    public var message:String?

    required public init(){}
}


Swift StandardSignupFormPostRq DTOs

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
}