Billhighway Cloud API

AchPaymentCollection

The following routes are available for this service:
POST	/api/SalesForce/AchPayment	Processes the ACH Payments.	Validates the input values and processes the ACH Payments.
POST	/payments/ach	Processes the ACH Payments.	Validates the input values and processes the ACH Payments.

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 AchPaymentReply(IHaveErrorField):
    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
    # @ApiMember(ExcludeInSchema=true)
    is_error: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchPaymentReplyCollection:
    ach_reply_collection: Optional[List[AchPaymentReply]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesForceMemberPaymentInvoiceDetail:
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    invoice: Optional[int] = None
    amount_paid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchPayment:
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    user_id: Optional[str] = None
    bh_user_id: Optional[int] = None
    amount: Optional[Decimal] = None
    currency_type: Optional[str] = None
    country: Optional[str] = None
    routing_number: Optional[str] = None
    account_number: Optional[str] = None
    ach_reference: Optional[str] = None
    account_type: Optional[str] = None
    is_savings_account: Optional[bool] = None
    payer_name: Optional[str] = None
    check_number: Optional[str] = None
    preferred_email_address: Optional[str] = None
    memo: Optional[str] = None
    invoice_list: Optional[List[SalesForceMemberPaymentInvoiceDetail]] = None
    auto_pay: Optional[bool] = None
    store_ach_info: Optional[bool] = None
    encryption_type_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchPaymentCollection:
    ach_payment_list: Optional[List[AchPayment]] = None

Python AchPaymentCollection 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 /api/SalesForce/AchPayment HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AchPaymentCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <AchPaymentList>
    <AchPayment>
      <AccountNumber>String</AccountNumber>
      <AccountType>String</AccountType>
      <AchReference>String</AchReference>
      <Amount>0</Amount>
      <AutoPay>false</AutoPay>
      <BhUserId>0</BhUserId>
      <CheckNumber>String</CheckNumber>
      <ClassName>String</ClassName>
      <ClientId>0</ClientId>
      <Country>String</Country>
      <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
      <CurrencyType>String</CurrencyType>
      <EncryptionTypeId>0</EncryptionTypeId>
      <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>
      <Memo>String</Memo>
      <PayerName>String</PayerName>
      <PreferredEmailAddress>String</PreferredEmailAddress>
      <RoutingNumber>String</RoutingNumber>
      <StoreAchInfo>false</StoreAchInfo>
      <UniqueId>String</UniqueId>
      <UserId>String</UserId>
    </AchPayment>
  </AchPaymentList>
</AchPaymentCollection>

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

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