Skip to main content
We use standard HTTP response codes to let you know the result of your request. In case of failure, we will also returns some useful information to help you troubleshoot.

​
HTTP status codes

status codestateexpect
2xxSuccessEverything is okay.
201SuccessCreated. The resource is created.
202SuccessAccepted. The request is being handled, do not expect response. You may receive a callback.
304SuccessNot modified. When handling idempodent requests, we may return 304 if the request is duplicated.
400FailureBad request. Review the request body. We will try to explain the bad details in the response.
401FailureUnauthorized. Authenticate with access token.
402FailurePayment required. Your subscription requires a high tier.
403FailureForbidden. Either the resource access is denied or your access token expired.
404FailureNot found. Either the resource of a dependency is not found.
409FailureNot found. Either the resource of a dependency is not found.
429FailureConflict. The request looks good, but we have an issue handling the request.
500CriticalWe are sorry. It’s on us. We have an unhandled error, and staff is notified.

​
Response details

Unless we return a HTTP 2XX response, you can expect a common response object as below: 
{
    "type" : "customer not found",
    "title" : "No customer with id xxxxxxx exists.",
    "status" : "400",
    "detail" : "The customer does not exist.",
    "traceId" : "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00"
}
This response include standard guidance how to resolve the failure.

​
Tracking response

When engaging our support, please include any x-request-id and the traceId. Our API support that you add your own correlation-id using the x-request-id header. We will always return a x-trace-id.