Documentação

Autenticaçãocom exemplos prontos para copiar

A autenticação usa chave secreta no header Authorization. Cada chave tem escopos e pode ser rotacionada sem derrubar a integração.

O que você precisa saber

Chaves públicas (pk_) identificam a aplicação, chaves secretas (sk_) autorizam operações.
Escopos disponíveis: batches:write, batches:read, pix:write, statements:read, receipts:read.
Na rotação, duas chaves ficam válidas por 24 horas para migração sem downtime.

POST/v1/api-keys/rotate

Rotaciona a chave secreta

Gera uma nova chave secreta e mantém a anterior válida pelo período de transição.

Request, cURLbash

curl -X POST https://api.unificapay.com.br/v1/api-keys/rotate \
  -H "Authorization: Bearer sk_live_9a71..." \
  -H "Content-Type: application/json" \
  -d '{ "grace_period_hours": 24 }'

Response, 201 Createdjson

{
  "id": "key_5c19ab",
  "secret": "sk_live_4d02e7c9b1...",
  "scopes": ["batches:write", "batches:read", "receipts:read"],
  "previous_key_expires_at": "2026-07-28T13:04:11Z"
}

Continue explorando

Primeiros passos

Ambientes, chaves e sua primeira chamada autenticada.

Abrir

Pagamentos em lote

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

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