ACH Sale

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

POST https://<PayEngine-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.
data.store_payment_method	boolean	true | false – Indicates whether the bank account should be stored for future use. Set to true to store the card. Defaults to true.
data.initiated_by	string	merchant | customer – Indicates who initiated the transaction. Defaults to customer
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.order_number	string	Order number or PO number specified in billing statement of the cardholder. Alphanumeric (a-z A-Z 0-9) maximum 20 characters
data.description	string	Transaction description. Character limit is 255
data.additional_data	object	Optional data. Currently, it is specific to certain use case for accounting integration
data.metadata	object	Add any additional metadata by passing a json object

200

ACH Response Fields Definitions

Field Name	Type	Description	Required?
ID	string	PayEngine system ID for the sale request	Required
TransactionID	string	Unique transaction ID	Required
MerchantID	string	Merchant ID	Required
gateway_id	string	ID of the gateway through which the transaction is processed	Required
Description	string	Transaction Description	Optional
token	string	The bank token used to process this transaction, as provided in the request. This field will be included in the response only if store_payment_method is set to true.	Required
store_payment_method	boolean	true | false	Optional
initiated_by	string	merchant | customer	Optional
internalTransactionID	string	Internal Transaction ID provided in the request	Optional
order_number	string	Order number provided in the request	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
AchResponse.bank_routing_number	string	Bank routing number	Optional
AchResponse.masked_bank_account	string	Masked bank account	Optional
AchResponse.customerReceipt	string	Printable customer receipt	Optional
AchResponse.merchantReceipt	string	Printable merchant receipt	Optional
AdditionalData	object	Additional Data from the request	Optional
Metadata	object	Metadata from the request	Optional

Sample Request / Response

Request

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

Response