ACH Transactions

Validate ACH Transaction

post

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

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

application/json

This model represents the ach transaction in the response

typestring · enumRequired

Type of the ACH transaction.

Example: DebitPossible values:

amountstringOptional

The transaction amount.

Example: text

statusstring · enumOptional

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

Example: PendingPossible values:

routing-numberstringRequired

Bank routing number associated with the transaction.

Example: text

account-numberstringRequired

Last four digits of the bank account number.

Example: text

account-typestring · enumRequired

Type of bank account.

Example: CheckingPossible values:

standard-entry-class-codestring · enumRequired

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

Example: PPDPossible values:

check-numberstringOptional

Check number used for duplicate transaction validation.

Example: text

individual-namestringOptional

Name associated with the bank account.

Example: text

idstringOptional

Unique identifier of the ACH transaction.

Example: text

invoicestringOptional

Invoice number associated with the transaction.

Example: text

purchase-orderstringOptional

Purchase order number.

Example: text

customer-idstringOptional

A merchant-defined customer identifier.

Example: text

order-idstringOptional

A merchant-defined order identifier.

Example: text

email-addressstringOptional

The customer's email address.

Example: text

descriptionstringOptional

Short description of the transaction.

Example: text

commentsstringOptional

Additional comments associated with the transaction.

Example: text

billing-is-shippingstring · enumOptional

Indicates whether the billing and shipping addresses are the same.

Example: truePossible values:

status-change-datestringOptional

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

Example: text

display-messagestringOptional

A message describing the transaction status.

Example: text

provider-transaction-idstringOptional

Transaction identifier assigned by the ACH provider.

Example: text

trace-numberstringOptional

ACH trace number associated with a settled or returned transaction.

Example: text

settled-datestringOptional

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

Example: text

returned-datestringOptional

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

Example: text

returned-codestringOptional

NACHA return code for a returned transaction.

Example: text

returned-messagestringOptional

The description of the return reason.

Example: text

merchant-idstringOptional

The merchant identifier associated with the token.

Example: text

terminal-idstringOptional

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

Example: text

software-typestringOptional

Name of the software application that submitted the transaction.

Example: MySoftware_Version1.3

paya-authorizationstringOptional

Authorization reference returned by the Paya.

Example: text

processing-typestringOptional

Processing type of the transaction.

external-transaction-referencestringOptional

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

Example: external-transaction-reference

execution-datestringOptional

Date when the ACH transaction is executed.

Example: execution-date

token-idstringOptional

Identifier for the ACH payment token.

Example: 1188888888888888

create-datestringOptional

Date when the ACH transaction was created.

Example: create-date

micr-datastringOptional

Contains the MICR data printed on the check.

Example: T490000018T 24413815O 4456

image-front-edoc-idstringOptional

eDocs document ID for the front image of the check.

image-back-edoc-idstringOptional

eDocs document ID for the back image of the check.

image-frontstringOptional

Check's front image as Base64.

image-backstringOptional

Check's back image as Base64.

Responses

200

ok

application/jsonapplication/xml

Payload

payloadTypestringOptional

Type of the payload returned in the response.

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

post

/rest/v2/ach/transactions/validate

HTTPcURLJavaScriptPython

POST /rest/v2/ach/transactions/validate HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 1770

{
  "type": "Debit",
  "amount": "text",
  "status": "Pending",
  "routing-number": "text",
  "account-number": "text",
  "account-type": "Checking",
  "standard-entry-class-code": "PPD",
  "check-number": "text",
  "individual-name": "text",
  "id": "text",
  "billing": {
    "company": "Company",
    "street": "Street",
    "street2": "Street2",
    "city": "City",
    "state": "State",
    "zip": "Zip",
    "country": "Country",
    "phone": "Phone",
    "first-name": "John",
    "last-name": "Doe"
  },
  "shipping": {
    "company": "Company",
    "street": "Street",
    "street2": "Street2",
    "city": "City",
    "state": "State",
    "zip": "Zip",
    "country": "Country",
    "phone": "Phone",
    "first-name": "John",
    "last-name": "Doe"
  },
  "invoice": "text",
  "purchase-order": "text",
  "customer-id": "text",
  "order-id": "text",
  "email-address": "text",
  "description": "text",
  "comments": "text",
  "billing-is-shipping": "true",
  "status-change-date": "text",
  "display-message": "text",
  "provider-transaction-id": "text",
  "trace-number": "text",
  "settled-date": "text",
  "returned-date": "text",
  "returned-code": "text",
  "returned-message": "text",
  "ach-token": {
    "token-id": "1100000000000000",
    "times-used": 14,
    "last-used": "1100000000000000",
    "merchant-id": "000008888",
    "routing-number": "081009813",
    "account-number": "1111",
    "account-type": "Checking",
    "individual-name": "John Doe",
    "token-description": "Travel checking account",
    "created": "1100000000000000",
    "updated": "1100000000000000",
    "customer-key": "customer123",
    "default": false
  },
  "merchant-id": "text",
  "terminal-id": "text",
  "software-type": "MySoftware_Version1.3",
  "paya-authorization": "text",
  "processing-type": "text",
  "external-transaction-reference": "external-transaction-reference",
  "execution-date": "execution-date",
  "token-id": "1188888888888888",
  "create-date": "create-date",
  "micr-data": "T490000018T 24413815O 4456",
  "image-front-edoc-id": "text",
  "image-back-edoc-id": "text",
  "image-front": "text",
  "image-back": "text"
}

