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.
AchPaymentCollection Parameters:
NameParameterData TypeRequiredDescription
AchPaymentListbodyList<AchPayment>No
AchPayment Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
GroupIdformstringNo
UserIdformstringNo
BhUserIdformintNo
AmountformdecimalNo
CurrencyTypeformstringNo
CountryformstringNo
RoutingNumberformstringNo
AccountNumberformstringNo
AchReferenceformstringNo
AccountTypeformstringNo
IsSavingsAccountformboolNo
PayerNameformstringNo
CheckNumberformstringNo
PreferredEmailAddressformstringNo
MemoformstringNo
InvoiceListformList<SalesForceMemberPaymentInvoiceDetail>No
AutoPayformboolNo
StoreAchInfoformboolNo
EncryptionTypeIdformintNo
SalesForceMemberPaymentInvoiceDetail Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
InvoiceformintNo
AmountPaidformstringNo
AchPaymentReplyCollection Parameters:
NameParameterData TypeRequiredDescription
AchReplyCollectionformList<AchPaymentReply>No
AchPaymentReply Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
TransactionIdformstringNo
ErrorCodeformintNo
ErrorMessageformstringNo
IsErrorformboolNo

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

{"AchPaymentList":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":"String","BhUserId":0,"Amount":0,"CurrencyType":"String","Country":"String","RoutingNumber":"String","AccountNumber":"String","AchReference":"String","AccountType":"String","IsSavingsAccount":false,"PayerName":"String","CheckNumber":"String","PreferredEmailAddress":"String","Memo":"String","InvoiceList":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"Invoice":0,"AmountPaid":"String"}],"AutoPay":false,"StoreAchInfo":false,"EncryptionTypeId":0}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"AchReplyCollection":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"TransactionId":"String","ErrorCode":0,"ErrorMessage":"String","IsError":false}]}