XPxplorpay
ACH Transactions

Validate ACH transaction

Validate the ACH bank account without creating or submitting a transaction.

post/rest/v2/ach/transactions/validate

Request

Headers

api-keystring required

An access API key issued to you by Xplor Pay.

Request body

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.

Response

ok

payloadTypestring

Type of the payload returned in the response.

Changes

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