{
  "ach-transaction": {
    "type": "Debit",
    "amount": "text",
    "status": "Pending",
    "routing-number": "text",
    "account-number": "text",
    "account-type": "Checking",
    "standard-entry-class-code": "PPD",
    "check-number": "text",
    "individual-name": "text",
    "id": "text",
    "billing": {
      "company": "Company",
      "street": "Street",
      "street2": "Street2",
      "city": "City",
      "state": "State",
      "zip": "Zip",
      "country": "Country",
      "phone": "Phone",
      "first-name": "John",
      "last-name": "Doe"
    },
    "shipping": {
      "company": "Company",
      "street": "Street",
      "street2": "Street2",
      "city": "City",
      "state": "State",
      "zip": "Zip",
      "country": "Country",
      "phone": "Phone",
      "first-name": "John",
      "last-name": "Doe"
    },
    "invoice": "text",
    "purchase-order": "text",
    "customer-id": "text",
    "order-id": "text",
    "email-address": "text",
    "description": "text",
    "comments": "text",
    "billing-is-shipping": "true",
    "status-change-date": "text",
    "display-message": "text",
    "provider-transaction-id": "text",
    "trace-number": "text",
    "settled-date": "text",
    "returned-date": "text",
    "returned-code": "text",
    "returned-message": "text",
    "ach-token": {
      "token-id": "1100000000000000",
      "times-used": 14,
      "last-used": "1100000000000000",
      "merchant-id": "000008888",
      "routing-number": "081009813",
      "account-number": "1111",
      "account-type": "Checking",
      "individual-name": "John Doe",
      "token-description": "Travel checking account",
      "created": "1100000000000000",
      "updated": "1100000000000000",
      "customer-key": "customer123",
      "default": false
    },
    "merchant-id": "text",
    "terminal-id": "text",
    "software-type": "MySoftware_Version1.3",
    "paya-authorization": "text",
    "processing-type": "text",
    "external-transaction-reference": "external-transaction-reference",
    "execution-date": "execution-date",
    "token-id": "1188888888888888",
    "create-date": "create-date",
    "micr-data": "T490000018T 24413815O 4456",
    "image-front-edoc-id": "text",
    "image-back-edoc-id": "text",
    "image-front": "text",
    "image-back": "text"
  },
  "payloadType": "text"
}

Create ACH Transaction Reversal

post

Create a reversal for a submitted ACH transaction (PAYA only).

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

application/json

This model represents the ach transaction in the response

typestring · enumRequired

Type of the ACH transaction.

Example: DebitPossible values:

amountstringOptional

The transaction amount.

Example: text

statusstring · enumOptional

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

Example: PendingPossible values:

routing-numberstringRequired

Bank routing number associated with the transaction.

Example: text

account-numberstringRequired

Last four digits of the bank account number.

Example: text

account-typestring · enumRequired

Type of bank account.

Example: CheckingPossible values:

standard-entry-class-codestring · enumRequired

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

Example: PPDPossible values:

check-numberstringOptional

Check number used for duplicate transaction validation.

Example: text

individual-namestringOptional

Name associated with the bank account.

Example: text

idstringOptional

Unique identifier of the ACH transaction.

Example: text

invoicestringOptional

Invoice number associated with the transaction.

Example: text

purchase-orderstringOptional

Purchase order number.

Example: text

customer-idstringOptional

A merchant-defined customer identifier.

Example: text

order-idstringOptional

A merchant-defined order identifier.

Example: text

email-addressstringOptional

The customer's email address.

Example: text

descriptionstringOptional

Short description of the transaction.

Example: text

commentsstringOptional

Additional comments associated with the transaction.

Example: text

billing-is-shippingstring · enumOptional

Indicates whether the billing and shipping addresses are the same.

Example: truePossible values:

status-change-datestringOptional

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

Example: text

display-messagestringOptional

A message describing the transaction status.

Example: text

provider-transaction-idstringOptional

Transaction identifier assigned by the ACH provider.

Example: text

trace-numberstringOptional

ACH trace number associated with a settled or returned transaction.

Example: text

settled-datestringOptional

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

Example: text

returned-datestringOptional

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

Example: text

returned-codestringOptional

NACHA return code for a returned transaction.

Example: text

returned-messagestringOptional

The description of the return reason.

Example: text

merchant-idstringOptional

The merchant identifier associated with the token.

Example: text

terminal-idstringOptional

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

Example: text

software-typestringOptional

Name of the software application that submitted the transaction.

Example: MySoftware_Version1.3

paya-authorizationstringOptional

Authorization reference returned by the Paya.

Example: text

processing-typestringOptional

Processing type of the transaction.

external-transaction-referencestringOptional

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

Example: external-transaction-reference

execution-datestringOptional

Date when the ACH transaction is executed.

Example: execution-date

token-idstringOptional

Identifier for the ACH payment token.

Example: 1188888888888888

create-datestringOptional

Date when the ACH transaction was created.

Example: create-date

micr-datastringOptional

Contains the MICR data printed on the check.

Example: T490000018T 24413815O 4456

image-front-edoc-idstringOptional

eDocs document ID for the front image of the check.

image-back-edoc-idstringOptional

eDocs document ID for the back image of the check.

image-frontstringOptional

Check's front image as Base64.

image-backstringOptional

Check's back image as Base64.

Responses

200

ok

application/jsonapplication/xml

Payload

payloadTypestringOptional

Type of the payload returned in the response.

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

post

/rest/v2/ach/transactions/reversal

HTTPcURLJavaScriptPython

POST /rest/v2/ach/transactions/reversal HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 1770

{
  "type": "Debit",
  "amount": "text",
  "status": "Pending",
  "routing-number": "text",
  "account-number": "text",
  "account-type": "Checking",
  "standard-entry-class-code": "PPD",
  "check-number": "text",
  "individual-name": "text",
  "id": "text",
  "billing": {
    "company": "Company",
    "street": "Street",
    "street2": "Street2",
    "city": "City",
    "state": "State",
    "zip": "Zip",
    "country": "Country",
    "phone": "Phone",
    "first-name": "John",
    "last-name": "Doe"
  },
  "shipping": {
    "company": "Company",
    "street": "Street",
    "street2": "Street2",
    "city": "City",
    "state": "State",
    "zip": "Zip",
    "country": "Country",
    "phone": "Phone",
    "first-name": "John",
    "last-name": "Doe"
  },
  "invoice": "text",
  "purchase-order": "text",
  "customer-id": "text",
  "order-id": "text",
  "email-address": "text",
  "description": "text",
  "comments": "text",
  "billing-is-shipping": "true",
  "status-change-date": "text",
  "display-message": "text",
  "provider-transaction-id": "text",
  "trace-number": "text",
  "settled-date": "text",
  "returned-date": "text",
  "returned-code": "text",
  "returned-message": "text",
  "ach-token": {
    "token-id": "1100000000000000",
    "times-used": 14,
    "last-used": "1100000000000000",
    "merchant-id": "000008888",
    "routing-number": "081009813",
    "account-number": "1111",
    "account-type": "Checking",
    "individual-name": "John Doe",
    "token-description": "Travel checking account",
    "created": "1100000000000000",
    "updated": "1100000000000000",
    "customer-key": "customer123",
    "default": false
  },
  "merchant-id": "text",
  "terminal-id": "text",
  "software-type": "MySoftware_Version1.3",
  "paya-authorization": "text",
  "processing-type": "text",
  "external-transaction-reference": "external-transaction-reference",
  "execution-date": "execution-date",
  "token-id": "1188888888888888",
  "create-date": "create-date",
  "micr-data": "T490000018T 24413815O 4456",
  "image-front-edoc-id": "text",
  "image-back-edoc-id": "text",
  "image-front": "text",
  "image-back": "text"
}

