Billhighway Cloud API

<back to all web services

StandardSignupFormPostRq

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

export class StandardSignupFormMemberInfo
{
    public BhUserID?: number;
    public BhGroupID?: number;
    public ClientUserID?: string;
    public ClientGroupID?: string;
    public NationalID?: number;
    public FirstName?: string;
    public MiddleName?: string;
    public LastName?: string;
    public Address1?: string;
    public Address2?: string;
    public City?: string;
    public State?: string;
    public PostalCode?: string;
    public Country?: string;
    public Email?: string;
    public Phone?: string;
    public PacContributionAmount?: string;
    public DateOfBirth?: string;
    public MemberTypeClientID?: string;
    public BillingTypeID?: string;
    public FiscalYear?: number;
    public OptedToPayCTADues?: boolean;

    public constructor(init?: Partial<StandardSignupFormMemberInfo>) { (Object as any).assign(this, init); }
}

export class ClientVerification
{
    public Provider?: string;
    public VerificationCode?: string;

    public constructor(init?: Partial<ClientVerification>) { (Object as any).assign(this, init); }
}

export class CcPaymentInformation
{
    public CardNumber?: string;
    public Cvv?: string;
    public ExpMonth?: number;
    public ExpYear?: number;
    public CardholderName?: string;
    public Country?: string;
    public BillingAddress?: string;
    public Address1?: string;
    public Address2?: string;
    public City?: string;
    public StateProvince?: string;
    public PostalCode?: string;

    public constructor(init?: Partial<CcPaymentInformation>) { (Object as any).assign(this, init); }
}

export class AchPaymentInformation
{
    public AccountHolderName?: string;
    public CheckNumber?: string;
    public RoutingNumber?: string;
    public AccountNumber?: string;
    public AccountType?: string;

    public constructor(init?: Partial<AchPaymentInformation>) { (Object as any).assign(this, init); }
}

export class ContributionItem
{
    public ChartOfAccountId?: number;
    public ChartOfAccountRefId?: string;
    public Amount?: number;

    public constructor(init?: Partial<ContributionItem>) { (Object as any).assign(this, init); }
}

export class StandardSignupFormPostRq
{
    public IsCreditCard?: boolean;
    public MemberInfo?: StandardSignupFormMemberInfo;
    public VerificationInfo?: ClientVerification;
    public CcPaymentInfo?: CcPaymentInformation;
    public AchPaymentInfo?: AchPaymentInformation;
    public Contributions?: ContributionItem[];

    public constructor(init?: Partial<StandardSignupFormPostRq>) { (Object as any).assign(this, init); }
}

export class StandardSignupFormPostRs
{
    public Message?: string;

    public constructor(init?: Partial<StandardSignupFormPostRs>) { (Object as any).assign(this, init); }
}

TypeScript StandardSignupFormPostRq DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
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-01T00:00:00.0000000","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/csv
Content-Length: length

{"Message":"String"}