Billhighway Cloud API

<back to all web services

ACHPayment

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


class ResultCode(IntEnum):
    SUCCESS = 0
    DUPLICATE = -7
    NOT_AVAILABLE = -6
    NOT_FOUND = -5
    GENERAL_ERROR = -4
    UNEXPECTED_ERROR = -3
    CREDIT_CARD_DECLINED = -2
    DATA_VALIDATION_FAILURE = -1


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LegacyApiResponse(IHaveErrorField):
    amount: Optional[Decimal] = None
    confirmation_number: Optional[str] = None
    response_code: Optional[str] = None
    response_description: Optional[str] = None
    result_code: Optional[ResultCode] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ACHPaymentResult(LegacyApiResponse):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ACHPaymentResponse(IHaveErrorField):
    result: Optional[ACHPaymentResult] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ACHPayment(ACHPayment):
    pass

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

<ACHPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SOAP">
  <apiKey xmlns="www.billhighway.com/api">String</apiKey>
  <clientId xmlns="www.billhighway.com/api">0</clientId>
  <groupId xmlns="www.billhighway.com/api">0</groupId>
  <amount xmlns="www.billhighway.com/api">0</amount>
  <routingNumber xmlns="www.billhighway.com/api">String</routingNumber>
  <accountNumber xmlns="www.billhighway.com/api">String</accountNumber>
  <payerName xmlns="www.billhighway.com/api">String</payerName>
  <checkNumber xmlns="www.billhighway.com/api">String</checkNumber>
  <emailAddress xmlns="www.billhighway.com/api">String</emailAddress>
  <memo xmlns="www.billhighway.com/api">String</memo>
  <occurs xmlns="www.billhighway.com/api">String</occurs>
  <numberOfOccurences xmlns="www.billhighway.com/api">String</numberOfOccurences>
</ACHPayment>

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

<ACHPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="www.billhighway.com/api">
  <ACHPaymentResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.SOAP">
    <amount>0</amount>
    <confirmationNumber>String</confirmationNumber>
    <responseCode>String</responseCode>
    <responseDescription>String</responseDescription>
    <resultCode>Success</resultCode>
  </ACHPaymentResult>
</ACHPaymentResponse>