{
  "ach-transaction": {
    "type": "Debit",
    "amount": "text",
    "status": "Pending",
    "routing-number": "text",
    "account-number": "text",
    "account-type": "Checking",
    "standard-entry-class-code": "PPD",
    "check-number": "text",
    "individual-name": "text",
    "id": "text",
    "billing": {
      "company": "Company",
      "street": "Street",
      "street2": "Street2",
      "city": "City",
      "state": "State",
      "zip": "Zip",
      "country": "Country",
      "phone": "Phone",
      "first-name": "John",
      "last-name": "Doe"
    },
    "shipping": {
      "company": "Company",
      "street": "Street",
      "street2": "Street2",
      "city": "City",
      "state": "State",
      "zip": "Zip",
      "country": "Country",
      "phone": "Phone",
      "first-name": "John",
      "last-name": "Doe"
    },
    "invoice": "text",
    "purchase-order": "text",
    "customer-id": "text",
    "order-id": "text",
    "email-address": "text",
    "description": "text",
    "comments": "text",
    "billing-is-shipping": "true",
    "status-change-date": "text",
    "display-message": "text",
    "provider-transaction-id": "text",
    "trace-number": "text",
    "settled-date": "text",
    "returned-date": "text",
    "returned-code": "text",
    "returned-message": "text",
    "ach-token": {
      "token-id": "1100000000000000",
      "times-used": 14,
      "last-used": "1100000000000000",
      "merchant-id": "000008888",
      "routing-number": "081009813",
      "account-number": "1111",
      "account-type": "Checking",
      "individual-name": "John Doe",
      "token-description": "Travel checking account",
      "created": "1100000000000000",
      "updated": "1100000000000000",
      "customer-key": "customer123",
      "default": false
    },
    "merchant-id": "text",
    "terminal-id": "text",
    "software-type": "MySoftware_Version1.3",
    "paya-authorization": "text",
    "processing-type": "text",
    "external-transaction-reference": "external-transaction-reference",
    "execution-date": "execution-date",
    "token-id": "1188888888888888",
    "create-date": "create-date",
    "micr-data": "T490000018T 24413815O 4456",
    "image-front-edoc-id": "text",
    "image-back-edoc-id": "text",
    "image-front": "text",
    "image-back": "text"
  },
  "payloadType": "text"
}

Create ACH Debit Transaction

post

Create an ACH debit transaction to withdraw funds from the customer's bank account and deposit them into the merchant's bank account.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

application/json

This model represents the ach transaction in the response

typestring · enumRequired

Type of the ACH transaction.

Example: DebitPossible values:

amountstringOptional

The transaction amount.

Example: text

statusstring · enumOptional

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

Example: PendingPossible values:

routing-numberstringRequired

Bank routing number associated with the transaction.

Example: text

account-numberstringRequired

Last four digits of the bank account number.

Example: text

account-typestring · enumRequired

Type of bank account.

Example: CheckingPossible values:

standard-entry-class-codestring · enumRequired

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

Example: PPDPossible values:

check-numberstringOptional

Check number used for duplicate transaction validation.

Example: text

individual-namestringOptional

Name associated with the bank account.

Example: text

idstringOptional

Unique identifier of the ACH transaction.

Example: text

invoicestringOptional

Invoice number associated with the transaction.

Example: text

purchase-orderstringOptional

Purchase order number.

Example: text

customer-idstringOptional

A merchant-defined customer identifier.

Example: text

order-idstringOptional

A merchant-defined order identifier.

Example: text

email-addressstringOptional

The customer's email address.

Example: text

descriptionstringOptional

Short description of the transaction.

Example: text

commentsstringOptional

Additional comments associated with the transaction.

Example: text

billing-is-shippingstring · enumOptional

Indicates whether the billing and shipping addresses are the same.

Example: truePossible values:

status-change-datestringOptional

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

Example: text

display-messagestringOptional

A message describing the transaction status.

Example: text

provider-transaction-idstringOptional

Transaction identifier assigned by the ACH provider.

Example: text

trace-numberstringOptional

ACH trace number associated with a settled or returned transaction.

Example: text

settled-datestringOptional

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

Example: text

returned-datestringOptional

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

Example: text

returned-codestringOptional

NACHA return code for a returned transaction.

Example: text

returned-messagestringOptional

The description of the return reason.

Example: text

merchant-idstringOptional

The merchant identifier associated with the token.

Example: text

terminal-idstringOptional

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

Example: text

software-typestringOptional

Name of the software application that submitted the transaction.

Example: MySoftware_Version1.3

paya-authorizationstringOptional

Authorization reference returned by the Paya.

Example: text

processing-typestringOptional

Processing type of the transaction.

external-transaction-referencestringOptional

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

Example: external-transaction-reference

execution-datestringOptional

Date when the ACH transaction is executed.

Example: execution-date

token-idstringOptional

Identifier for the ACH payment token.

Example: 1188888888888888

create-datestringOptional

Date when the ACH transaction was created.

Example: create-date

micr-datastringOptional

Contains the MICR data printed on the check.

Example: T490000018T 24413815O 4456

image-front-edoc-idstringOptional

eDocs document ID for the front image of the check.

image-back-edoc-idstringOptional

