Conceitos
Erros
Formato problem+json e o catálogo de code.
Página em construção
Este é um resumo. O conteúdo completo entra nas próximas versões da documentação; o contrato de cada rota já está na Referência da API.
{
"type": "https://api.kodano.com.br/problems/auth-entitlement-missing",
"title": "Product not enabled for this credential",
"status": 403,
"detail": "Scope payments:boleto:write is not granted",
"code": "AUTH.ENTITLEMENT_MISSING",
"correlationId": "erp-7f3a-0002"
}- Toda falha volta em
application/problem+jsoncomtype,title,status,detail,code,correlationIde, em validação,errors[{ field, code, message }]. - Trate pelo
code, que é estável.titleedetailsão textos em inglês para diagnóstico. - Validação responde sempre
422 VALIDATION.FAILED; o motivo de cada campo vem emerrors[].code(VALIDATION.REQUIRED,VALIDATION.MIN,VALIDATION.FORMAT…). - Informe o
correlationIdao falar com o suporte.
| Status | code | Quando |
|---|---|---|
| 400 | MERCHANT.HEADER_REQUIRED | Credencial de organização sem X-Merchant-Id |
| 401 | AUTH.TOKEN_INVALID | Token ausente, inválido ou expirado |
| 403 | AUTH.ENTITLEMENT_MISSING | Produto não liberado para a credencial |
| 403 | AUTH.ENVIRONMENT_MISMATCH | Credencial de um ambiente no host do outro |
| 403 | MERCHANT.FORBIDDEN | Merchant fora da sua organização |
| 404 | ROUTE.NOT_FOUND | Rota inexistente ou sem /v1 |
| 409 | IDEMPOTENCY.CONFLICT | Chave reutilizada com outro corpo |
| 422 | VALIDATION.FAILED | Campo fora da regra |
| 429 | RATE_LIMIT.EXCEEDED | Limite de requisições atingido |
| 503 | AUTH.TEMPORARILY_UNAVAILABLE | Indisponibilidade temporária; repita após Retry-After |