Billhighway Cloud API

<back to all web services

StandardSignupFormPostRq

The following routes are available for this service:
POST/signup/api/standardSignup
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StandardSignupFormMemberInfo:
    bh_user_i_d: Optional[int] = None
    bh_group_i_d: Optional[int] = None
    client_user_i_d: Optional[str] = None
    client_group_i_d: Optional[str] = None
    national_i_d: Optional[int] = None
    first_name: Optional[str] = None
    middle_name: Optional[str] = None
    last_name: Optional[str] = None
    address1: Optional[str] = None
    address2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    postal_code: Optional[str] = None
    country: Optional[str] = None
    email: Optional[str] = None
    phone: Optional[str] = None
    pac_contribution_amount: Optional[str] = None
    date_of_birth: Optional[datetime.datetime] = None
    member_type_client_i_d: Optional[str] = None
    billing_type_i_d: Optional[str] = None
    fiscal_year: Optional[int] = None
    opted_to_pay_c_t_a_dues: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClientVerification:
    provider: Optional[str] = None
    verification_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CcPaymentInformation:
    card_number: Optional[str] = None
    cvv: Optional[str] = None
    exp_month: Optional[int] = None
    exp_year: Optional[int] = None
    cardholder_name: Optional[str] = None
    country: Optional[str] = None
    billing_address: Optional[str] = None
    address1: Optional[str] = None
    address2: Optional[str] = None
    city: Optional[str] = None
    state_province: Optional[str] = None
    postal_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchPaymentInformation:
    account_holder_name: Optional[str] = None
    check_number: Optional[str] = None
    routing_number: Optional[str] = None
    account_number: Optional[str] = None
    account_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContributionItem:
    chart_of_account_id: Optional[int] = None
    chart_of_account_ref_id: Optional[str] = None
    amount: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StandardSignupFormPostRq:
    is_credit_card: Optional[bool] = None
    member_info: Optional[StandardSignupFormMemberInfo] = None
    verification_info: Optional[ClientVerification] = None
    cc_payment_info: Optional[CcPaymentInformation] = None
    ach_payment_info: Optional[AchPaymentInformation] = None
    contributions: Optional[List[ContributionItem]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StandardSignupFormPostRs:
    message: Optional[str] = None

Python StandardSignupFormPostRq DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
Content-Length: length

{"Message":"String"}