eDocs document ID for the back image of the check.

image-frontstringOptional

Check's front image as Base64.

image-backstringOptional

Check's back image as Base64.

Responses

200

ok

application/jsonapplication/xml

Payload

payloadTypestringOptional

Type of the payload returned in the response.

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

post

/rest/v2/ach/transactions/debit

HTTPcURLJavaScriptPython

POST /rest/v2/ach/transactions/debit HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 1770

{
  "type": "Debit",
  "amount": "text",
  "status": "Pending",
  "routing-number": "text",
  "account-number": "text",
  "account-type": "Checking",
  "standard-entry-class-code": "PPD",
  "check-number": "text",
  "individual-name": "text",
  "id": "text",
  "billing": {
    "company": "Company",
    "street": "Street",
    "street2": "Street2",
    "city": "City",
    "state": "State",
    "zip": "Zip",
    "country": "Country",
    "phone": "Phone",
    "first-name": "John",
    "last-name": "Doe"
  },
  "shipping": {
    "company": "Company",
    "street": "Street",
    "street2": "Street2",
    "city": "City",
    "state": "State",
    "zip": "Zip",
    "country": "Country",
    "phone": "Phone",
    "first-name": "John",
    "last-name": "Doe"
  },
  "invoice": "text",
  "purchase-order": "text",
  "customer-id": "text",
  "order-id": "text",
  "email-address": "text",
  "description": "text",
  "comments": "text",
  "billing-is-shipping": "true",
  "status-change-date": "text",
  "display-message": "text",
  "provider-transaction-id": "text",
  "trace-number": "text",
  "settled-date": "text",
  "returned-date": "text",
  "returned-code": "text",
  "returned-message": "text",
  "ach-token": {
    "token-id": "1100000000000000",
    "times-used": 14,
    "last-used": "1100000000000000",
    "merchant-id": "000008888",
    "routing-number": "081009813",
    "account-number": "1111",
    "account-type": "Checking",
    "individual-name": "John Doe",
    "token-description": "Travel checking account",
    "created": "1100000000000000",
    "updated": "1100000000000000",
    "customer-key": "customer123",
    "default": false
  },
  "merchant-id": "text",
  "terminal-id": "text",
  "software-type": "MySoftware_Version1.3",
  "paya-authorization": "text",
  "processing-type": "text",
  "external-transaction-reference": "external-transaction-reference",
  "execution-date": "execution-date",
  "token-id": "1188888888888888",
  "create-date": "create-date",
  "micr-data": "T490000018T 24413815O 4456",
  "image-front-edoc-id": "text",
  "image-back-edoc-id": "text",
  "image-front": "text",
  "image-back": "text"
}

{
  "ach-transaction": {
    "type": "Debit",
    "amount": "text",
    "status": "Pending",
    "routing-number": "text",
    "account-number": "text",
    "account-type": "Checking",
    "standard-entry-class-code": "PPD",
    "check-number": "text",
    "individual-name": "text",
    "id": "text",
    "billing": {
      "company": "Company",
      "street": "Street",
      "street2": "Street2",
      "city": "City",
      "state": "State",
      "zip": "Zip",
      "country": "Country",
      "phone": "Phone",
      "first-name": "John",
      "last-name": "Doe"
    },
    "shipping": {
      "company": "Company",
      "street": "Street",
      "street2": "Street2",
      "city": "City",
      "state": "State",
      "zip": "Zip",
      "country": "Country",
      "phone": "Phone",
      "first-name": "John",
      "last-name": "Doe"
    },
    "invoice": "text",
    "purchase-order": "text",
    "customer-id": "text",
    "order-id": "text",
    "email-address": "text",
    "description": "text",
    "comments": "text",
    "billing-is-shipping": "true",
    "status-change-date": "text",
    "display-message": "text",
    "provider-transaction-id": "text",
    "trace-number": "text",
    "settled-date": "text",
    "returned-date": "text",
    "returned-code": "text",
    "returned-message": "text",
    "ach-token": {
      "token-id": "1100000000000000",
      "times-used": 14,
      "last-used": "1100000000000000",
      "merchant-id": "000008888",
      "routing-number": "081009813",
      "account-number": "1111",
      "account-type": "Checking",
      "individual-name": "John Doe",
      "token-description": "Travel checking account",
      "created": "1100000000000000",
      "updated": "1100000000000000",
      "customer-key": "customer123",
      "default": false
    },
    "merchant-id": "text",
    "terminal-id": "text",
    "software-type": "MySoftware_Version1.3",
    "paya-authorization": "text",
    "processing-type": "text",
    "external-transaction-reference": "external-transaction-reference",
    "execution-date": "execution-date",
    "token-id": "1188888888888888",
    "create-date": "create-date",
    "micr-data": "T490000018T 24413815O 4456",
    "image-front-edoc-id": "text",
    "image-back-edoc-id": "text",
    "image-front": "text",
    "image-back": "text"
  },
  "payloadType": "text"
}

Create ACH Credit Transaction

post

Create an ACH credit transaction to transfer funds from the merchant's bank account to the customer's bank account.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

application/json

This model represents the ach transaction in the response

typestring · enumRequired

Type of the ACH transaction.

Example: DebitPossible values:

amountstringOptional

The transaction amount.

Example: text

statusstring · enumOptional

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

Example: PendingPossible values:

routing-numberstringRequired

Bank routing number associated with the transaction.

Example: text

account-numberstringRequired

Last four digits of the bank account number.

Example: text

account-typestring · enumRequired

Type of bank account.

Example: CheckingPossible values:

standard-entry-class-codestring · enumRequired

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

Example: PPDPossible values:

check-numberstringOptional

Check number used for duplicate transaction validation.

Example: text

individual-namestringOptional

Name associated with the bank account.

Example: text

idstringOptional

Unique identifier of the ACH transaction.

Example: text

invoicestringOptional

Invoice number associated with the transaction.

Example: text

purchase-orderstringOptional

Purchase order number.

Example: text

customer-idstringOptional

A merchant-defined customer identifier.

Example: text

order-idstringOptional

A merchant-defined order identifier.

Example: text

email-addressstringOptional

