Skip to main content

​
Base URL (produção)

TODO: URL de sandbox — se existir, documente aqui após confirmação com a equipe.

​
Headers

​
Datas e fusos

Use ISO 8601 / RFC 3339 em UTC, por exemplo: 2026-04-01T12:00:00.000Z.

​
Valores monetários

  • Requisições (request): valores em reais (BRL) com campo numérico típico value ou refundValue (número em ponto flutuante, conforme exemplos oficiais).
  • Respostas (response): com frequência em centavos — por exemplo valueCents, refundValueCents — para evitar erro de ponto flutuante.
Mantenha essa regra em parsers e testes: não compare float de BRL com campo em centavos sem conversão explícita.

​
Códigos HTTP

​
Listagens: paginação e filtros (padrão documentado)

GET de listas usam página e limite (máximo 100), e filtros de data inclusivos em YYYY-MM-DD como start_date / end_date onde a rota suportar. Filtros de status documentados variam por recurso; estados adicionais podem surgir no detalhe GET .../{id} (ex.: DISPATCHED, PROVIDER_RESULT_UNKNOWN).

​
Envelope de erro (típico)

Detalhes e troubleshooting: Tratamento de erros.

​
Referência cruzada