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 .xml suffix or ?format=xml

HTTP + XML

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

<StandardSignupFormPostRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.StandardSignupForm.Request">
  <AchPaymentInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:AccountHolderName>String</d2p1:AccountHolderName>
    <d2p1:AccountNumber>String</d2p1:AccountNumber>
    <d2p1:AccountType>String</d2p1:AccountType>
    <d2p1:CheckNumber>String</d2p1:CheckNumber>
    <d2p1:RoutingNumber>String</d2p1:RoutingNumber>
  </AchPaymentInfo>
  <CcPaymentInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:Address1>String</d2p1:Address1>
    <d2p1:Address2>String</d2p1:Address2>
    <d2p1:BillingAddress>String</d2p1:BillingAddress>
    <d2p1:CardNumber>String</d2p1:CardNumber>
    <d2p1:CardholderName>String</d2p1:CardholderName>
    <d2p1:City>String</d2p1:City>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:Cvv>String</d2p1:Cvv>
    <d2p1:ExpMonth>0</d2p1:ExpMonth>
    <d2p1:ExpYear>0</d2p1:ExpYear>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:StateProvince>String</d2p1:StateProvince>
  </CcPaymentInfo>
  <Contributions xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.RecurringObligation">
    <d2p1:ContributionItem>
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:ChartOfAccountId>0</d2p1:ChartOfAccountId>
      <d2p1:ChartOfAccountRefId>String</d2p1:ChartOfAccountRefId>
    </d2p1:ContributionItem>
  </Contributions>
  <IsCreditCard>false</IsCreditCard>
  <MemberInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.StandardSignupForm">
    <d2p1:Address1>String</d2p1:Address1>
    <d2p1:Address2>String</d2p1:Address2>
    <d2p1:BhGroupID>0</d2p1:BhGroupID>
    <d2p1:BhUserID>0</d2p1:BhUserID>
    <d2p1:BillingTypeID>String</d2p1:BillingTypeID>
    <d2p1:City>String</d2p1:City>
    <d2p1:ClientGroupID>String</d2p1:ClientGroupID>
    <d2p1:ClientUserID>String</d2p1:ClientUserID>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:FiscalYear>0</d2p1:FiscalYear>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:MemberTypeClientID>String</d2p1:MemberTypeClientID>
    <d2p1:MiddleName>String</d2p1:MiddleName>
    <d2p1:NationalID>0</d2p1:NationalID>
    <d2p1:OptedToPayCTADues>false</d2p1:OptedToPayCTADues>
    <d2p1:PacContributionAmount>String</d2p1:PacContributionAmount>
    <d2p1:Phone>String</d2p1:Phone>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:State>String</d2p1:State>
  </MemberInfo>
  <VerificationInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:Provider>String</d2p1:Provider>
    <d2p1:VerificationCode>String</d2p1:VerificationCode>
  </VerificationInfo>
</StandardSignupFormPostRq>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StandardSignupFormPostRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.StandardSignupForm.Response">
  <Message>String</Message>
</StandardSignupFormPostRs>