Pular para o conteúdo principal

Visão geral da API

Base: https://seventyonepay.online/api/v1

Envelope de resposta​

Toda resposta tem o mesmo formato.

Sucesso:

{
  "success": true,
  "data": { }
}

Erro:

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Um ou mais campos são inválidos.",
    "details": {
      "fields": [{ "field": "customer.email", "message": "E-mail inválido." }]
    }
  }
}

Use o campo error.code (estável) para decidir o que fazer; a message é para leitura humana e pode mudar. Veja a lista de códigos.

Convenções​

  • Valores monetários em centavos (inteiros). R$ 19,90 → 1990. Moeda: BRL.
  • Datas em ISO 8601, UTC.
  • IDs são UUIDs.
  • Corpo em JSON com Content-Type: application/json, no máximo 256 KB.
  • Campos desconhecidos em corpos de criação são rejeitados (422). Envie só o que está documentado.
  • Respostas não são armazenadas em cache (Cache-Control: no-store).
  • Operações de criação usam idempotência; listagens usam paginação.

Dados do pagador​

Por privacidade, a API não devolve nome nem documento do pagador nas consultas de PIX (payer_name e payer_document vêm null, e payer_masked vem true). Guarde no seu sistema os dados do cliente que você enviou na criação da cobrança.

Especificação OpenAPI​

GET /openapi.json devolve a especificação OpenAPI 3.1, gerada a partir do código da API, sempre em sincronia com o que está em produção.