Billhighway Cloud API

<back to all web services

StandardSignupFormPostRq

The following routes are available for this service:
POST/signup/api/standardSignup
namespace BH.CloudAPI.Common4.DTO.RecurringObligation

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type StandardSignupFormMemberInfo() = 
        member val BhUserID:Int32 = new Int32() with get,set
        member val BhGroupID:Int32 = new Int32() with get,set
        member val ClientUserID:String = null with get,set
        member val ClientGroupID:String = null with get,set
        member val NationalID:Int32 = new Int32() with get,set
        member val FirstName:String = null with get,set
        member val MiddleName:String = null with get,set
        member val LastName:String = null with get,set
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val City:String = null with get,set
        member val State:String = null with get,set
        member val PostalCode:String = null with get,set
        member val Country:String = null with get,set
        member val Email:String = null with get,set
        member val Phone:String = null with get,set
        member val PacContributionAmount:String = null with get,set
        member val DateOfBirth:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val MemberTypeClientID:String = null with get,set
        member val BillingTypeID:String = null with get,set
        member val FiscalYear:Int32 = new Int32() with get,set
        member val OptedToPayCTADues:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ClientVerification() = 
        member val Provider:String = null with get,set
        member val VerificationCode:String = null with get,set

    [<AllowNullLiteral>]
    type CcPaymentInformation() = 
        member val CardNumber:String = null with get,set
        member val Cvv:String = null with get,set
        member val ExpMonth:Int32 = new Int32() with get,set
        member val ExpYear:Int32 = new Int32() with get,set
        member val CardholderName:String = null with get,set
        member val Country:String = null with get,set
        member val BillingAddress:String = null with get,set
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val City:String = null with get,set
        member val StateProvince:String = null with get,set
        member val PostalCode:String = null with get,set

    [<AllowNullLiteral>]
    type AchPaymentInformation() = 
        member val AccountHolderName:String = null with get,set
        member val CheckNumber:String = null with get,set
        member val RoutingNumber:String = null with get,set
        member val AccountNumber:String = null with get,set
        member val AccountType:String = null with get,set

    [<AllowNullLiteral>]
    type ContributionItem() = 
        member val ChartOfAccountId:Int32 = new Int32() with get,set
        member val ChartOfAccountRefId:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type StandardSignupFormPostRq() = 
        member val IsCreditCard:Boolean = new Boolean() with get,set
        member val MemberInfo:StandardSignupFormMemberInfo = null with get,set
        member val VerificationInfo:ClientVerification = null with get,set
        member val CcPaymentInfo:CcPaymentInformation = null with get,set
        member val AchPaymentInfo:AchPaymentInformation = null with get,set
        member val Contributions:ResizeArray<ContributionItem> = new ResizeArray<ContributionItem>() with get,set

    [<AllowNullLiteral>]
    type StandardSignupFormPostRs() = 
        member val Message:String = null with get,set

F# 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
}