Billhighway Cloud API

<back to all web services

AchPaymentCollection

The following routes are available for this service:
POST/api/SalesForce/AchPaymentProcesses the ACH Payments.Validates the input values and processes the ACH Payments.
POST/payments/achProcesses the ACH Payments.Validates the input values and processes the ACH Payments.
import java.math.*
import java.util.*
import net.servicestack.client.*


open class AchPaymentCollection
{
    var AchPaymentList:ArrayList<AchPayment> = ArrayList<AchPayment>()
}

open class AchPayment
{
    var ClassName:String? = null
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var GroupId:String? = null
    var UserId:String? = null
    var BhUserId:Int? = null
    var Amount:BigDecimal? = null
    var CurrencyType:String? = null
    var Country:String? = null
    var RoutingNumber:String? = null
    var AccountNumber:String? = null
    var AchReference:String? = null
    var AccountType:String? = null
    var IsSavingsAccount:Boolean? = null
    var PayerName:String? = null
    var CheckNumber:String? = null
    var PreferredEmailAddress:String? = null
    var Memo:String? = null
    var InvoiceList:ArrayList<SalesForceMemberPaymentInvoiceDetail> = ArrayList<SalesForceMemberPaymentInvoiceDetail>()
    var AutoPay:Boolean? = null
    var StoreAchInfo:Boolean? = null
    var EncryptionTypeId:Int? = null
}

open class SalesForceMemberPaymentInvoiceDetail
{
    var ClassName:String? = null
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var Invoice:Int? = null
    var AmountPaid:String? = null
}

open class AchPaymentReplyCollection
{
    var AchReplyCollection:ArrayList<AchPaymentReply> = ArrayList<AchPaymentReply>()
}

open class AchPaymentReply : IHaveErrorField
{
    var ClassName:String? = null
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var TransactionId:String? = null
    var ErrorCode:Int? = null
    var ErrorMessage:String? = null
    @ApiMember(ExcludeInSchema=true)
    var IsError:Boolean? = null
}

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

<AchPaymentCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <AchPaymentList>
    <AchPayment>
      <AccountNumber>String</AccountNumber>
      <AccountType>String</AccountType>
      <AchReference>String</AchReference>
      <Amount>0</Amount>
      <AutoPay>false</AutoPay>
      <BhUserId>0</BhUserId>
      <CheckNumber>String</CheckNumber>
      <ClassName>String</ClassName>
      <ClientId>0</ClientId>
      <Country>String</Country>
      <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
      <CurrencyType>String</CurrencyType>
      <EncryptionTypeId>0</EncryptionTypeId>
      <GroupId>String</GroupId>
      <InvoiceList>
        <SalesForceMemberPaymentInvoiceDetail>
          <AmountPaid>String</AmountPaid>
          <ClassName>String</ClassName>
          <ClientId>0</ClientId>
          <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
          <Invoice>0</Invoice>
          <UniqueId>String</UniqueId>
        </SalesForceMemberPaymentInvoiceDetail>
      </InvoiceList>
      <Memo>String</Memo>
      <PayerName>String</PayerName>
      <PreferredEmailAddress>String</PreferredEmailAddress>
      <RoutingNumber>String</RoutingNumber>
      <StoreAchInfo>false</StoreAchInfo>
      <UniqueId>String</UniqueId>
      <UserId>String</UserId>
    </AchPayment>
  </AchPaymentList>
</AchPaymentCollection>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AchPaymentReplyCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <AchReplyCollection>
    <AchPaymentReply>
      <ClientId>0</ClientId>
      <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
      <ErrorCode>0</ErrorCode>
      <ErrorMessage>String</ErrorMessage>
      <TransactionId>String</TransactionId>
      <UniqueId>String</UniqueId>
    </AchPaymentReply>
  </AchReplyCollection>
</AchPaymentReplyCollection>