The customer's email address.

Example: text

descriptionstringOptional

Short description of the transaction.

Example: text

commentsstringOptional

Additional comments associated with the transaction.

Example: text

billing-is-shippingstring · enumOptional

Indicates whether the billing and shipping addresses are the same.

Example: truePossible values:

status-change-datestringOptional

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

Example: text

display-messagestringOptional

A message describing the transaction status.

Example: text

provider-transaction-idstringOptional

Transaction identifier assigned by the ACH provider.

Example: text

trace-numberstringOptional

ACH trace number associated with a settled or returned transaction.

Example: text

settled-datestringOptional

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

Example: text

returned-datestringOptional

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

Example: text

returned-codestringOptional

NACHA return code for a returned transaction.

Example: text

returned-messagestringOptional

The description of the return reason.

Example: text

merchant-idstringOptional

The merchant identifier associated with the token.

Example: text

terminal-idstringOptional

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

Example: text

software-typestringOptional

Name of the software application that submitted the transaction.

Example: MySoftware_Version1.3

paya-authorizationstringOptional

Authorization reference returned by the Paya.

Example: text

processing-typestringOptional

Processing type of the transaction.

external-transaction-referencestringOptional

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

Example: external-transaction-reference

execution-datestringOptional

Date when the ACH transaction is executed.

Example: execution-date

token-idstringOptional

Identifier for the ACH payment token.

Example: 1188888888888888

create-datestringOptional

Date when the ACH transaction was created.

Example: create-date

micr-datastringOptional

Contains the MICR data printed on the check.

Example: T490000018T 24413815O 4456

image-front-edoc-idstringOptional

eDocs document ID for the front image of the check.

image-back-edoc-idstringOptional

eDocs document ID for the back image of the check.

image-frontstringOptional

Check's front image as Base64.

image-backstringOptional

Check's back image as Base64.

Responses

200

ok

application/jsonapplication/xml

Payload

payloadTypestringOptional

Type of the payload returned in the response.

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

post

/rest/v2/ach/transactions/credit

HTTPcURLJavaScriptPython

POST /rest/v2/ach/transactions/credit HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 1770

{
  "type": "Debit",
  "amount": "text",
  "status": "Pending",
  "routing-number": "text",
  "account-number": "text",
  "account-type": "Checking",
  "standard-entry-class-code": "PPD",
  "check-number": "text",
  "individual-name": "text",
  "id": "text",
  "billing": {
    "company": "Company",
    "street": "Street",
    "street2": "Street2",
    "city": "City",
    "state": "State",
    "zip": "Zip",
    "country": "Country",
    "phone": "Phone",
    "first-name": "John",
    "last-name": "Doe"
  },
  "shipping": {
    "company": "Company",
    "street": "Street",
    "street2": "Street2",
    "city": "City",
    "state": "State",
    "zip": "Zip",
    "country": "Country",
    "phone": "Phone",
    "first-name": "John",
    "last-name": "Doe"
  },
  "invoice": "text",
  "purchase-order": "text",
  "customer-id": "text",
  "order-id": "text",
  "email-address": "text",
  "description": "text",
  "comments": "text",
  "billing-is-shipping": "true",
  "status-change-date": "text",
  "display-message": "text",
  "provider-transaction-id": "text",
  "trace-number": "text",
  "settled-date": "text",
  "returned-date": "text",
  "returned-code": "text",
  "returned-message": "text",
  "ach-token": {
    "token-id": "1100000000000000",
    "times-used": 14,
    "last-used": "1100000000000000",
    "merchant-id": "000008888",
    "routing-number": "081009813",
    "account-number": "1111",
    "account-type": "Checking",
    "individual-name": "John Doe",
    "token-description": "Travel checking account",
    "created": "1100000000000000",
    "updated": "1100000000000000",
    "customer-key": "customer123",
    "default": false
  },
  "merchant-id": "text",
  "terminal-id": "text",
  "software-type": "MySoftware_Version1.3",
  "paya-authorization": "text",
  "processing-type": "text",
  "external-transaction-reference": "external-transaction-reference",
  "execution-date": "execution-date",
  "token-id": "1188888888888888",
  "create-date": "create-date",
  "micr-data": "T490000018T 24413815O 4456",
  "image-front-edoc-id": "text",
  "image-back-edoc-id": "text",
  "image-front": "text",
  "image-back": "text"
}

{
  "ach-transaction": {
    "type": "Debit",
    "amount": "text",
    "status": "Pending",
    "routing-number": "text",
    "account-number": "text",
    "account-type": "Checking",
    "standard-entry-class-code": "PPD",
    "check-number": "text",
    "individual-name": "text",
    "id": "text",
    "billing": {
      "company": "Company",
      "street": "Street",
      "street2": "Street2",
      "city": "City",
      "state": "State",
      "zip": "Zip",
      "country": "Country",
      "phone": "Phone",
      "first-name": "John",
      "last-name": "Doe"
    },
    "shipping": {
      "company": "Company",
      "street": "Street",
      "street2": "Street2",
      "city": "City",
      "state": "State",
      "zip": "Zip",
      "country": "Country",
      "phone": "Phone",
      "first-name": "John",
      "last-name": "Doe"
    },
    "invoice": "text",
    "purchase-order": "text",
    "customer-id": "text",
    "order-id": "text",
    "email-address": "text",
    "description": "text",
    "comments": "text",
    "billing-is-shipping": "true",
    "status-change-date": "text",
    "display-message": "text",
    "provider-transaction-id": "text",
    "trace-number": "text",
    "settled-date": "text",
    "returned-date": "text",
    "returned-code": "text",
    "returned-message": "text",
    "ach-token": {
      "token-id": "1100000000000000",
      "times-used": 14,
      "last-used": "1100000000000000",
      "merchant-id": "000008888",
      "routing-number": "081009813",
      "account-number": "1111",
      "account-type": "Checking",
      "individual-name": "John Doe",
      "token-description": "Travel checking account",
      "created": "1100000000000000",
      "updated": "1100000000000000",
      "customer-key": "customer123",
      "default": false
    },
    "merchant-id": "text",
    "terminal-id": "text",
    "software-type": "MySoftware_Version1.3",
    "paya-authorization": "text",
    "processing-type": "text",
    "external-transaction-reference": "external-transaction-reference",
    "execution-date": "execution-date",
    "token-id": "1188888888888888",
    "create-date": "create-date",
    "micr-data": "T490000018T 24413815O 4456",
    "image-front-edoc-id": "text",
    "image-back-edoc-id": "text",
    "image-front": "text",
    "image-back": "text"
  },
  "payloadType": "text"
}

