Tratamento de Erros

A API KorvoPay segue o padrao RFC 7807 (Problem Details for HTTP APIs) para retornar erros.

Formato de Erro

Exemplo de Erro (400 Bad Request)json

{
  "type": "https://korvopay.com/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Os dados fornecidos sao invalidos.",
  "instance": "/api/v1/transactions/create",
  "errors": [
    {
      "field": "amount",
      "message": "O valor deve ser maior que zero."
    }
  ],
  "traceId": "00-abc123-def456-00"
}

Campos do Erro

Campo	Tipo	Descricao
`type`	string	URI que identifica o tipo de erro
`title`	string	Titulo legivel do erro
`status`	number	Codigo HTTP do erro
`detail`	string	Descricao detalhada do erro
`instance`	string	Endpoint que gerou o erro
`errors`	array	Lista de erros de validacao (quando aplicavel)
`traceId`	string	ID para rastreamento do erro

Codigos de Status HTTP

400

Bad Request

Requisicao invalida. Verifique os parametros enviados.

401

Unauthorized

Credenciais ausentes ou invalidas.

403

Forbidden

Acesso negado ao recurso.

404

Not Found

Recurso nao encontrado.

429

Too Many Requests

Limite de requisicoes excedido.

500

Internal Server Error

Erro interno do servidor.