Response Codes
In response to any command, the ACHQ API will return a JSON formatted response indicating whether the command succeeded or failed and any additional information necessary to interpret the response. The following table defines the field values that will be returned in every response and their meaning:
Response Template
| Field Name | Description | Values |
|---|---|---|
| CommandStatus | Indicates the success or failure of the API request | - Approved - Declined - Error |
| ResponseCode | A 3 digit code indicating API success or reason for failure | Refer to Response Code Definitions |
| Description | Description of the ResponseCode value | Refer to Response Code Definitions |
| ErrorInformation | Additional information to help determine the source of an error. | Refer to Response Code Definitions |
| ResponseData | Please see the documentation for the specific endpoint to be issued for an explanation of the possible value(s) for this field. | This is a generic object that can take the form of any scalar or complex object called for by the command that is issued. |
| ACHQToken | A unique token that can be used to represent the supplied bank routing and account information on any future payments. | A token will only be generated if directed requested on the Create_ACHQToken parameter |
| Transact_ReferenceID | A unique ID assigned by ACHQ to each API event | This value can be used as a unique transaction identifier |
| Provider_TransactionID | This value is provided by your platform with each API call | An external ID which can be used for traceability between your application and ACHQ |
Response Code Definitions
| Response Code | Description |
|---|---|
| 0 | Request Successful. Approved. |
| 100 | Invalid Gateway Credentials |
| 101 | Invalid Gateway Command |
| 102 | Duplicate Command Not Processed |
| 103 | Transaction Cannot Be Modified |
| 104 | Batch Cannot Be Modified |
| 105 | Invalid Transact_ReferenceID |
| 106 | Invalid BatchID |
| 107 | Non-Unique Reference/Transaction ID |
| 108 | Invalid Reference/Transaction ID |
| 109 | Invalid Source IP |
| 110 | Invalid Value In Message |
| 150 | Required Field Missing |
| 151 | Field Value Is Not Valid |
| 152 | Field Value Exceeds Maximum Length |
| 209 | Invalid Routing Number |
| 210 | Invalid Bank Account Number |
| 212 | Invalid ACHQToken |
| 300 | Transaction was Declined by Processor |
| 301 | Transaction was Rejected by Gateway |
| 304 | Invalid Account Type |
| 305 | Account Closed |
| 306 | Account Inactive |
| 600 | Internal Gateway Error |
| 601 | Internal Processor Error |
| 603 | Communication Error with Processor |
| 604 | Processor Feature Not Available |
| 605 | Processor Format Error |
| 607 | Merchant Not Setup |
| 608 | Merchant Account is Inactive |
| 609 | Invalid Merchant Configuration |