Search ACH Transactions

get

Retrieve a paginated list of ACH transactions based on filtering and sorting capabilities.

Query parameters

idstringOptional

Unique identifier of the ACH transaction

typestring · enumOptional

Type of ACH transaction. Possible values: Debit, Credit.

Possible values:

amountnumber · doubleOptional

Amount of the ACH transaction

routing-numberstringOptional

Bank routing number associated with the transaction

account-typestring · enumOptional

Type of bank account used for the transaction (Checking or Savings)

Possible values:

trace-numberstringOptional

ACH trace number assigned to the transaction

check-numberstringOptional

Check number associated with the transaction

invoicestringOptional

Invoice number associated with the transaction

date-filterstring · enumOptional

Predefined date range used to filter transactions. Dates stored in UTC.

Possible values:

status-change-start-datestringOptional

Filters transactions processed after the specified UTC date/time. Use with status-change-end-date to define a range

status-change-end-datestringOptional

Filters transactions processed before the specified UTC date/time. Use with status-change-start-date to define a range

date-formatstring · enumOptional

Format used for start/end date values (UTC). Allowed values: MM-dd-yyyy hh:mm a, MM-dd-yy HH:mm, MM-dd-yy HH:mm z, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm z

Possible values:

order-idstringOptional

Order identifier associated with the transaction

pageintegerOptional

Page number of results to return when pagination is applied.

page-sizeintegerOptional

Number of results to return per page (default 25)

Default: 25

order-bystringOptional

Field name used to sort the results. Use in combination with the descending parameter.

purchase-orderstringOptional

Purchase order number associated with the transaction

customer-idstringOptional

Identifier of the customer associated with the transaction

descriptionstringOptional

Description associated with the transaction

statusstring · enumOptional

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

Possible values:

standard-entry-class-codestring · enumOptional

Standard Entry Class (SEC) code that identifies the ACH transaction type (value: PPD)

Possible values:

email-addressstringOptional

Email address associated with the transaction or customer

Header parameters

api-keystringRequired

API key assigned to the merchant

Responses

200

ok

application/jsonapplication/xml

Payload

payloadTypestringOptional

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

get

/rest/v2/ach/transactions

HTTPcURLJavaScriptPython

