Billhighway Cloud API

<back to all web services

ACHPayment

namespace BH.CloudAPI.Common

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type ResultCode =
        | Success = 0
        | Duplicate = -7
        | NotAvailable = -6
        | NotFound = -5
        | GeneralError = -4
        | UnexpectedError = -3
        | CreditCardDeclined = -2
        | DataValidationFailure = -1

    [<DataContract(Namespace="www.billhighway.com/api")>]
    [<AllowNullLiteral>]
    type LegacyApiResponse() = 
        [<DataMember>]
        member val amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val confirmationNumber:String = null with get,set

        [<DataMember>]
        member val responseCode:String = null with get,set

        [<DataMember>]
        member val responseDescription:String = null with get,set

        [<DataMember>]
        member val resultCode:ResultCode = new ResultCode() with get,set

    [<AllowNullLiteral>]
    type ACHPaymentResult() = 
        inherit LegacyApiResponse()

    [<DataContract(Name="ACHPaymentResponse", Namespace="www.billhighway.com/api")>]
    [<AllowNullLiteral>]
    type ACHPaymentResponse() = 
        [<DataMember(Name="ACHPaymentResult")>]
        member val Result:ACHPaymentResult = null with get,set

    [<AllowNullLiteral>]
    type ACHPayment() = 
        inherit ACHPayment()

F# 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}}