Billhighway Cloud API

AchRefRequest

The following routes are available for this service:
POST	/payments/ach/ref	Create Ref for Ach Info	Creates a reference value for the ACH values passed in.
POST	/payments/ach/token	(Deprecated) Create Ref for Ach Info	(Deprecated) Creates a reference value for the ACH values passed in.

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 AchRefRequestReply(IHaveErrorField):
    # @ApiMember(Description="Same as AchReference, this field is deprecated")
    bank_account_token: Optional[str] = None
    """
    Same as AchReference, this field is deprecated
    """


    error_code: Optional[int] = None
    error_message: Optional[str] = None
    # @ApiMember(ExcludeInSchema=true)
    is_error: Optional[bool] = None

    ach_reference: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchRefRequest:
    client_id: Optional[int] = None
    bank_account: Optional[str] = None
    # @ApiMember(IsRequired=true)
    group_id: Optional[str] = None

    # @ApiMember(IsRequired=true)
    routing_number: Optional[str] = None

    # @ApiMember(IsRequired=true)
    account_number: Optional[str] = None

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

<AchRefRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <AccountNumber>String</AccountNumber>
  <BankAccount>String</BankAccount>
  <ClientId>0</ClientId>
  <GroupId>String</GroupId>
  <RoutingNumber>String</RoutingNumber>
</AchRefRequest>

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

<AchRefRequestReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <AchReference>String</AchReference>
  <BankAccountToken>String</BankAccountToken>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <IsError>false</IsError>
</AchRefRequestReply>