Billhighway Cloud API

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

<ACHPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SOAP">
  <apiKey xmlns="www.billhighway.com/api">String</apiKey>
  <clientId xmlns="www.billhighway.com/api">0</clientId>
  <groupId xmlns="www.billhighway.com/api">0</groupId>
  <amount xmlns="www.billhighway.com/api">0</amount>
  <routingNumber xmlns="www.billhighway.com/api">String</routingNumber>
  <accountNumber xmlns="www.billhighway.com/api">String</accountNumber>
  <payerName xmlns="www.billhighway.com/api">String</payerName>
  <checkNumber xmlns="www.billhighway.com/api">String</checkNumber>
  <emailAddress xmlns="www.billhighway.com/api">String</emailAddress>
  <memo xmlns="www.billhighway.com/api">String</memo>
  <occurs xmlns="www.billhighway.com/api">String</occurs>
  <numberOfOccurences xmlns="www.billhighway.com/api">String</numberOfOccurences>
</ACHPayment>

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

<ACHPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="www.billhighway.com/api">
  <ACHPaymentResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.SOAP">
    <amount>0</amount>
    <confirmationNumber>String</confirmationNumber>
    <responseCode>String</responseCode>
    <responseDescription>String</responseDescription>
    <resultCode>Success</resultCode>
  </ACHPaymentResult>
</ACHPaymentResponse>