Billhighway Cloud API

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

{"apiKey":"String","clientId":0,"groupId":0,"amount":0,"routingNumber":"String","accountNumber":"String","payerName":"String","checkNumber":"String","emailAddress":"String","memo":"String","occurs":"String","numberOfOccurences":"String"}

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

{"ACHPaymentResult":{"amount":0,"confirmationNumber":"String","responseCode":"String","responseDescription":"String","resultCode":0}}