Documentação

Pagamentos em lotecom exemplos prontos para copiar

O recurso central da Unifica. Envie a lista de pagamentos, acompanhe o processamento e receba o resultado item a item.

O que você precisa saber

Use o header Idempotency-Key para evitar lotes duplicados em caso de retentativa.
Um lote aceita até 5.000 pagamentos por requisição.
Status possíveis: created, processing, partially_paid, paid, failed.

POST/v1/batches

Cria um lote de pagamentos

Recebe a lista de pagamentos e devolve o lote com um identificador para acompanhamento.

Request, cURLbash

curl -X POST https://api.unificapay.com.br/v1/batches \
  -H "Authorization: Bearer sk_live_9a71..." \
  -H "Idempotency-Key: lote-folha-2026-07" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "folha-julho-2026",
    "scheduled_for": "2026-07-30",
    "payments": [
      {
        "amount": 358900,
        "pix_key": "financeiro@fornecedor.com.br",
        "description": "NF 10238",
        "external_id": "nf-10238"
      },
      {
        "amount": 129000,
        "pix_key": "11987654321",
        "description": "Prestador de servico",
        "external_id": "ps-4471"
      }
    ]
  }'

Response, 201 Createdjson

{
  "id": "bat_71ce03",
  "reference": "folha-julho-2026",
  "status": "processing",
  "total_amount": 487900,
  "payments_count": 2,
  "scheduled_for": "2026-07-30",
  "created_at": "2026-07-27T13:07:52Z"
}

GET/v1/batches/{id}

Consulta o lote e cada pagamento

Retorna o status consolidado do lote e o detalhamento por pagamento.

Request, cURLbash

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

Response, 200 OKjson

{
  "id": "bat_71ce03",
  "status": "partially_paid",
  "payments": [
    {
      "external_id": "nf-10238",
      "status": "paid",
      "end_to_end_id": "E1234567820260730133000abcdef",
      "receipt_id": "rcp_9d31f0",
      "paid_at": "2026-07-30T13:30:04Z"
    },
    {
      "external_id": "ps-4471",
      "status": "failed",
      "error": { "code": "pix_key_not_found", "message": "Chave Pix nao localizada" }
    }
  ]
}

Continue explorando

Primeiros passos

Ambientes, chaves e sua primeira chamada autenticada.

Abrir

Autenticação

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

Abrir

Conciliação e comprovantes

Extrato conciliado e download de comprovantes em PDF.

Abrir

Webhooks

Eventos em tempo real com assinatura HMAC.

Abrir

Erros e limites

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

Abrir