Billhighway Cloud API

CreditCardPaymentCollection

The following routes are available for this service:
POST	/payments/creditcard

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 CreditCardPaymentReply:
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    transaction_id: Optional[str] = None
    error_code: Optional[int] = None
    error_message: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionParameters:
    form_template_i_d: Optional[int] = None
    subscription_invoice_i_d: Optional[int] = None
    client_subscriber_id: Optional[str] = None
    signup_type_i_d: Optional[int] = None
    frequency_i_d: Optional[int] = None
    auto_renew: Optional[bool] = None
    company_i_d: Optional[int] = None
    user_i_d: Optional[int] = None
    chap_mem_pay_i_d: Optional[int] = None
    member_subscription_inv_i_d: Optional[int] = None
    fields: Optional[List[SubscriberFormField]] = None
    created_by: Optional[int] = None
    updated_by: Optional[int] = None
    aptify_update_type: Optional[int] = None
    renewed_member_subscription_inv_i_d: Optional[int] = None
    chap_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditCardPayment(CreditCardPayment):
    subscription_info: Optional[SubscriptionParameters] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditCardPaymentCollection:
    credit_card_payment_list: Optional[List[CreditCardPayment]] = None

Python CreditCardPaymentCollection 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 /payments/creditcard HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreditCardPaymentCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <CreditCardPaymentList>
    <CreditCardPayment>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <Amount>String</Amount>
      <AutoPay>false</AutoPay>
      <BhUserId>0</BhUserId>
      <BillingCity>String</BillingCity>
      <BillingState>String</BillingState>
      <CardReferenceOrCardNumber>String</CardReferenceOrCardNumber>
      <CardType>String</CardType>
      <ClassName>String</ClassName>
      <ClientId>0</ClientId>
      <Country>String</Country>
      <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
      <CurrencyType>String</CurrencyType>
      <Cvv>String</Cvv>
      <ExpMonth>0</ExpMonth>
      <ExpYear>0</ExpYear>
      <GroupId>String</GroupId>
      <InvoiceList>
        <SalesForceMemberPaymentInvoiceDetail>
          <AmountPaid>String</AmountPaid>
          <ClassName>String</ClassName>
          <ClientId>0</ClientId>
          <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
          <Invoice>0</Invoice>
          <UniqueId>String</UniqueId>
        </SalesForceMemberPaymentInvoiceDetail>
      </InvoiceList>
      <Location>String</Location>
      <Memo>String</Memo>
      <NameOnCard>String</NameOnCard>
      <OpportunityId>String</OpportunityId>
      <PostalCode>String</PostalCode>
      <PreferredEmailAddress>String</PreferredEmailAddress>
      <StoreCardInfo>false</StoreCardInfo>
      <UniqueId>String</UniqueId>
      <UserId>String</UserId>
    </CreditCardPayment>
  </CreditCardPaymentList>
</CreditCardPaymentCollection>

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

<CreditCardPaymentReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <ClassName>String</ClassName>
  <ClientId>0</ClientId>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <TransactionId>String</TransactionId>
  <UniqueId>String</UniqueId>
</CreditCardPaymentReply>