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

<eCheckPaymentByGroup 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>
  <featureID xmlns="www.billhighway.com/api">0</featureID>
  <clientID xmlns="www.billhighway.com/api">0</clientID>
  <groupID xmlns="www.billhighway.com/api">0</groupID>
  <Amount xmlns="www.billhighway.com/api">0</Amount>
  <rtn xmlns="www.billhighway.com/api">String</rtn>
  <accountNumber xmlns="www.billhighway.com/api">String</accountNumber>
  <payerName xmlns="www.billhighway.com/api">String</payerName>
  <checkNumber xmlns="www.billhighway.com/api">String</checkNumber>
  <email xmlns="www.billhighway.com/api">String</email>
  <memo xmlns="www.billhighway.com/api">String</memo>
  <occurs xmlns="www.billhighway.com/api">String</occurs>
  <numberOfOccurrences xmlns="www.billhighway.com/api">String</numberOfOccurrences>
</eCheckPaymentByGroup>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<eCheckPaymentByGroupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="www.billhighway.com/api">
  <amount>0</amount>
  <confirmationNumber>String</confirmationNumber>
  <responseCode>String</responseCode>
  <responseDescription>String</responseDescription>
  <resultCode>Success</resultCode>
  <eCheckPaymentByGroupResult>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int">0</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int">0</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:decimal">0</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string">String</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string">String</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string">0</anyType>
  </eCheckPaymentByGroupResult>
</eCheckPaymentByGroupResponse>