Billhighway Cloud API

<back to all web services

eCheckPaymentByGroup

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 SoapArrayList() = 
        inherit ArrayList()

    [<DataContract(Namespace="www.billhighway.com/api")>]
    [<AllowNullLiteral>]
    type eCheckPaymentByGroupResponse() = 
        inherit LegacyApiResponse()
        [<DataMember(Name="eCheckPaymentByGroupResult")>]
        member val Results:SoapArrayList = null with get,set

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

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

{"apiKey":"String","featureID":0,"clientID":0,"groupID":0,"Amount":0,"rtn":"String","accountNumber":"String","payerName":"String","checkNumber":"String","email":"String","memo":"String","occurs":"String","numberOfOccurrences":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"eCheckPaymentByGroupResult":[0,0,0,"String","String","0"],"amount":0,"confirmationNumber":"String","responseCode":"String","responseDescription":"String","resultCode":0}