Getting an ACH transaction

To get an ACH transaction:

1

Use the GET method with the /rest/v2/ach/transactions endpoint.

2

Enter the ID returned in the ACH payment response in the search criteria to find the transaction.

The ach-transaction returns the following response:

{ 
 "ach-transaction": 
  [ 
   { 
    "check-field": "invoice", 
    "client-ip": "111.22.22.333", 
    "dob-year": "dob-year", 
    "email-receipt": "true", 
    "software-type-version": "1.0", 
    "type": "Debit", 
    "validate-account": "true", 
    "amount": "string", 
    "routing-number": "string", 
    "account-number": "string", 
    "account-type": "Checking", 
    "standard-entry-class-code": "PPD", 
    "check-number": "string", 
    "create-token": "false", 
    "create-description": "false", 
    "individual-name": "string", 
    "token-id": "1188888888888888", 
    "id": "string", 
    "status": "Pending", 
    "billing": 
     { 
      "city": "City", 
      "company": "Company", 
      "country": "Country", 
      "first-name": "John", 
      "last-name": "Doe", 
      "phone": "Phone", 
      "state": "State", 
      "street": "Street", 
      "street2": "Street2", 
      "zip": "Zip" 
     }, 
      "shipping": 
       { 
        "city": "City", 
        "company": "Company", 
        "country": "Country", 
        "first-name": "John", 
        "last-name": "Doe", 
        "phone": "Phone", 
        "state": "State", 
        "street": "Street", 
        "street2": "Street2", 
        "zip": "Zip" 
       }, 
        "invoice": "string", 
        "purchase-order": "string", 
        "customer-id": "string", 
        "order-id": "string", 
        "email-address": "string", 
        "description": "string", 
        "comments": "string", 
        "billing-is-shipping": "true", 
        "status-change-date": "string", 
        "display-message": "string", 
        "provider-transaction-id": "string", 
        "trace-number": "string", 
        "settled-date": "string", 
        "returned-date": "string", 
        "returned-code": "string", 
        "returned-message": "string", 
        "ach-token": 
         { 
          "account-number": "1111", 
          "account-type": "Checking", 
          "created": "1100000000000000", 
          "customer-key": "customer123", 
          "default": true, 
          "individual-name": "John Doe", 
          "last-used": "1100000000000000", 
          "merchant-id": "000008888", 
          "routing-number": "081009813", 
          "times-used": 14, 
          "token-description": "Travel checking account", 
          "token-id": "1100000000000000", 
          "updated": "1100000000000000" 
         }, 
          "merchant-id": "string", 
          "terminal-id": "string", 
          "software-type": "MySoftware_Version1.3", 
          "paya-authorization": "string" 
   } 
  ] 
}

The following table describes the fields in the response body:

Name	Data type	Description
ach-transaction	Array of strings	Contains the details of the ACH transaction.
check-field	String	Specifies the field used for check identification, such as an invoice number.
client-ip	String	The IP address of the client initiating the request.
dob-year	String	The customers year of birth.
email-receipt	String	Indicates whether to send an email receipt.
software-type-version	String	The version of the software used to initiate the transaction.
type	String	The transaction type. For example, Debit.
validate-account	String	Indicates whether to validate the bank account.
amount	String	The transaction amount.
routing-number	String	The bank routing number.
account-number	String	The bank account number.
account-type	String	The type of bank account. For example, Checking or Savings.
standard-entry-class-code	String	The ACH standard entry class code. For example, PPD.
check-number	String	The check number associated with the transaction.
create-token	String	Indicates whether to create a reusable token.
create-description	String	Indicates whether to create a transaction description.
individual-name	String	The name of the individual associated with the transaction.
token-id	String	The unique identifier of the token.
id	String	The unique identifier of the transaction.
status	String	The current status of the transaction. For example, Pending.
billing	Object	Contains billing address details.
billing.city	String	The billing city.
billing.company	String	The billing company.
billing.country	String	The billing country.
billing.first-name	String	The first name of the billing contact.
billing.last-name	String	The last name of the billing contact.
billing.phone	String	The phone number of the billing contact.
billing.state	String	The billing state.
billing.street	String	The billing street address.
billing.street2	String	The second line of the billing street address.
billing.zip	String	The billing ZIP code.
shipping	Object	Contains shipping address details.
shipping.city	String	The shipping city.
shipping.company	String	The shipping company.
shipping.country	String	The shipping country.
shipping.first-name	String	The first name of the shipping contact.
shipping.last-name	String	The last name of the shipping contact.
shipping.phone	String	The phone number of the shipping contact.
shipping.state	String	The shipping state.
shipping.street	String	The shipping street address.
shipping.street2	String	The second line of the shipping street address.
shipping.zip	String	The shipping ZIP code.
invoice	String	The invoice number associated with the transaction.
purchase-order	String	The purchase order number associated with the transaction.
customer-id	String	The unique identifier of the customer.
order-id	String	The unique identifier of the order.
email-address	String	The email address of the customer.
description	String	A description of the transaction.
comments	String	Additional comments about the transaction.
billing-is-shipping	String	Indicates whether the billing address is the same as the shipping address. Use true or false.
status-change-date	String	The date when the transaction status last changed.
display-message	String	A message to be displayed to the user.
provider-transaction-id	String	The unique identifier of the transaction from the payment provider.
trace-number	String	The trace number associated with the transaction.
settled-date	String	The date when the transaction was settled.
returned-date	String	The date when the transaction was returned.
returned-code	String	The code indicating the reason for the transaction return.
returned-message	String	The message indicating the reason for the transaction return.
ach-token	Object	Contains details of the ACH token.
ach-token.account-number	String	The masked bank account number associated with the token.
ach-token.account-type	String	The type of bank account. For example, Checking or Savings.
ach-token.created	String	The timestamp when the ACH token was created.
ach-token.customer-key	String	The unique key of the customer associated with the ACH token.
ach-token.default	Boolean	Indicates whether the ACH token is the default token.
ach-token.individual-name	String	The name of the individual associated with the ACH token.
ach-token.last-used	String	The timestamp when the ACH token was last used.
ach-token.merchant-id	String	The unique identifier of the merchant associated with the ACH token.
ach-token.routing-number	String	The bank routing number associated with the account.
ach-token.times-used	String	The number of times the ACH token has been used.
ach-token.token-description	String	A description of the ACH token, such as the accounts purpose.
ach-token.token-id	String	The unique identifier of the ACH token.
ach-token.updated	String	The timestamp when the ACH token was last updated.
merchant-id	String	The unique identifier of the merchant.
terminal-id	String	The unique identifier of the terminal.
software-type	String	The name and version of the software initiating the request.
paya-authorization	String	The authorization code from Paya.

The ach-transaction returns the following status and error codes:

Code	Description
401	If the ACH token has expired or the signature does not match the token.
204	Not found.
200	The ACH transaction list was generated successfully.