Billhighway Cloud API

<back to all web services

ACHPayment


export enum ResultCode
{
    Success = 0,
    Duplicate = -7,
    NotAvailable = -6,
    NotFound = -5,
    GeneralError = -4,
    UnexpectedError = -3,
    CreditCardDeclined = -2,
    DataValidationFailure = -1,
}

// @DataContract(Namespace="www.billhighway.com/api")
export class LegacyApiResponse implements IHaveErrorField
{
    // @DataMember
    public amount?: number;

    // @DataMember
    public confirmationNumber?: string;

    // @DataMember
    public responseCode?: string;

    // @DataMember
    public responseDescription?: string;

    // @DataMember
    public resultCode?: ResultCode;

    public constructor(init?: Partial<LegacyApiResponse>) { (Object as any).assign(this, init); }
}

export class ACHPaymentResult extends LegacyApiResponse
{

    public constructor(init?: Partial<ACHPaymentResult>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="ACHPaymentResponse", Namespace="www.billhighway.com/api")
export class ACHPaymentResponse implements IHaveErrorField
{
    // @DataMember(Name="ACHPaymentResult")
    public Result?: ACHPaymentResult;

    public constructor(init?: Partial<ACHPaymentResponse>) { (Object as any).assign(this, init); }
}

export class ACHPayment extends ACHPayment
{

    public constructor(init?: Partial<ACHPayment>) { super(init); (Object as any).assign(this, init); }
}

TypeScript ACHPayment DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

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