Status codes and errors are communicated in the status_code, status, and errors fields.
- Endpoint-specific status codes are documented in the description for each individual endpoint and have one of these two formats:
[3-digit-prefix]-xx[4-digit-prefix]-xx
- Status codes that are used across endpoints are listed in the Global Response Statuses enumeration.
When the status code communicates an error, the errors list is present and is populated with one or more details about the error.
Example error response
{
"status_code": 2,
"status": "Invalid parameter(s)",
"system_timestamp": "2020-08-13 10:20:46",
"response_data": {},
"processing_time": 0.28,
"echo": {
"transaction_id": "hymteqhhj9qlyrebeb8ktmk2GEwfql",
"provider_transaction_id": "",
"provider_timestamp": null
},
"errors": [
"achAccountNo='achAccountNo' is required and cannot be empty",
"achRoutingNo='achRoutingNo' is required and cannot be empty"
]
}
<response>
<status_code>2</status_code>
<status>Invalid parameter(s)</status>
<system_timestamp>2020-08-13 10:20:08</system_timestamp>
<response_data/>
<processing_time>0.228</processing_time>
<echo>
<transaction_id>hymteqhhj9qlyrebeb8ktmk2GEwfql</transaction_id>
<provider_transaction_id/>
<provider_timestamp/>
</echo>
<errors>
<error>achAccountNo='achAccountNo' is required and cannot be empty</error>
<error>achRoutingNo='achRoutingNo' is required and cannot be empty</error>
</errors>
</response>