Portal do desenvolvedor

Documentação, exemplose status da API em um só lugar

Tudo o que o seu time técnico precisa para integrar pagamento em lote, conciliação e comprovantes à sua aplicação, com exemplos prontos de request e response.

REST e JSON
Sandbox
Webhooks assinados

Ver status da API

Comece agora

Do sandbox ao primeiro lote em minutos

Gere as chaves de sandbox no painel, envie um lote de teste e acompanhe o resultado por webhook. Nenhum dado de produção é usado no ambiente de testes.

Ler a documentação Status da API

Requestbash

curl -X POST https://api.unificapay.com.br/v1/batches \
  -H "Authorization: Bearer sk_sandbox_2f8c..." \
  -H "Idempotency-Key: primeiro-lote" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "teste-integracao",
    "payments": [
      { "amount": 1000, "pix_key": "teste@unificapay.com.br", "external_id": "t-1" }
    ]
  }'

201 Createdjson

{
  "id": "bat_sandbox_01",
  "status": "processing",
  "total_amount": 1000,
  "payments_count": 1
}

Documentação

Guias organizados por tema

Cada guia traz o conceito, as regras de uso e exemplos completos de request e response.

Primeiros passos

Ambientes, chaves e sua primeira chamada autenticada.

1 exemplo

Autenticação

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

1 exemplo

Pagamentos em lote

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

2 exemplos

Conciliação e comprovantes

Extrato conciliado e download de comprovantes em PDF.

2 exemplos

Webhooks

Eventos em tempo real com assinatura HMAC.

2 exemplos

Erros e limites

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

1 exemplo

Referência sempre atualizada

Mudanças de contrato são versionadas e comunicadas com antecedência mínima de 60 dias.

Sandbox completo

Simule liquidação, falha de chave Pix e reenvio de webhook sem mover dinheiro real.

Transparência de disponibilidade

Histórico de incidentes e uptime por serviço na página de status.