XPxplorpay
Ach Transactions

Create 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.

post/rest/v2/ach/mobile/transactions/debit

Request

Headers

api-keystring required

An access API key issued to you by Xplor Pay.

achmobilejwtstring required

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

type'CREDIT' | 'DEBIT' required

The transaction type.

amountstring required

The transaction amount.

invoicestring

The invoice number associated with the transaction.

descriptionstring

A short description of the transaction.

commentsstring

Additional remarks for the transaction.

software-typestring

Name of the software type while submitting the transaction.

software-type-versionstring

Version of the software submitting the transaction.

account-type'Checking' | 'Savings'

The type of bank account.

routing-numberstring

The bank routing number associated with the account.

account-numberstring

The customer's bank account number.

individual-namestring required

The name of the individual associated with the bank account.

validate-account'true' | 'false'

Indicates whether to validate the bank account before processing.

standard-entry-class-codestring

The ACH standard entry class (SEC) code for the transaction.

idstring

A unique identifier for the transaction.

tip-amountstring

The tip amount added to the transaction.

purchase-orderstring

The purchase order number for the transaction.

email-receiptstring

Indicates whether to send an email receipt to the customer.

email-addressstring

The customer's email address.

customer-idstring

A merchant-defined identifier for the customer.

order-idstring

A merchant-defined identifier for the order.

client-ipstring

The IP address of the client initiating the transaction.

billing-is-shippingstring

Indicates whether the billing and shipping addresses are the same.

create-tokenstring

Indicates whether to create a reusable transaction token.

token-descriptionstring

A description associated with the created token.

check-fieldstring

Field used for duplicate transaction validation.

check-field-midboolean

Indicates whether to include the merchant ID in duplicate checking.

Response

Successful Transaction

type'Debit' | 'Credit' required

Type of the ACH transaction.

amountstring

The transaction amount.

status'Pending' | 'Settling' | 'Settled' | 'Returned' | 'Writing' | 'Declined' | 'Not_Confirmed' | 'Sent' | 'Rejected' | 'Funded' | 'Partially_Funded' | 'Completed'

Current status of the ACH transaction. Possible values: Pending, Settling, Settled, Returned.

routing-numberstring required

Bank routing number associated with the transaction.

account-numberstring required

Last four digits of the bank account number.

account-type'Checking' | 'Savings' required

Type of bank account.

standard-entry-class-code'PPD' required

ACH Standard Entry Class (SEC) code. For example, PPD.

individual-namestring

Name associated with the bank account.

idstring

Unique identifier of the ACH transaction.

check-status'Pending' | 'Rejected' | 'Debit Sent' | 'Cancelled' | 'Credit Sent' | 'Unprocessed'

Check status of the ACH transaction. Possible values: Pending, Rejected, Debit Sent, Cancelled.

funding-status'Pending' | 'No Credit' | 'Credit Sent' | 'Chargeback' | 'Debit Sent' | 'Unprocessed'

Funding status of the ACH transaction. Possible values: Pending, No Credit, Credit Sent, Chargeback.

invoicestring

Invoice number associated with the transaction.

check-numberstring

Check number used for duplicate transaction validation.

purchase-orderstring

Purchase order number.

order-idstring

A merchant-defined order identifier.

status-change-datestring

Date and time when the transaction status last changed (UTC).

customer-idstring

A merchant-defined customer identifier.

email-addressstring

The customer's email address.

descriptionstring

Short description of the transaction.

commentsstring

Additional comments associated with the transaction.

billing-is-shipping'true' | 'false'

Indicates whether the billing and shipping addresses are the same.

display-messagestring

A message describing the transaction status.

provider-transaction-idstring

Transaction identifier assigned by the ACH provider.

trace-numberstring

ACH trace number associated with a settled or returned transaction.

settled-datestring

Date and time when the transaction was settled (UTC).

returned-datestring

Date and time when the transaction was returned (UTC).

returned-codestring

NACHA return code for a returned transaction.

returned-messagestring

The description of the return reason.

merchant-idstring

The merchant identifier associated with the token.

terminal-idstring

Identifier of the terminal or API key used to create the transaction.

software-typestring

Name of the software application that submitted the transaction.

paya-authorizationstring

Authorization reference returned by the Paya.

processing-typestring

Processing type of the transaction.

external-transaction-referencestring

Identifies the transaction reference provided by the requester and must be unique per requester.

execution-datestring

Date when the ACH transaction is executed.

token-idstring

Identifier for the ACH payment token.

create-datestring

Date when the ACH transaction was created.

micr-datastring

Contains the MICR data printed on the check.

image-front-edoc-idstring

eDocs document ID for the front image of the check.

image-back-edoc-idstring

eDocs document ID for the back image of the check.

image-frontstring

Check's front image as Base64.

image-backstring

Check's back image as Base64.

Changes

No recorded changes to this operation across all 1 revision of this API.