Pular para o conteúdo principal

Formato das requisições e erros

Corpo e content-type

  • Envie e receba dados em JSON com Content-Type: application/json, salvo indicação contrária (ex.: upload futuro).

Placeholders nos exemplos

Nesta documentação usamos:

PlaceholderSignificado
{{BASE_URL}}Ex.: https://paychain-api.onrender.com (sem / no final)
{{TOKEN}}JWT retornado por POST /auth/login
REFERENCEIdentificador da ordem retornado na criação

Substitua pelos valores reais do seu ambiente.

Erros

Em falhas de validação ou regras de negócio, a API tende a responder com status 4xx ou 5xx e um corpo JSON com mensagem de erro legível. Trate sempre o status HTTP e, se disponível, o corpo para logs e retry idempotente onde aplicável.

Idempotência

Para criação de ordens, cada chamada gera uma nova ordem (novo reference), salvo se você implementar deduplicação no seu sistema. Para submit-tx, consulte a referência do endpoint: envios repetidos com o mesmo contexto podem ser rejeitados conforme estado da ordem.