Billhighway Cloud API

<back to all web services

eCheckPaymentByGroup

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class eCheckPaymentByGroup : eCheckPaymentByGroup(), ICanBeRecurring
{
}

@DataContract(Namespace="www.billhighway.com/api")
open class eCheckPaymentByGroupResponse : LegacyApiResponse()
{
    @DataMember(Name="eCheckPaymentByGroupResult")
    @SerializedName("eCheckPaymentByGroupResult")
    var Results:SoapArrayList? = null
}

@DataContract(Namespace="www.billhighway.com/api")
open class LegacyApiResponse : IHaveErrorField
{
    @DataMember
    var amount:BigDecimal? = null

    @DataMember
    var confirmationNumber:String? = null

    @DataMember
    var responseCode:String? = null

    @DataMember
    var responseDescription:String? = null

    @DataMember
    var resultCode:ResultCode? = null
}

enum class ResultCode(val value:Int)
{
    @SerializedName("0") Success(0),
    @SerializedName("-7") Duplicate(-7),
    @SerializedName("-6") NotAvailable(-6),
    @SerializedName("-5") NotFound(-5),
    @SerializedName("-4") GeneralError(-4),
    @SerializedName("-3") UnexpectedError(-3),
    @SerializedName("-2") CreditCardDeclined(-2),
    @SerializedName("-1") DataValidationFailure(-1),
}

open class SoapArrayList : ArrayList()
{
}

Kotlin 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>