Skip to content

Error Handling ​

HTTP Status Codes ​

CodeDescription
200Success
202Accepted — pending approval (antifraud)
400Bad Request — invalid or missing parameters
401Unauthorized — invalid or expired token
402Payment Required — tenant suspended/restricted by billing (ACCOUNT_SUSPENDED / ACCOUNT_RESTRICTED)
403Forbidden — access denied or blocked by antifraud
404Not Found
405Method Not Allowed
429Too Many Requests — rate limit exceeded
500Internal Server Error
503Service Unavailable

Error Response Formats ​

Most business/validation failures return a body with message and the corresponding HTTP status:

json
{
  "message": "Detailed error description"
}

Gateway-level errors (tenant validation, billing, antifraud) add a stable error identifier — use it for programmatic handling:

json
{
  "error": "MISSING_CLIENT_ID",
  "message": "Client ID (x-client-id) is required"
}

There is no proprietary E##### error-code catalogue — handle errors by HTTP status and, when present, the error field.

Gateway (tenant validation) Errors ​

HTTPerrorCauseSolution
400MISSING_CLIENT_IDTenant not identified — the Bearer token alone is not enoughSend x-client-id: <your Client_ID> on every call (details)
402ACCOUNT_SUSPENDED / ACCOUNT_RESTRICTEDTenant billing status blocks the operationSettle outstanding invoices
403PRODUCT_NOT_ENABLEDProduct family (BANKING / CRYPTO / KYC / …) not enabledContact support
403OPERATION_NOT_ALLOWEDTenant restricted to a subset of operations (e.g. PIX only)Contact support
403TRANSACTION_BLOCKEDBlocked by antifraudContact support with the returned antifraudId
202TRANSACTION_PENDING_APPROVALHeld for manual antifraud approval (not an error)Wait; response carries antifraudId and pendingExpiresAt

Common Errors ​

ErrorCauseSolution
Invalid tokenExpired or revoked Bearer tokenRe-authenticate via /access-token
Account not foundInvalid account ID or documentVerify account exists and is active
Insufficient fundsAccount balance too lowCheck balance before transfer
Duplicate transactionSame Idempotency-Key reusedUse a new UUID
Rate limit exceededToo many requestsImplement exponential backoff
Tenant suspendedBilling issue on tenantContact support