GET /rest/v2/ach/transactions HTTP/1.1
api-key: text
Accept: */*

{
  "ach-transactions": {
    "ach-transaction": [
      {
        "type": "Debit",
        "amount": "text",
        "status": "Pending",
        "routing-number": "text",
        "account-number": "text",
        "account-type": "Checking",
        "standard-entry-class-code": "PPD",
        "check-number": "text",
        "individual-name": "text",
        "id": "text",
        "billing": {
          "company": "Company",
          "street": "Street",
          "street2": "Street2",
          "city": "City",
          "state": "State",
          "zip": "Zip",
          "country": "Country",
          "phone": "Phone",
          "first-name": "John",
          "last-name": "Doe"
        },
        "shipping": {
          "company": "Company",
          "street": "Street",
          "street2": "Street2",
          "city": "City",
          "state": "State",
          "zip": "Zip",
          "country": "Country",
          "phone": "Phone",
          "first-name": "John",
          "last-name": "Doe"
        },
        "invoice": "text",
        "purchase-order": "text",
        "customer-id": "text",
        "order-id": "text",
        "email-address": "text",
        "description": "text",
        "comments": "text",
        "billing-is-shipping": "true",
        "status-change-date": "text",
        "display-message": "text",
        "provider-transaction-id": "text",
        "trace-number": "text",
        "settled-date": "text",
        "returned-date": "text",
        "returned-code": "text",
        "returned-message": "text",
        "ach-token": {
          "token-id": "1100000000000000",
          "times-used": 14,
          "last-used": "1100000000000000",
          "merchant-id": "000008888",
          "routing-number": "081009813",
          "account-number": "1111",
          "account-type": "Checking",
          "individual-name": "John Doe",
          "token-description": "Travel checking account",
          "created": "1100000000000000",
          "updated": "1100000000000000",
          "customer-key": "customer123",
          "default": false
        },
        "merchant-id": "text",
        "terminal-id": "text",
        "software-type": "MySoftware_Version1.3",
        "paya-authorization": "text",
        "processing-type": "text",
        "external-transaction-reference": "external-transaction-reference",
        "execution-date": "execution-date",
        "token-id": "1188888888888888",
        "create-date": "create-date",
        "micr-data": "T490000018T 24413815O 4456",
        "image-front-edoc-id": "text",
        "image-back-edoc-id": "text",
        "image-front": "text",
        "image-back": "text"
      }
    ]
  },
  "payloadType": "text"
}

Create ACH Transaction

post

Create an ACH transaction based on the provided transaction type.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

application/json

This model represents the ach transaction in the response

typestring · enumRequired

Type of the ACH transaction.

Example: DebitPossible values:

amountstringOptional

The transaction amount.

Example: text

statusstring · enumOptional

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

Example: PendingPossible values:

routing-numberstringRequired

Bank routing number associated with the transaction.

Example: text

account-numberstringRequired

Last four digits of the bank account number.

Example: text

account-typestring · enumRequired

Type of bank account.

Example: CheckingPossible values:

standard-entry-class-codestring · enumRequired

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

Example: PPDPossible values:

check-numberstringOptional

Check number used for duplicate transaction validation.

Example: text

individual-namestringOptional

Name associated with the bank account.

Example: text

idstringOptional

Unique identifier of the ACH transaction.

Example: text

invoicestringOptional

Invoice number associated with the transaction.

Example: text

purchase-orderstringOptional

Purchase order number.

Example: text

customer-idstringOptional

A merchant-defined customer identifier.

Example: text

order-idstringOptional

A merchant-defined order identifier.

Example: text

email-addressstringOptional

The customer's email address.

Example: text

descriptionstringOptional

Short description of the transaction.

Example: text

commentsstringOptional

Additional comments associated with the transaction.

Example: text

billing-is-shippingstring · enumOptional

Indicates whether the billing and shipping addresses are the same.

Example: truePossible values:

status-change-datestringOptional

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

Example: text

display-messagestringOptional

A message describing the transaction status.

Example: text

provider-transaction-idstringOptional

Transaction identifier assigned by the ACH provider.

Example: text

trace-numberstringOptional

ACH trace number associated with a settled or returned transaction.

Example: text

settled-datestringOptional

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

Example: text

returned-datestringOptional

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

Example: text

returned-codestringOptional

NACHA return code for a returned transaction.

Example: text

returned-messagestringOptional

The description of the return reason.

Example: text

merchant-idstringOptional

The merchant identifier associated with the token.

Example: text

terminal-idstringOptional

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

Example: text

software-typestringOptional

Name of the software application that submitted the transaction.

Example: MySoftware_Version1.3

paya-authorizationstringOptional

Authorization reference returned by the Paya.

Example: text

processing-typestringOptional

Processing type of the transaction.

external-transaction-referencestringOptional

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

Example: external-transaction-reference

execution-datestringOptional

Date when the ACH transaction is executed.

Example: execution-date

token-idstringOptional

Identifier for the ACH payment token.

Example: 1188888888888888

create-datestringOptional

Date when the ACH transaction was created.

Example: create-date

micr-datastringOptional

Contains the MICR data printed on the check.

Example: T490000018T 24413815O 4456

image-front-edoc-idstringOptional

eDocs document ID for the front image of the check.

image-back-edoc-idstringOptional

eDocs document ID for the back image of the check.

image-frontstringOptional

Check's front image as Base64.

image-backstringOptional

Check's back image as Base64.

Responses

200

ok

application/jsonapplication/xml

Payload

payloadTypestringOptional

Type of the payload returned in the response.

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

post

/rest/v2/ach/transactions

HTTPcURLJavaScriptPython

POST /rest/v2/ach/transactions HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 1770

{
  "type": "Debit",
  "amount": "text",
  "status": "Pending",
  "routing-number": "text",
  "account-number": "text",
  "account-type": "Checking",
  "standard-entry-class-code": "PPD",
  "check-number": "text",
  "individual-name": "text",
  "id": "text",
  "billing": {
    "company": "Company",
    "street": "Street",
    "street2": "Street2",
    "city": "City",
    "state": "State",
    "zip": "Zip",
    "country": "Country",
    "phone": "Phone",
    "first-name": "John",
    "last-name": "Doe"
  },
  "shipping": {
    "company": "Company",
    "street": "Street",
    "street2": "Street2",
    "city": "City",
    "state": "State",
    "zip": "Zip",
    "country": "Country",
    "phone": "Phone",
    "first-name": "John",
    "last-name": "Doe"
  },
  "invoice": "text",
  "purchase-order": "text",
  "customer-id": "text",
  "order-id": "text",
  "email-address": "text",
  "description": "text",
  "comments": "text",
  "billing-is-shipping": "true",
  "status-change-date": "text",
  "display-message": "text",
  "provider-transaction-id": "text",
  "trace-number": "text",
  "settled-date": "text",
  "returned-date": "text",
  "returned-code": "text",
  "returned-message": "text",
  "ach-token": {
    "token-id": "1100000000000000",
    "times-used": 14,
    "last-used": "1100000000000000",
    "merchant-id": "000008888",
    "routing-number": "081009813",
    "account-number": "1111",
    "account-type": "Checking",
    "individual-name": "John Doe",
    "token-description": "Travel checking account",
    "created": "1100000000000000",
    "updated": "1100000000000000",
    "customer-key": "customer123",
    "default": false
  },
  "merchant-id": "text",
  "terminal-id": "text",
  "software-type": "MySoftware_Version1.3",
  "paya-authorization": "text",
  "processing-type": "text",
  "external-transaction-reference": "external-transaction-reference",
  "execution-date": "execution-date",
  "token-id": "1188888888888888",
  "create-date": "create-date",
  "micr-data": "T490000018T 24413815O 4456",
  "image-front-edoc-id": "text",
  "image-back-edoc-id": "text",
  "image-front": "text",
  "image-back": "text"
}

{
  "ach-transaction": {
    "type": "Debit",
    "amount": "text",
    "status": "Pending",
    "routing-number": "text",
    "account-number": "text",
    "account-type": "Checking",
    "standard-entry-class-code": "PPD",
    "check-number": "text",
    "individual-name": "text",
    "id": "text",
    "billing": {
      "company": "Company",
      "street": "Street",
      "street2": "Street2",
      "city": "City",
      "state": "State",
      "zip": "Zip",
      "country": "Country",
      "phone": "Phone",
      "first-name": "John",
      "last-name": "Doe"
    },
    "shipping": {
      "company": "Company",
      "street": "Street",
      "street2": "Street2",
      "city": "City",
      "state": "State",
      "zip": "Zip",
      "country": "Country",
      "phone": "Phone",
      "first-name": "John",
      "last-name": "Doe"
    },
    "invoice": "text",
    "purchase-order": "text",
    "customer-id": "text",
    "order-id": "text",
    "email-address": "text",
    "description": "text",
    "comments": "text",
    "billing-is-shipping": "true",
    "status-change-date": "text",
    "display-message": "text",
    "provider-transaction-id": "text",
    "trace-number": "text",
    "settled-date": "text",
    "returned-date": "text",
    "returned-code": "text",
    "returned-message": "text",
    "ach-token": {
      "token-id": "1100000000000000",
      "times-used": 14,
      "last-used": "1100000000000000",
      "merchant-id": "000008888",
      "routing-number": "081009813",
      "account-number": "1111",
      "account-type": "Checking",
      "individual-name": "John Doe",
      "token-description": "Travel checking account",
      "created": "1100000000000000",
      "updated": "1100000000000000",
      "customer-key": "customer123",
      "default": false
    },
    "merchant-id": "text",
    "terminal-id": "text",
    "software-type": "MySoftware_Version1.3",
    "paya-authorization": "text",
    "processing-type": "text",
    "external-transaction-reference": "external-transaction-reference",
    "execution-date": "execution-date",
    "token-id": "1188888888888888",
    "create-date": "create-date",
    "micr-data": "T490000018T 24413815O 4456",
    "image-front-edoc-id": "text",
    "image-back-edoc-id": "text",
    "image-front": "text",
    "image-back": "text"
  },
  "payloadType": "text"
}

Get ACH Transaction by ID

get

Retrieve the details of a specific ACH transaction using the provided transaction ID.

Path parameters

idstringRequired

Unique identifier of the ACH transaction.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

ok

application/jsonapplication/xml

Payload

payloadTypestringOptional

Type of the payload returned in the response.

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

get

/rest/v2/ach/transactions/{id}

HTTPcURLJavaScriptPython

GET /rest/v2/ach/transactions/{id} HTTP/1.1
api-key: text
Accept: */*

