v1
latestOpenAPI 3.0.12026-07-2356172250.9 KBCreate ACH mobile debit transaction
Create an ACH debit transaction of $1 or more using a mobile transaction token to transfer funds from the customer's bank account to the merchant's bank account.
Headers
An access API key issued to you by Xplor Pay.
The transaction token used to authorize and process the ACH mobile transaction. The token returned from the successfulTransactionToken method of the Mobile framework.
Request body
The transaction type.
The transaction amount.
The invoice number associated with the transaction.
A short description of the transaction.
Additional remarks for the transaction.
Name of the software type while submitting the transaction.
Version of the software submitting the transaction.
The type of bank account.
The bank routing number associated with the account.
The customer's bank account number.
The name of the individual associated with the bank account.
Indicates whether to validate the bank account before processing.
The ACH standard entry class (SEC) code for the transaction.
A unique identifier for the transaction.
The tip amount added to the transaction.
The purchase order number for the transaction.
Indicates whether to send an email receipt to the customer.
The customer's email address.
A merchant-defined identifier for the customer.
A merchant-defined identifier for the order.
The IP address of the client initiating the transaction.
Indicates whether the billing and shipping addresses are the same.
Indicates whether to create a reusable transaction token.
A description associated with the created token.
Field used for duplicate transaction validation.
Indicates whether to include the merchant ID in duplicate checking.
Response
Successful Transaction
Type of the ACH transaction.
The transaction amount.
Current status of the ACH transaction. Possible values: Pending, Settling, Settled, Returned.
Bank routing number associated with the transaction.
Last four digits of the bank account number.
Type of bank account.
ACH Standard Entry Class (SEC) code. For example, PPD.
Name associated with the bank account.
Unique identifier of the ACH transaction.
Check status of the ACH transaction. Possible values: Pending, Rejected, Debit Sent, Cancelled.
Funding status of the ACH transaction. Possible values: Pending, No Credit, Credit Sent, Chargeback.
Invoice number associated with the transaction.
Check number used for duplicate transaction validation.
Purchase order number.
A merchant-defined order identifier.
Date and time when the transaction status last changed (UTC).
A merchant-defined customer identifier.
The customer's email address.
Short description of the transaction.
Additional comments associated with the transaction.
Indicates whether the billing and shipping addresses are the same.
A message describing the transaction status.
Transaction identifier assigned by the ACH provider.
ACH trace number associated with a settled or returned transaction.
Date and time when the transaction was settled (UTC).
Date and time when the transaction was returned (UTC).
NACHA return code for a returned transaction.
The description of the return reason.
The merchant identifier associated with the token.
Identifier of the terminal or API key used to create the transaction.
Name of the software application that submitted the transaction.
Authorization reference returned by the Paya.
Processing type of the transaction.
Identifies the transaction reference provided by the requester and must be unique per requester.
Date when the ACH transaction is executed.
Identifier for the ACH payment token.
Date when the ACH transaction was created.
Contains the MICR data printed on the check.
eDocs document ID for the front image of the check.
eDocs document ID for the back image of the check.
Check's front image as Base64.
Check's back image as Base64.