Billhighway Cloud API

<back to all web services

IvrAchPaymentRequest

The following routes are available for this service:
POST/ivr/payment/ach
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 IvrAchPaymentResponse(IvrAchPaymentResponse):
    pass


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

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

<IvrAchPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.IVR">
  <BankAccountNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.IVR">String</BankAccountNumber>
  <OtherAmount xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.IVR">0</OtherAmount>
  <PaymentChoice xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.IVR">String</PaymentChoice>
  <RoutingNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.IVR">String</RoutingNumber>
  <UserID xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.IVR">0</UserID>
</IvrAchPaymentRequest>

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

<IvrAchPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.IVR">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</ErrorMessage>
  <GatewayConfirmationNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</GatewayConfirmationNumber>
  <TransactionId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</TransactionId>
</IvrAchPaymentResponse>