ACH Sale

The ACH Sale API debits the purchase amount from provided bank account

POST https://<Platform-host>/api/payment/ach

Request Body

Name	Type	Description
data.accountToken*	String	Bank Account Token
data.transactionAmount*	string	Max Length=12 Allowed characters: 0-9 and .(dot) Note: this value always reflects the total dollar amount for example 1.00 and 1 both will be considered $1.00 and 0.10 will be 10 cents.
merchant_id	string	Merchant ID
data.internalTransactionID	string	An internal ID from integrating system. Will be returned in the response and associated refunds if provided.
data.description	string	Transaction description. Character limit is 255

200

ACH Response Fields Definitions

Field Name	Type	Description	Required?
ID	string	Platform system ID for the sale request	Required
TransactionID	string	Unique transaction ID	Required
MerchantID	string	Merchant ID	Required
description	string	Transaction Description	Optional
AchResponse.status	string	Transaction execution status. Allowed values PASS | FAIL	Required
AchResponse.responseCode	string	The code representing the status of the processed request. It comes from the processor	Required
AchResponse.responseMessage	string	The corresponding message for the response code. It comes from the processor	Required
AchResponse.achHostTransactionID	string	The unique identifier for the ACH transaction by the processor	Optional
AchResponse.achHostTransactionStatus	string	The current status of the ACH transaction.	Optional
AchResponse.achHostResponseCode	string	Host response code from acquiring processor	Optional
AchResponse.achHostMessage	string	Host response message from acquiring processor	Optional
AchResponse.taskID	string	Task identification number from acquiring processor	Optional
AchResponse.transactionID	string	Transaction Identifier	Optional
AchResponse.transactionTimestamp	string	Transaction timestamp in merchant's timezone	Required
bank_routing_number	string	Routing Number	Optional
masked_bank_account	string	Last 4 digits of bank account number	Optional
AchResponse.customerReceipt	string	Printable customer receipt	Optional
AchResponse.merchantReceipt	string	Printable merchant receipt	Optional

Sample Request / Response

Request

{    
    "merchant_id": "8bb35bfc-1620-4901-bb7e-f926710024a1",
    "data": {
        "accountToken": "ba_sandbox_xxxx",
        "transactionAmount": "100.00",
        "internalTransactionID": "987654321",
        "description": "Payment for the services",
        "order_number": "150t65898",
        "metadata": {
            "customerId": "123",
            "email" : "[email protected]"
        }
    }
}

Response

{
    "data": {
        "ID": "026ef76b-b058-4e8a-968a-8ea5053b8f41",
        "TransactionID": "0b8ff792-04a5-44c2-b28d-62236668ffb2",
        "MerchantID": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6",
        "Description": "Payment for the services",
        "internalTransactionID": "987654321",
        "AchResponse": {
            "status": "PASS",
            "responseCode": "A0000",
            "responseMessage": "Success",
            "hostReferenceNumber": "679105875316",
            "taskID": "14947358",
            "transactionID": "14697466",
            "transactionTimestamp": "2025-04-02T18:49:47",
            "transactionAmount": "150.00",
            "processedAmount": "150.00",
            "totalAmount": "150.00",
            "bank_routing_number":"121122676",
	    "masked_bank_account":"9020",
            "customerReceipt": "        Sandbox US Merchant         \\n        200 Epcot Center Dr         \\n         Orlando, FL 32836          \\n            800-490-8514            \\n                 \\n                 \\n        2025-04-02 06:49 PM         \\n             ACH - SALE             \\n         Entry Mode : KEYED         \\n      Transaction ID: 14697466      \\n     Invoice Number: 150t65898      \\n       SUBTOTAL: USD $150.00        \\n         TOTAL: USD $150.00         \\n                 \\n                 \\n       NO SIGNATURE REQUIRED        \\n              APPROVED              \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n           Customer Copy            \\n",
            "merchantReceipt": "        Sandbox US Merchant         \\n        200 Epcot Center Dr         \\n         Orlando, FL 32836          \\n            800-490-8514            \\n                 \\n                 \\n        2025-04-02 06:49 PM         \\n             ACH - SALE             \\n         Entry Mode : KEYED         \\n      Transaction ID: 14697466      \\n     Invoice Number: 150t65898      \\n       SUBTOTAL: USD $150.00        \\n         TOTAL: USD $150.00         \\n                 \\n                 \\n      X_______________________      \\nI AGREE TO PAY ABOVE TOTAL AMOUNT IN\\n ACCORDANCE WITH CARD ISSUER's AGREE\\nMENT (MERCHANT AGREEMENT IF CREDIT V\\n              OUCHER)               \\n     KEEP COPY FOR YOUR RECORDS     \\n               \\n \\n                \\n              APPROVED              \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n           Merchant Copy            \\n"
        },
        "Metadata": {
            "customerId": "123",
            "email" : "[email protected]"
        },
        "order_number": "150t65898",
        "token": "ba_sandbox_pjkaTwqPT9VbXAkW8PJRyIvD"
    }
}