Response Codes
Status Codes
COS uses standard HTTP response codes to communicate the result of a request. In general, the codes indicate:
- 1xx informational response – the request was received, continuing process
- 2xx successful – the request was successfully received, understood, and accepted
- 3xx redirection – further action needs to be taken in order to complete the request
- 4xx client error – the request contains bad syntax or cannot be fulfilled
- 5xx server error – the server failed to fulfil an apparently valid request
The following table explains some specific status codes.
HTTP Code | Description |
---|---|
200 | Success |
202 | We have accepted the request, but we need more time to process it. |
400 | There is something wrong with the data in your request, or the request cannot be processed |
401 | There is an issue with your API access token |
403 | Your token is good, but you don't have permission to do what is being requested |
404 | The resource specified does not exist |
409 | The resource is in a conflicted state, most likely due to simultaneous operations being performed. Your request should be retried. |
429 | Too many requests are being sent. Slow down and go easy on us :) |
500 | Technical difficulties on our end |
Errors
If something goes wrong, we will return a consistent error object in the response:
{
"Errors":[
{
"Code":1000,
"Message":"First name required"
},
{
"Code":1000,
"Message":"Last name required"
},
]
}
Error Code Range | Description |
---|---|
1000-1999 | Validation issue (e.g. required field missing) |
2000-2999 | Rule violation (e.g. trying to add funds to an account that is closed) |
3000-3999 | Security Issue with token or permissions |
9999 | System issue (e.g. something on our end went wrong) |
Each API reference section contains a full list of errors codes for that specific API under the list of meta operations. For example, to see the possible error codes for ACH you would use:
https://sandbox.crbcos.com/ach/swagger/ui/index#!/Meta32Data/MetaData_GetErrors.
Request ID
In the response header of every request, is a Request-ID value. This is a unique identifier for your request and is useful when troubleshooting issues with our support team. It is recommended you log this identifier.
Updated 4 months ago