> For the complete documentation index, see [llms.txt](https://docs.xplorpay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xplorpay.com/api-reference/api/payments/ach/ach-transaction/models.md).

# Models

## The Address object

```json
{"openapi":"3.0.1","info":{"title":"ACH Transaction API","version":"2.0"},"components":{"schemas":{"Address":{"type":"object","properties":{"company":{"type":"string","description":"Company name for the billing address."},"street":{"type":"string","description":"Primary street address."},"street2":{"type":"string","description":"Additional street address information."},"city":{"type":"string","description":"City of the billing address."},"state":{"type":"string","description":"The state of the billing address."},"zip":{"type":"string","description":"Postal code of billing address."},"country":{"type":"string","description":"Country of the billing address."},"phone":{"type":"string","description":"Primary contact phone number."},"first-name":{"type":"string","description":"First name of the contact."},"last-name":{"type":"string","description":"Last name of the contact."}},"description":"Contains shipping address and contact details.","xml":{"name":"address"}}}}}
```

## The ach-transaction object

```json
{"openapi":"3.0.1","info":{"title":"ACH Transaction API","version":"2.0"},"components":{"schemas":{"ach-transaction":{"required":["account-number","account-type","routing-number","standard-entry-class-code","type"],"type":"object","properties":{"type":{"type":"string","description":"Type of the ACH transaction.","enum":["Debit","Credit"]},"amount":{"type":"string","description":"The transaction amount."},"status":{"type":"string","description":"Current status of the ACH transaction. Possible values: Pending, Settling, Settled, Returned.","enum":["Pending","Settling","Settled","Returned","Writing","Declined","Not_Confirmed","Sent","Rejected","Funded","Partially_Funded","Completed"]},"routing-number":{"type":"string","description":"Bank routing number associated with the transaction."},"account-number":{"type":"string","description":"Last four digits of the bank account number."},"account-type":{"type":"string","description":"Type of bank account.","enum":["Checking","Savings"]},"standard-entry-class-code":{"type":"string","description":"ACH Standard Entry Class (SEC) code. For example, PPD.","enum":["PPD"]},"individual-name":{"type":"string","description":"Name associated with the bank account."},"id":{"type":"string","description":"Unique identifier of the ACH transaction."},"check-status":{"type":"string","description":"Check status of the ACH transaction. Possible values: Pending, Rejected, Debit Sent, Cancelled.","enum":["Pending","Rejected","Debit Sent","Cancelled","Credit Sent","Unprocessed"]},"funding-status":{"type":"string","description":"Funding status of the ACH transaction. Possible values: Pending, No Credit, Credit Sent, Chargeback.","enum":["Pending","No Credit","Credit Sent","Chargeback","Debit Sent","Unprocessed"]},"invoice":{"type":"string","description":"Invoice number associated with the transaction."},"check-number":{"type":"string","description":"Check number used for duplicate transaction validation."},"billing":{"$ref":"#/components/schemas/Address"},"shipping":{"$ref":"#/components/schemas/Address"},"purchase-order":{"type":"string","description":"Purchase order number."},"order-id":{"type":"string","description":"A merchant-defined order identifier."},"status-change-date":{"type":"string","description":"Date and time when the transaction status last changed (UTC)."},"customer-id":{"type":"string","description":"A merchant-defined customer identifier."},"email-address":{"type":"string","description":"The customer's email address."},"description":{"type":"string","description":"Short description of the transaction."},"comments":{"type":"string","description":"Additional comments associated with the transaction."},"billing-is-shipping":{"type":"string","description":"Indicates whether the billing and shipping addresses are the same.","enum":["true","false"]},"display-message":{"type":"string","description":"A message describing the transaction status."},"provider-transaction-id":{"type":"string","description":"Transaction identifier assigned by the ACH provider."},"trace-number":{"type":"string","description":"ACH trace number associated with a settled or returned transaction."},"settled-date":{"type":"string","description":"Date and time when the transaction was settled (UTC)."},"returned-date":{"type":"string","description":"Date and time when the transaction was returned (UTC)."},"returned-code":{"type":"string","description":"NACHA return code for a returned transaction."},"returned-message":{"type":"string","description":"The description of the return reason."},"ach-token":{"$ref":"#/components/schemas/Ach Token Response"},"merchant-id":{"type":"string","description":"The merchant identifier associated with the token."},"terminal-id":{"type":"string","description":"Identifier of the terminal or API key used to create the transaction."},"software-type":{"type":"string","description":"Name of the software application that submitted the transaction."},"paya-authorization":{"type":"string","description":"Authorization reference returned by the Paya."},"processing-type":{"type":"string","description":"Processing type of the transaction."},"external-transaction-reference":{"type":"string","description":"Identifies the transaction reference provided by the requester and must be unique per requester."},"execution-date":{"type":"string","description":"Date when the ACH transaction is executed."},"token-id":{"type":"string","description":"Identifier for the ACH payment token."},"create-date":{"type":"string","description":"Date when the ACH transaction was created."},"micr-data":{"type":"string","description":"Contains the MICR data printed on the check."},"image-front-edoc-id":{"type":"string","description":"eDocs document ID for the front image of the check."},"image-back-edoc-id":{"type":"string","description":"eDocs document ID for the back image of the check."},"image-front":{"type":"string","description":"Check's front image as Base64."},"image-back":{"type":"string","description":"Check's back image as Base64."}},"description":"This model represents the ach transaction in the response","xml":{"name":"ach-transaction"}},"Address":{"type":"object","properties":{"company":{"type":"string","description":"Company name for the billing address."},"street":{"type":"string","description":"Primary street address."},"street2":{"type":"string","description":"Additional street address information."},"city":{"type":"string","description":"City of the billing address."},"state":{"type":"string","description":"The state of the billing address."},"zip":{"type":"string","description":"Postal code of billing address."},"country":{"type":"string","description":"Country of the billing address."},"phone":{"type":"string","description":"Primary contact phone number."},"first-name":{"type":"string","description":"First name of the contact."},"last-name":{"type":"string","description":"Last name of the contact."}},"description":"Contains shipping address and contact details.","xml":{"name":"address"}},"Ach Token Response":{"type":"object","properties":{"token-id":{"type":"string","description":"Unique identifier of the ACH token."},"times-used":{"type":"integer","description":"Number of times the token has been used in an ACH transaction.","format":"int32"},"last-used":{"type":"string","description":"Date and time when the token was last used (UTC)."},"merchant-id":{"type":"string","description":"The merchant's unique identification number associated with the token."},"routing-number":{"type":"string","description":"Bank routing number"},"account-number":{"type":"string","description":"Masked or last four digits of the bank account number."},"account-type":{"type":"string","description":"Type of the bank account. Possible values: Checking, Savings.","enum":["Checking","Savings"]},"individual-name":{"type":"string","description":"Name associated with the bank account."},"token-description":{"type":"string","description":"A brief description of the ACH token."},"created":{"type":"string","description":"Date and time when the token was created (UTC)."},"updated":{"type":"string","description":"Date and time when the token was last updated (UTC)."},"customer-key":{"type":"string","description":"Unique customer key associated with the token."},"default":{"type":"boolean","description":"Indicates whether this token is the default for the card number."}},"description":"Tokenized ACH account information.","xml":{"name":"ach-token"}}}}}
```

## The Ach Token Response object

```json
{"openapi":"3.0.1","info":{"title":"ACH Transaction API","version":"2.0"},"components":{"schemas":{"Ach Token Response":{"type":"object","properties":{"token-id":{"type":"string","description":"Unique identifier of the ACH token."},"times-used":{"type":"integer","description":"Number of times the token has been used in an ACH transaction.","format":"int32"},"last-used":{"type":"string","description":"Date and time when the token was last used (UTC)."},"merchant-id":{"type":"string","description":"The merchant's unique identification number associated with the token."},"routing-number":{"type":"string","description":"Bank routing number"},"account-number":{"type":"string","description":"Masked or last four digits of the bank account number."},"account-type":{"type":"string","description":"Type of the bank account. Possible values: Checking, Savings.","enum":["Checking","Savings"]},"individual-name":{"type":"string","description":"Name associated with the bank account."},"token-description":{"type":"string","description":"A brief description of the ACH token."},"created":{"type":"string","description":"Date and time when the token was created (UTC)."},"updated":{"type":"string","description":"Date and time when the token was last updated (UTC)."},"customer-key":{"type":"string","description":"Unique customer key associated with the token."},"default":{"type":"boolean","description":"Indicates whether this token is the default for the card number."}},"description":"Tokenized ACH account information.","xml":{"name":"ach-token"}}}}}
```

## The AchTransactionResponsePayload object

```json
{"openapi":"3.0.1","info":{"title":"ACH Transaction API","version":"2.0"},"components":{"schemas":{"AchTransactionResponsePayload":{"type":"object","properties":{"ach-transaction":{"$ref":"#/components/schemas/ach-transaction"},"payloadType":{"type":"string","description":"Type of the payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"Payload","xml":{"name":"payload"}},"ach-transaction":{"required":["account-number","account-type","routing-number","standard-entry-class-code","type"],"type":"object","properties":{"type":{"type":"string","description":"Type of the ACH transaction.","enum":["Debit","Credit"]},"amount":{"type":"string","description":"The transaction amount."},"status":{"type":"string","description":"Current status of the ACH transaction. Possible values: Pending, Settling, Settled, Returned.","enum":["Pending","Settling","Settled","Returned","Writing","Declined","Not_Confirmed","Sent","Rejected","Funded","Partially_Funded","Completed"]},"routing-number":{"type":"string","description":"Bank routing number associated with the transaction."},"account-number":{"type":"string","description":"Last four digits of the bank account number."},"account-type":{"type":"string","description":"Type of bank account.","enum":["Checking","Savings"]},"standard-entry-class-code":{"type":"string","description":"ACH Standard Entry Class (SEC) code. For example, PPD.","enum":["PPD"]},"individual-name":{"type":"string","description":"Name associated with the bank account."},"id":{"type":"string","description":"Unique identifier of the ACH transaction."},"check-status":{"type":"string","description":"Check status of the ACH transaction. Possible values: Pending, Rejected, Debit Sent, Cancelled.","enum":["Pending","Rejected","Debit Sent","Cancelled","Credit Sent","Unprocessed"]},"funding-status":{"type":"string","description":"Funding status of the ACH transaction. Possible values: Pending, No Credit, Credit Sent, Chargeback.","enum":["Pending","No Credit","Credit Sent","Chargeback","Debit Sent","Unprocessed"]},"invoice":{"type":"string","description":"Invoice number associated with the transaction."},"check-number":{"type":"string","description":"Check number used for duplicate transaction validation."},"billing":{"$ref":"#/components/schemas/Address"},"shipping":{"$ref":"#/components/schemas/Address"},"purchase-order":{"type":"string","description":"Purchase order number."},"order-id":{"type":"string","description":"A merchant-defined order identifier."},"status-change-date":{"type":"string","description":"Date and time when the transaction status last changed (UTC)."},"customer-id":{"type":"string","description":"A merchant-defined customer identifier."},"email-address":{"type":"string","description":"The customer's email address."},"description":{"type":"string","description":"Short description of the transaction."},"comments":{"type":"string","description":"Additional comments associated with the transaction."},"billing-is-shipping":{"type":"string","description":"Indicates whether the billing and shipping addresses are the same.","enum":["true","false"]},"display-message":{"type":"string","description":"A message describing the transaction status."},"provider-transaction-id":{"type":"string","description":"Transaction identifier assigned by the ACH provider."},"trace-number":{"type":"string","description":"ACH trace number associated with a settled or returned transaction."},"settled-date":{"type":"string","description":"Date and time when the transaction was settled (UTC)."},"returned-date":{"type":"string","description":"Date and time when the transaction was returned (UTC)."},"returned-code":{"type":"string","description":"NACHA return code for a returned transaction."},"returned-message":{"type":"string","description":"The description of the return reason."},"ach-token":{"$ref":"#/components/schemas/Ach Token Response"},"merchant-id":{"type":"string","description":"The merchant identifier associated with the token."},"terminal-id":{"type":"string","description":"Identifier of the terminal or API key used to create the transaction."},"software-type":{"type":"string","description":"Name of the software application that submitted the transaction."},"paya-authorization":{"type":"string","description":"Authorization reference returned by the Paya."},"processing-type":{"type":"string","description":"Processing type of the transaction."},"external-transaction-reference":{"type":"string","description":"Identifies the transaction reference provided by the requester and must be unique per requester."},"execution-date":{"type":"string","description":"Date when the ACH transaction is executed."},"token-id":{"type":"string","description":"Identifier for the ACH payment token."},"create-date":{"type":"string","description":"Date when the ACH transaction was created."},"micr-data":{"type":"string","description":"Contains the MICR data printed on the check."},"image-front-edoc-id":{"type":"string","description":"eDocs document ID for the front image of the check."},"image-back-edoc-id":{"type":"string","description":"eDocs document ID for the back image of the check."},"image-front":{"type":"string","description":"Check's front image as Base64."},"image-back":{"type":"string","description":"Check's back image as Base64."}},"description":"This model represents the ach transaction in the response","xml":{"name":"ach-transaction"}},"Address":{"type":"object","properties":{"company":{"type":"string","description":"Company name for the billing address."},"street":{"type":"string","description":"Primary street address."},"street2":{"type":"string","description":"Additional street address information."},"city":{"type":"string","description":"City of the billing address."},"state":{"type":"string","description":"The state of the billing address."},"zip":{"type":"string","description":"Postal code of billing address."},"country":{"type":"string","description":"Country of the billing address."},"phone":{"type":"string","description":"Primary contact phone number."},"first-name":{"type":"string","description":"First name of the contact."},"last-name":{"type":"string","description":"Last name of the contact."}},"description":"Contains shipping address and contact details.","xml":{"name":"address"}},"Ach Token Response":{"type":"object","properties":{"token-id":{"type":"string","description":"Unique identifier of the ACH token."},"times-used":{"type":"integer","description":"Number of times the token has been used in an ACH transaction.","format":"int32"},"last-used":{"type":"string","description":"Date and time when the token was last used (UTC)."},"merchant-id":{"type":"string","description":"The merchant's unique identification number associated with the token."},"routing-number":{"type":"string","description":"Bank routing number"},"account-number":{"type":"string","description":"Masked or last four digits of the bank account number."},"account-type":{"type":"string","description":"Type of the bank account. Possible values: Checking, Savings.","enum":["Checking","Savings"]},"individual-name":{"type":"string","description":"Name associated with the bank account."},"token-description":{"type":"string","description":"A brief description of the ACH token."},"created":{"type":"string","description":"Date and time when the token was created (UTC)."},"updated":{"type":"string","description":"Date and time when the token was last updated (UTC)."},"customer-key":{"type":"string","description":"Unique customer key associated with the token."},"default":{"type":"boolean","description":"Indicates whether this token is the default for the card number."}},"description":"Tokenized ACH account information.","xml":{"name":"ach-token"}}}}}
```

## The ErrorResult object

```json
{"openapi":"3.0.1","info":{"title":"ACH Transaction API","version":"2.0"},"components":{"schemas":{"ErrorResult":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the error type."},"title":{"type":"string","description":"Human-readable summary of the problem."},"status":{"type":"integer","description":"HTTP status code of the response.","format":"int32"},"detail":{"type":"string","description":"Detailed explanation of the problem for this occurrence."},"instance":{"type":"string","description":"URI reference that identifies this specific error occurrence."}},"description":"Contains one or more error objects returned"}}}}
```

## The Ach Provider object

```json
{"openapi":"3.0.1","info":{"title":"ACH Transaction API","version":"2.0"},"components":{"schemas":{"Ach Provider":{"required":["account-id"],"type":"object","properties":{"account-id":{"type":"string","description":"Unique identifier of the account associated with the ACH provider."},"provider":{"type":"string","description":"The ACH provider name associated with the configuration. Possible values: PAYA, ACHECK21.","enum":["PAYA","ACHECK21"]},"standard-entry-class-code":{"type":"string","description":"The Standard Entry Class (SEC) code supported by the ACH provider. Possible values: PPD, WEB, CCD, C21.","enum":["PPD","WEB","CCD","C21"]},"enabled":{"type":"boolean","description":"Indicates whether the ACH provider is enabled for processing transactions. Set to true if ACH is enabled on account."}},"description":"Details of ACH provider.","xml":{"name":"ach-provider"}}}}}
```

## The AchTransactionStatusesResponsePayload object

```json
{"openapi":"3.0.1","info":{"title":"ACH Transaction API","version":"2.0"},"components":{"schemas":{"AchTransactionStatusesResponsePayload":{"type":"object","properties":{"ach-transaction-statuses":{"$ref":"#/components/schemas/ach-transaction-statuses"},"payloadType":{"type":"string","description":"Type of the payload returned in the response.","xml":{"name":"type","attribute":true}}},"xml":{"name":"payload"}},"ach-transaction-statuses":{"type":"object","properties":{"ach-transaction-status":{"type":"array","items":{"$ref":"#/components/schemas/ach-transaction-status"}}},"description":"Contains the list of status records associated with the ACH transaction.","xml":{"name":"ach-transaction-statuses"}},"ach-transaction-status":{"type":"object","properties":{"status":{"type":"string","description":"Current processing status of an ACH transaction. Possible values are Pending, Settling, Settled, Returned, Writing, Declined, Not_Confirmed, Sent, Rejected, Funded, Partially_Funded and Completed."},"check-status":{"type":"string","description":"Check processing status for the transaction."},"funding-status":{"type":"string","description":"Funding progress status for the transaction."},"created-date":{"type":"string","description":"Date and time when the transaction status record was created (UTC). Format: ISO 8601 (YYYY-MM-DDTHH:mm:ssZ)."}},"description":"Represents the current processing status details of an ACH transaction.","xml":{"name":"ach-transaction-status"}}}}}
```

## The ach-transaction-status object

```json
{"openapi":"3.0.1","info":{"title":"ACH Transaction API","version":"2.0"},"components":{"schemas":{"ach-transaction-status":{"type":"object","properties":{"status":{"type":"string","description":"Current processing status of an ACH transaction. Possible values are Pending, Settling, Settled, Returned, Writing, Declined, Not_Confirmed, Sent, Rejected, Funded, Partially_Funded and Completed."},"check-status":{"type":"string","description":"Check processing status for the transaction."},"funding-status":{"type":"string","description":"Funding progress status for the transaction."},"created-date":{"type":"string","description":"Date and time when the transaction status record was created (UTC). Format: ISO 8601 (YYYY-MM-DDTHH:mm:ssZ)."}},"description":"Represents the current processing status details of an ACH transaction.","xml":{"name":"ach-transaction-status"}}}}}
```

## The ach-transaction-statuses object

```json
{"openapi":"3.0.1","info":{"title":"ACH Transaction API","version":"2.0"},"components":{"schemas":{"ach-transaction-statuses":{"type":"object","properties":{"ach-transaction-status":{"type":"array","items":{"$ref":"#/components/schemas/ach-transaction-status"}}},"description":"Contains the list of status records associated with the ACH transaction.","xml":{"name":"ach-transaction-statuses"}},"ach-transaction-status":{"type":"object","properties":{"status":{"type":"string","description":"Current processing status of an ACH transaction. Possible values are Pending, Settling, Settled, Returned, Writing, Declined, Not_Confirmed, Sent, Rejected, Funded, Partially_Funded and Completed."},"check-status":{"type":"string","description":"Check processing status for the transaction."},"funding-status":{"type":"string","description":"Funding progress status for the transaction."},"created-date":{"type":"string","description":"Date and time when the transaction status record was created (UTC). Format: ISO 8601 (YYYY-MM-DDTHH:mm:ssZ)."}},"description":"Represents the current processing status details of an ACH transaction.","xml":{"name":"ach-transaction-status"}}}}}
```

## The AchTransactions object

```json
{"openapi":"3.0.1","info":{"title":"ACH Transaction API","version":"2.0"},"components":{"schemas":{"AchTransactions":{"type":"object","properties":{"ach-transaction":{"type":"array","items":{"$ref":"#/components/schemas/ach-transaction"}}},"xml":{"name":"ach-transactions"}},"ach-transaction":{"required":["account-number","account-type","routing-number","standard-entry-class-code","type"],"type":"object","properties":{"type":{"type":"string","description":"Type of the ACH transaction.","enum":["Debit","Credit"]},"amount":{"type":"string","description":"The transaction amount."},"status":{"type":"string","description":"Current status of the ACH transaction. Possible values: Pending, Settling, Settled, Returned.","enum":["Pending","Settling","Settled","Returned","Writing","Declined","Not_Confirmed","Sent","Rejected","Funded","Partially_Funded","Completed"]},"routing-number":{"type":"string","description":"Bank routing number associated with the transaction."},"account-number":{"type":"string","description":"Last four digits of the bank account number."},"account-type":{"type":"string","description":"Type of bank account.","enum":["Checking","Savings"]},"standard-entry-class-code":{"type":"string","description":"ACH Standard Entry Class (SEC) code. For example, PPD.","enum":["PPD"]},"individual-name":{"type":"string","description":"Name associated with the bank account."},"id":{"type":"string","description":"Unique identifier of the ACH transaction."},"check-status":{"type":"string","description":"Check status of the ACH transaction. Possible values: Pending, Rejected, Debit Sent, Cancelled.","enum":["Pending","Rejected","Debit Sent","Cancelled","Credit Sent","Unprocessed"]},"funding-status":{"type":"string","description":"Funding status of the ACH transaction. Possible values: Pending, No Credit, Credit Sent, Chargeback.","enum":["Pending","No Credit","Credit Sent","Chargeback","Debit Sent","Unprocessed"]},"invoice":{"type":"string","description":"Invoice number associated with the transaction."},"check-number":{"type":"string","description":"Check number used for duplicate transaction validation."},"billing":{"$ref":"#/components/schemas/Address"},"shipping":{"$ref":"#/components/schemas/Address"},"purchase-order":{"type":"string","description":"Purchase order number."},"order-id":{"type":"string","description":"A merchant-defined order identifier."},"status-change-date":{"type":"string","description":"Date and time when the transaction status last changed (UTC)."},"customer-id":{"type":"string","description":"A merchant-defined customer identifier."},"email-address":{"type":"string","description":"The customer's email address."},"description":{"type":"string","description":"Short description of the transaction."},"comments":{"type":"string","description":"Additional comments associated with the transaction."},"billing-is-shipping":{"type":"string","description":"Indicates whether the billing and shipping addresses are the same.","enum":["true","false"]},"display-message":{"type":"string","description":"A message describing the transaction status."},"provider-transaction-id":{"type":"string","description":"Transaction identifier assigned by the ACH provider."},"trace-number":{"type":"string","description":"ACH trace number associated with a settled or returned transaction."},"settled-date":{"type":"string","description":"Date and time when the transaction was settled (UTC)."},"returned-date":{"type":"string","description":"Date and time when the transaction was returned (UTC)."},"returned-code":{"type":"string","description":"NACHA return code for a returned transaction."},"returned-message":{"type":"string","description":"The description of the return reason."},"ach-token":{"$ref":"#/components/schemas/Ach Token Response"},"merchant-id":{"type":"string","description":"The merchant identifier associated with the token."},"terminal-id":{"type":"string","description":"Identifier of the terminal or API key used to create the transaction."},"software-type":{"type":"string","description":"Name of the software application that submitted the transaction."},"paya-authorization":{"type":"string","description":"Authorization reference returned by the Paya."},"processing-type":{"type":"string","description":"Processing type of the transaction."},"external-transaction-reference":{"type":"string","description":"Identifies the transaction reference provided by the requester and must be unique per requester."},"execution-date":{"type":"string","description":"Date when the ACH transaction is executed."},"token-id":{"type":"string","description":"Identifier for the ACH payment token."},"create-date":{"type":"string","description":"Date when the ACH transaction was created."},"micr-data":{"type":"string","description":"Contains the MICR data printed on the check."},"image-front-edoc-id":{"type":"string","description":"eDocs document ID for the front image of the check."},"image-back-edoc-id":{"type":"string","description":"eDocs document ID for the back image of the check."},"image-front":{"type":"string","description":"Check's front image as Base64."},"image-back":{"type":"string","description":"Check's back image as Base64."}},"description":"This model represents the ach transaction in the response","xml":{"name":"ach-transaction"}},"Address":{"type":"object","properties":{"company":{"type":"string","description":"Company name for the billing address."},"street":{"type":"string","description":"Primary street address."},"street2":{"type":"string","description":"Additional street address information."},"city":{"type":"string","description":"City of the billing address."},"state":{"type":"string","description":"The state of the billing address."},"zip":{"type":"string","description":"Postal code of billing address."},"country":{"type":"string","description":"Country of the billing address."},"phone":{"type":"string","description":"Primary contact phone number."},"first-name":{"type":"string","description":"First name of the contact."},"last-name":{"type":"string","description":"Last name of the contact."}},"description":"Contains shipping address and contact details.","xml":{"name":"address"}},"Ach Token Response":{"type":"object","properties":{"token-id":{"type":"string","description":"Unique identifier of the ACH token."},"times-used":{"type":"integer","description":"Number of times the token has been used in an ACH transaction.","format":"int32"},"last-used":{"type":"string","description":"Date and time when the token was last used (UTC)."},"merchant-id":{"type":"string","description":"The merchant's unique identification number associated with the token."},"routing-number":{"type":"string","description":"Bank routing number"},"account-number":{"type":"string","description":"Masked or last four digits of the bank account number."},"account-type":{"type":"string","description":"Type of the bank account. Possible values: Checking, Savings.","enum":["Checking","Savings"]},"individual-name":{"type":"string","description":"Name associated with the bank account."},"token-description":{"type":"string","description":"A brief description of the ACH token."},"created":{"type":"string","description":"Date and time when the token was created (UTC)."},"updated":{"type":"string","description":"Date and time when the token was last updated (UTC)."},"customer-key":{"type":"string","description":"Unique customer key associated with the token."},"default":{"type":"boolean","description":"Indicates whether this token is the default for the card number."}},"description":"Tokenized ACH account information.","xml":{"name":"ach-token"}}}}}
```

## The AchTransactionsResponsePayload object

```json
{"openapi":"3.0.1","info":{"title":"ACH Transaction API","version":"2.0"},"components":{"schemas":{"AchTransactionsResponsePayload":{"type":"object","properties":{"ach-transactions":{"$ref":"#/components/schemas/AchTransactions"},"payloadType":{"type":"string","xml":{"name":"type","attribute":true}}},"description":"Payload","xml":{"name":"payload"}},"AchTransactions":{"type":"object","properties":{"ach-transaction":{"type":"array","items":{"$ref":"#/components/schemas/ach-transaction"}}},"xml":{"name":"ach-transactions"}},"ach-transaction":{"required":["account-number","account-type","routing-number","standard-entry-class-code","type"],"type":"object","properties":{"type":{"type":"string","description":"Type of the ACH transaction.","enum":["Debit","Credit"]},"amount":{"type":"string","description":"The transaction amount."},"status":{"type":"string","description":"Current status of the ACH transaction. Possible values: Pending, Settling, Settled, Returned.","enum":["Pending","Settling","Settled","Returned","Writing","Declined","Not_Confirmed","Sent","Rejected","Funded","Partially_Funded","Completed"]},"routing-number":{"type":"string","description":"Bank routing number associated with the transaction."},"account-number":{"type":"string","description":"Last four digits of the bank account number."},"account-type":{"type":"string","description":"Type of bank account.","enum":["Checking","Savings"]},"standard-entry-class-code":{"type":"string","description":"ACH Standard Entry Class (SEC) code. For example, PPD.","enum":["PPD"]},"individual-name":{"type":"string","description":"Name associated with the bank account."},"id":{"type":"string","description":"Unique identifier of the ACH transaction."},"check-status":{"type":"string","description":"Check status of the ACH transaction. Possible values: Pending, Rejected, Debit Sent, Cancelled.","enum":["Pending","Rejected","Debit Sent","Cancelled","Credit Sent","Unprocessed"]},"funding-status":{"type":"string","description":"Funding status of the ACH transaction. Possible values: Pending, No Credit, Credit Sent, Chargeback.","enum":["Pending","No Credit","Credit Sent","Chargeback","Debit Sent","Unprocessed"]},"invoice":{"type":"string","description":"Invoice number associated with the transaction."},"check-number":{"type":"string","description":"Check number used for duplicate transaction validation."},"billing":{"$ref":"#/components/schemas/Address"},"shipping":{"$ref":"#/components/schemas/Address"},"purchase-order":{"type":"string","description":"Purchase order number."},"order-id":{"type":"string","description":"A merchant-defined order identifier."},"status-change-date":{"type":"string","description":"Date and time when the transaction status last changed (UTC)."},"customer-id":{"type":"string","description":"A merchant-defined customer identifier."},"email-address":{"type":"string","description":"The customer's email address."},"description":{"type":"string","description":"Short description of the transaction."},"comments":{"type":"string","description":"Additional comments associated with the transaction."},"billing-is-shipping":{"type":"string","description":"Indicates whether the billing and shipping addresses are the same.","enum":["true","false"]},"display-message":{"type":"string","description":"A message describing the transaction status."},"provider-transaction-id":{"type":"string","description":"Transaction identifier assigned by the ACH provider."},"trace-number":{"type":"string","description":"ACH trace number associated with a settled or returned transaction."},"settled-date":{"type":"string","description":"Date and time when the transaction was settled (UTC)."},"returned-date":{"type":"string","description":"Date and time when the transaction was returned (UTC)."},"returned-code":{"type":"string","description":"NACHA return code for a returned transaction."},"returned-message":{"type":"string","description":"The description of the return reason."},"ach-token":{"$ref":"#/components/schemas/Ach Token Response"},"merchant-id":{"type":"string","description":"The merchant identifier associated with the token."},"terminal-id":{"type":"string","description":"Identifier of the terminal or API key used to create the transaction."},"software-type":{"type":"string","description":"Name of the software application that submitted the transaction."},"paya-authorization":{"type":"string","description":"Authorization reference returned by the Paya."},"processing-type":{"type":"string","description":"Processing type of the transaction."},"external-transaction-reference":{"type":"string","description":"Identifies the transaction reference provided by the requester and must be unique per requester."},"execution-date":{"type":"string","description":"Date when the ACH transaction is executed."},"token-id":{"type":"string","description":"Identifier for the ACH payment token."},"create-date":{"type":"string","description":"Date when the ACH transaction was created."},"micr-data":{"type":"string","description":"Contains the MICR data printed on the check."},"image-front-edoc-id":{"type":"string","description":"eDocs document ID for the front image of the check."},"image-back-edoc-id":{"type":"string","description":"eDocs document ID for the back image of the check."},"image-front":{"type":"string","description":"Check's front image as Base64."},"image-back":{"type":"string","description":"Check's back image as Base64."}},"description":"This model represents the ach transaction in the response","xml":{"name":"ach-transaction"}},"Address":{"type":"object","properties":{"company":{"type":"string","description":"Company name for the billing address."},"street":{"type":"string","description":"Primary street address."},"street2":{"type":"string","description":"Additional street address information."},"city":{"type":"string","description":"City of the billing address."},"state":{"type":"string","description":"The state of the billing address."},"zip":{"type":"string","description":"Postal code of billing address."},"country":{"type":"string","description":"Country of the billing address."},"phone":{"type":"string","description":"Primary contact phone number."},"first-name":{"type":"string","description":"First name of the contact."},"last-name":{"type":"string","description":"Last name of the contact."}},"description":"Contains shipping address and contact details.","xml":{"name":"address"}},"Ach Token Response":{"type":"object","properties":{"token-id":{"type":"string","description":"Unique identifier of the ACH token."},"times-used":{"type":"integer","description":"Number of times the token has been used in an ACH transaction.","format":"int32"},"last-used":{"type":"string","description":"Date and time when the token was last used (UTC)."},"merchant-id":{"type":"string","description":"The merchant's unique identification number associated with the token."},"routing-number":{"type":"string","description":"Bank routing number"},"account-number":{"type":"string","description":"Masked or last four digits of the bank account number."},"account-type":{"type":"string","description":"Type of the bank account. Possible values: Checking, Savings.","enum":["Checking","Savings"]},"individual-name":{"type":"string","description":"Name associated with the bank account."},"token-description":{"type":"string","description":"A brief description of the ACH token."},"created":{"type":"string","description":"Date and time when the token was created (UTC)."},"updated":{"type":"string","description":"Date and time when the token was last updated (UTC)."},"customer-key":{"type":"string","description":"Unique customer key associated with the token."},"default":{"type":"boolean","description":"Indicates whether this token is the default for the card number."}},"description":"Tokenized ACH account information.","xml":{"name":"ach-token"}}}}}
```

## The AchProviders object

```json
{"openapi":"3.0.1","info":{"title":"ACH Transaction API","version":"2.0"},"components":{"schemas":{"AchProviders":{"type":"object","properties":{"ach-provider":{"type":"array","items":{"$ref":"#/components/schemas/Ach Provider"}}},"xml":{"name":"ach-providers"}},"Ach Provider":{"required":["account-id"],"type":"object","properties":{"account-id":{"type":"string","description":"Unique identifier of the account associated with the ACH provider."},"provider":{"type":"string","description":"The ACH provider name associated with the configuration. Possible values: PAYA, ACHECK21.","enum":["PAYA","ACHECK21"]},"standard-entry-class-code":{"type":"string","description":"The Standard Entry Class (SEC) code supported by the ACH provider. Possible values: PPD, WEB, CCD, C21.","enum":["PPD","WEB","CCD","C21"]},"enabled":{"type":"boolean","description":"Indicates whether the ACH provider is enabled for processing transactions. Set to true if ACH is enabled on account."}},"description":"Details of ACH provider.","xml":{"name":"ach-provider"}}}}}
```

## The AchProvidersResponsePayload object

```json
{"openapi":"3.0.1","info":{"title":"ACH Transaction API","version":"2.0"},"components":{"schemas":{"AchProvidersResponsePayload":{"type":"object","properties":{"payloadType":{"type":"string","description":"Type of the payload returned in the response.","xml":{"name":"type","attribute":true}},"ach-providers":{"$ref":"#/components/schemas/AchProviders"}},"description":"Payload","xml":{"name":"payload"}},"AchProviders":{"type":"object","properties":{"ach-provider":{"type":"array","items":{"$ref":"#/components/schemas/Ach Provider"}}},"xml":{"name":"ach-providers"}},"Ach Provider":{"required":["account-id"],"type":"object","properties":{"account-id":{"type":"string","description":"Unique identifier of the account associated with the ACH provider."},"provider":{"type":"string","description":"The ACH provider name associated with the configuration. Possible values: PAYA, ACHECK21.","enum":["PAYA","ACHECK21"]},"standard-entry-class-code":{"type":"string","description":"The Standard Entry Class (SEC) code supported by the ACH provider. Possible values: PPD, WEB, CCD, C21.","enum":["PPD","WEB","CCD","C21"]},"enabled":{"type":"boolean","description":"Indicates whether the ACH provider is enabled for processing transactions. Set to true if ACH is enabled on account."}},"description":"Details of ACH provider.","xml":{"name":"ach-provider"}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xplorpay.com/api-reference/api/payments/ach/ach-transaction/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.