Pay-by-Bank (ACH) API Specification

Pay-by-Bank (ACH) API

Sale

post /

The Sale or Account Debit transaction is used to debit funds from a checking or savings account.

Transactions that are missing data or declined will return a 200 HTTP success response because the transaction is able to complete the request route, whereas declines are related to an issue with some aspect of the payment. Therefore, transaction responses must be interrogated to retrieve the values in the AUTH_RESP and AUTH_RESP_TEXT fields, which provide either a success response value or the reason for the decline. Learn more about transaction response codes.

Request Schema

CUST_NBR required

string

MERCH_NBR required

string

DBA_NBR required

string

TERMINAL_NBR required

string

TRAN_TYPE required

string

AMOUNT required

number

TRAN_NBR required

integer

ACCOUNT_NBR required

integer

ROUTING_NBR required

integer

FIRST_NAME required

string

Maximum:

LAST_NAME required

string

Maximum:

BATCH_ID

integer

ADDRESS

string^([a-zA-Z0-9\/\.\-_,#'&+\s\xc0-\xff]){0,30}$

Maximum:

CITY

string^([a-zA-Z0-9\/\.\-_,#'&+\s\xc0-\xff]){0,25}$

Maximum:

STATE

string^([a-zA-Z0-9\/\.\-_,#'&+\s]){0,3}$

Maximum:

ZIP_CODE

string^([A-Za-z0-9\-\s]){0,10}$

Maximum:

CHECK_NBR

integer

STD_ENTRY_CLASS

string

Maximum:

RECV_NAME

string

Maximum:

Example Request

"<DETAIL CUST_NBR=\"1234\" MERCH_NBR=\"1234567\" DBA_NBR=\"1\" TERMINAL_NBR=\"1\"> <TRAN_TYPE>CKC2</TRAN_TYPE> <ACCOUNT_NBR>12345678</ACCOUNT_NBR> <ROUTING_NBR>123123123</ROUTING_NBR> <BATCH_ID>20061126</BATCH_ID> <TRAN_NBR>35</TRAN_NBR> <AMOUNT>10.00</AMOUNT> <FIRST_NAME>Joe</FIRST_NAME> <LAST_NAME>Tester</LAST_NAME> <ADDRESS>123 My Street</ADDRESS> <CITY>Claymont</CITY> <STATE>DE</STATE> <ZIP_CODE>19703</ZIP_CODE> <CHECK_NBR>1500</CHECK_NBR> <STD_ENTRY_CLASS>PPD</STD_ENTRY_CLASS> <RECV_NAME>Joe Tester</RECV_NAME> </DETAIL>"

Example Response

200 Sale Success

500 Internal Server Error

200 Sale Decline

BRIC Sale

post /

The BRIC Sale or Account Debit transaction is used to debit funds from a checking or savings account. The ORIG_AUTH_GUID is being used to reference a previous Sale. Because the ORIG_AUTH_GUID is a unique reference value, there is no need to send the account information. The GUID/BRIC Sale or Account Debit is commonly used to collect funds from a customer after the initial purchase using the account information, such as in a recurring payment model.

Transactions that are missing data or declined will return a 200 HTTP success response because the transaction completed the request route, whereas declines are related to an issue with some aspect of the payment. Therefore, transaction responses must be interrogated to retrieve the values in the AUTH_RESP and AUTH_RESP_TEXT fields, which provide either a success response value or the reason for the decline. Learn more about transaction response codes.

Request Schema

CUST_NBR required

string

MERCH_NBR required

string

DBA_NBR required

string

TERMINAL_NBR required

string

TRAN_TYPE required

string

AMOUNT required

ORIG_AUTH_GUID required

string

BATCH_ID

integer

FIRST_NAME

string

Maximum:

LAST_NAME

string

Maximum:

ADDRESS

string^([a-zA-Z0-9\/\.\-_,#'&+\s\xc0-\xff]){0,30}$

Maximum:

CITY

string^([a-zA-Z0-9\/\.\-_,#'&+\s\xc0-\xff]){0,25}$

Maximum:

STATE

string^([a-zA-Z0-9\/\.\-_,#'&+\s]){0,3}$

Maximum:

ZIP_CODE

string^([A-Za-z0-9\-\s]){0,10}$

Maximum:

STD_ENTRY_CLASS

string

Maximum:

RECV_NAME

string

Maximum:

Example Request

"<DETAIL CUST_NBR=\"1234\" MERCH_NBR=\"1234567\" DBA_NBR=\"1\" TERMINAL_NBR=\"1\"> <TRAN_TYPE>CKC2</TRAN_TYPE> <ACCOUNT_NBR>12345678</ACCOUNT_NBR> <ROUTING_NBR>123123123</ROUTING_NBR> <BATCH_ID>20061126</BATCH_ID> <TRAN_NBR>35</TRAN_NBR> <AMOUNT>10.00</AMOUNT> <FIRST_NAME>Joe</FIRST_NAME> <LAST_NAME>Tester</LAST_NAME> <ADDRESS>123 My Street</ADDRESS> <CITY>Claymont</CITY> <STATE>DE</STATE> <ZIP_CODE>19703</ZIP_CODE> <CHECK_NBR>1500</CHECK_NBR> <STD_ENTRY_CLASS>PPD</STD_ENTRY_CLASS> <RECV_NAME>Joe Tester</RECV_NAME> </DETAIL>"

Example Response

200 BRIC Sale Success

500 Internal Server Error

200 BRIC Sale Decline

Refund

post /

The Refund or Account Credit - GUID/BRIC transaction is a transaction used to return funds to an account BASED ON a previous sale transaction. Multiple refund transactions may be sent up to the amount equal or less than the amount of the original sale amount. In this example, the ORIG_AUTH_GUID is being used to reference the previous sale transaction. Because the ORIG_AUTH_GUID is a reference value, there is no need to send additional information such as the account number or customer information. If the refund is approved, the transaction will settle during the next settlement window and the money will move from the merchant account to the specified account.

Request Schema

CUST_NBR required

string

MERCH_NBR required

string

DBA_NBR required

string

TERMINAL_NBR required

string

TRAN_TYPE required

string

AMOUNT required

TRAN_NBR required

integer

ORIG_AUTH_GUID required

string

Maximum:

Example Request

"<DETAIL CUST_NBR=\"1234\" MERCH_NBR=\"1234567\" DBA_NBR=\"1\" TERMINAL_NBR=\"1\"> <TRAN_TYPE>CKC3</TRAN_TYPE> <BATCH_ID>20061126</BATCH_ID> <TRAN_NBR>38</TRAN_NBR> <AMOUNT>10.00</AMOUNT> <ORIG_AUTH_GUID>0V702PVR9F400ZU9ED9</ORIG_AUTH_GUID> </DETAIL>"

Example Response

200 Refund Success

500 Internal Server Error

200 Refund Decline

Void

post /

The Void transaction is used to stop a sale or refund transaction prior to settlement. If the transaction referenced by the ORIG_AUTH_GUID has already settled, this function will not be available.

Request Schema

CUST_NBR required

string

MERCH_NBR required

string

DBA_NBR required

string

TERMINAL_NBR required

string

TRAN_TYPE required

string

ORIG_AUTH_GUID required

string

Maximum:

Example Request

"<DETAIL CUST_NBR=\"1234\" MERCH_NBR=\"1234567\" DBA_NBR=\"1\" TERMINAL_NBR=\"1\"> <TRAN_TYPE>CKCX</TRAN_TYPE> <ORIG_AUTH_GUID>0V702N40Y0B00MK69YX</ORIG_AUTH_GUID> </DETAIL>"

Example Response

200 Void Success

500 Internal Server Error

200 Void Decline