{
  "ach-transaction": {
    "type": "Debit",
    "amount": "text",
    "status": "Pending",
    "routing-number": "text",
    "account-number": "text",
    "account-type": "Checking",
    "standard-entry-class-code": "PPD",
    "check-number": "text",
    "individual-name": "text",
    "id": "text",
    "billing": {
      "company": "Company",
      "street": "Street",
      "street2": "Street2",
      "city": "City",
      "state": "State",
      "zip": "Zip",
      "country": "Country",
      "phone": "Phone",
      "first-name": "John",
      "last-name": "Doe"
    },
    "shipping": {
      "company": "Company",
      "street": "Street",
      "street2": "Street2",
      "city": "City",
      "state": "State",
      "zip": "Zip",
      "country": "Country",
      "phone": "Phone",
      "first-name": "John",
      "last-name": "Doe"
    },
    "invoice": "text",
    "purchase-order": "text",
    "customer-id": "text",
    "order-id": "text",
    "email-address": "text",
    "description": "text",
    "comments": "text",
    "billing-is-shipping": "true",
    "status-change-date": "text",
    "display-message": "text",
    "provider-transaction-id": "text",
    "trace-number": "text",
    "settled-date": "text",
    "returned-date": "text",
    "returned-code": "text",
    "returned-message": "text",
    "ach-token": {
      "token-id": "1100000000000000",
      "times-used": 14,
      "last-used": "1100000000000000",
      "merchant-id": "000008888",
      "routing-number": "081009813",
      "account-number": "1111",
      "account-type": "Checking",
      "individual-name": "John Doe",
      "token-description": "Travel checking account",
      "created": "1100000000000000",
      "updated": "1100000000000000",
      "customer-key": "customer123",
      "default": false
    },
    "merchant-id": "text",
    "terminal-id": "text",
    "software-type": "MySoftware_Version1.3",
    "paya-authorization": "text",
    "processing-type": "text",
    "external-transaction-reference": "external-transaction-reference",
    "execution-date": "execution-date",
    "token-id": "1188888888888888",
    "create-date": "create-date",
    "micr-data": "T490000018T 24413815O 4456",
    "image-front-edoc-id": "text",
    "image-back-edoc-id": "text",
    "image-front": "text",
    "image-back": "text"
  },
  "payloadType": "text"
}

Delete ACH Transaction

delete

Delete an existing ACH transaction that has not yet been processed with a PENDING status.

Path parameters

idstringRequired

Unique identifier of the ACH transaction.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

ok

application/jsonapplication/xml

Payload

payloadTypestringOptional

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

delete

/rest/v2/ach/transactions/{id}

HTTPcURLJavaScriptPython

DELETE /rest/v2/ach/transactions/{id} HTTP/1.1
api-key: text
Accept: */*

{
  "ach-transactions": {
    "ach-transaction": [
      {
        "type": "Debit",
        "amount": "text",
        "status": "Pending",
        "routing-number": "text",
        "account-number": "text",
        "account-type": "Checking",
        "standard-entry-class-code": "PPD",
        "check-number": "text",
        "individual-name": "text",
        "id": "text",
        "billing": {
          "company": "Company",
          "street": "Street",
          "street2": "Street2",
          "city": "City",
          "state": "State",
          "zip": "Zip",
          "country": "Country",
          "phone": "Phone",
          "first-name": "John",
          "last-name": "Doe"
        },
        "shipping": {
          "company": "Company",
          "street": "Street",
          "street2": "Street2",
          "city": "City",
          "state": "State",
          "zip": "Zip",
          "country": "Country",
          "phone": "Phone",
          "first-name": "John",
          "last-name": "Doe"
        },
        "invoice": "text",
        "purchase-order": "text",
        "customer-id": "text",
        "order-id": "text",
        "email-address": "text",
        "description": "text",
        "comments": "text",
        "billing-is-shipping": "true",
        "status-change-date": "text",
        "display-message": "text",
        "provider-transaction-id": "text",
        "trace-number": "text",
        "settled-date": "text",
        "returned-date": "text",
        "returned-code": "text",
        "returned-message": "text",
        "ach-token": {
          "token-id": "1100000000000000",
          "times-used": 14,
          "last-used": "1100000000000000",
          "merchant-id": "000008888",
          "routing-number": "081009813",
          "account-number": "1111",
          "account-type": "Checking",
          "individual-name": "John Doe",
          "token-description": "Travel checking account",
          "created": "1100000000000000",
          "updated": "1100000000000000",
          "customer-key": "customer123",
          "default": false
        },
        "merchant-id": "text",
        "terminal-id": "text",
        "software-type": "MySoftware_Version1.3",
        "paya-authorization": "text",
        "processing-type": "text",
        "external-transaction-reference": "external-transaction-reference",
        "execution-date": "execution-date",
        "token-id": "1188888888888888",
        "create-date": "create-date",
        "micr-data": "T490000018T 24413815O 4456",
        "image-front-edoc-id": "text",
        "image-back-edoc-id": "text",
        "image-front": "text",
        "image-back": "text"
      }
    ]
  },
  "payloadType": "text"
}