Create ACH token

Creating an ACH token validates the account number or routing number for transaction.

To create an ACH token:

1

Use the POST method with the /rest/v2/ach/tokens endpoint and the following sample request:

{ 
    "account-number": "123456789", 
    "account-type": "Checking", 
    "individual-name": "John Doe", 
    "routing-number": "081009813", 
    "software-type": "MySoftware", 
    "software-type-version": "v1.0", 
    "token-description": "Business checking account" 
}

The following table describes the request body parameters:

Name	Data type	Required?	Description
account-number	String	Optional	The bank account number used for the ACH transaction.
account-type	String	Optional	The type of bank account. For example, Checking or Savings.
individual-name	String	Optional	The name of the individual associated with the bank account.
routing-number	String	Optional	The bank routing number used to identify the financial institution.
software-type	String	Optional	The name of the software initiating the request.
software-type-version	String	Optional	The version of the software used to initiate the request.
token-description	String	Optional	A description of the token being created, such as the account purpose.

2

Set create-token to true in the transaction payload to generate and store a token for future use, for example:

{
    type:credit
    amount:2.00
    account-number: 323434333
    routing-number: 333333333
    create-token: true
  }

The ach-token returns the following response:

{ 
  "ach-token": 
              {
              "account-number": "1111", 
              "account-type": "Checking", 
              "created": "1100000000000000", 
              "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" 
              }, 
              "payloadType": "string" 
}

The following table describes the response body fields:

Name	Data type	Description
account-number	String	The bank account number.
account-type	String	The type of bank account.
created	String	The timestamp when the token was created.
individual-name	String	The name of the individual associated with the token.
last-used	String	The timestamp when the token was last used.
merchant-id	String	The unique identifier of the merchant associated with the token.
routing-number	String	The bank routing number associated with the account.
times-used	String	The number of times the token has been used.
token-description	String	A description of the token, such as the account’s purpose.
token-id	String	The unique identifier of the token.
updated	String	The timestamp when the token was last updated.
payloadType	String	The type of payload returned in the response.

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

Code	Description
401	If the ACH token has expired or the signature does not match the token.
500	If the request is invalid—for example, if the routing number contains letters.
200	An ACH token created successfully.