Erros

Envelopes de erro estáveis para todos os endpoints REST.

Erros públicos retornam type, code, message segura e request_id. O request id deve ser logado por integradores e times de suporte.

Envelope de erro
{  "error": {    "type": "validation_error",    "code": "invalid_request",    "message": "Invalid request payload.",    "request_id": "req_xxx",    "issues": []  }}

Tipos de erro

CampoTipoDescrição
authentication_error401API key ausente, malformada ou inválida.
permission_error403A chave é válida, mas não tem a permissão necessária.
validation_error400Body, path ou query parameters inválidos.
idempotency_error409A Idempotency-Key foi reutilizada com outra requisição.
not_found_error404O recurso não existe no escopo da API key atual.
rate_limit_error429A integração excedeu o rate limit configurado.
configuration_error400A configuração da plataforma está incompleta para esta operação.
api_error5xxFalha inesperada da plataforma ou downstream.

Códigos comuns

CampoTipoDescrição
invalid_api_keyauthHeader Authorization ausente ou inválido.
insufficient_permissionsauthzA chave não pode executar esta ação.
invalid_requestvalidationO payload falhou na validação de schema.
raw_card_not_allowedPCIDados brutos de cartão enviados para endpoint que não tokeniza.
pricing_plan_not_configuredconfigA plataforma ainda não configurou o plano de taxas para este método/parcelamento.
idempotency_key_conflictretryA mesma chave foi usada para uma operação diferente.
internal_errorserverFalha inesperada; use request_id ao acionar suporte.