Documentação

Conciliação e comprovantescom exemplos prontos para copiar

Puxe o extrato já conciliado com os seus identificadores externos e recupere o comprovante de cada pagamento.

O que você precisa saber

O extrato devolve o external_id enviado na criação do lote, o que dispensa conferência manual.
Comprovantes ficam disponíveis em PDF e em JSON estruturado.
Filtros por período, conta e status com paginação por cursor.

GET/v1/statements

Lista lançamentos conciliados

Retorna os lançamentos do período com vínculo ao lote e ao identificador externo.

Request, cURLbash

curl "https://api.unificapay.com.br/v1/statements?from=2026-07-01&to=2026-07-31&limit=50" \
  -H "Authorization: Bearer sk_live_9a71..."

Response, 200 OKjson

{
  "data": [
    {
      "id": "stm_20a4c1",
      "type": "pix_out",
      "amount": -358900,
      "batch_id": "bat_71ce03",
      "external_id": "nf-10238",
      "receipt_id": "rcp_9d31f0",
      "occurred_at": "2026-07-30T13:30:04Z"
    }
  ],
  "next_cursor": "c3RtXzIwYTRjMQ=="
}

GET/v1/receipts/{id}

Recupera um comprovante

Devolve o comprovante estruturado e a URL assinada do PDF, válida por 15 minutos.

Request, cURLbash

curl https://api.unificapay.com.br/v1/receipts/rcp_9d31f0 \
  -H "Authorization: Bearer sk_live_9a71..."

Response, 200 OKjson

{
  "id": "rcp_9d31f0",
  "batch_id": "bat_71ce03",
  "payer": { "name": "Empresa Exemplo LTDA", "document": "12.345.678/0001-90" },
  "receiver": { "name": "Fornecedor XYZ", "document": "98.765.432/0001-10" },
  "amount": 358900,
  "pdf_url": "https://files.unificapay.com.br/receipts/rcp_9d31f0.pdf",
  "expires_at": "2026-07-30T13:45:04Z"
}

Continue explorando

Primeiros passos

Ambientes, chaves e sua primeira chamada autenticada.

Abrir

Autenticação

Chaves de API, escopos e rotação segura.

Abrir

Pagamentos em lote

Criação de lotes, idempotência e acompanhamento de status.

Abrir

Webhooks

Eventos em tempo real com assinatura HMAC.

Abrir

Erros e limites

Códigos de erro, retentativas e limites de uso.

Abrir