Como integrar com a API

Visao geral

A API UzePay permite abrir contas, consultar saldo e extrato, criar chaves Pix, enviar pagamentos, emitir boletos, acompanhar eventos e receber notificacoes. As rotas seguem o mesmo contrato em sandbox e producao; o ambiente usado e definido pelo certificado enviado na chamada.

Autenticacao

Toda chamada autenticada usa mTLS e Bearer Token. O certificado identifica o ambiente e a credencial autorizada. O token informa o usuario, os escopos permitidos e o tempo de validade. Para endpoints que operam em uma conta especifica, envie tambem x-account-id.

Headers principais

Use Authorization: Bearer <token>, Content-Type: application/json e x-account-id quando a rota exigir contexto de conta. Para chamadas idempotentes, mantenha o mesmo identificador na URL ao repetir uma tentativa.

Formato de resposta

Respostas de sucesso retornam status_code, success, message e data. Erros retornam status_code, message, timestamp, path e, quando disponivel, details para ajudar a corrigir a requisicao.

Webhooks

Webhooks sao enviados como JSON. Grave o identificador do evento antes de processar para evitar duplicidade. Responda com HTTP 2xx apenas quando o evento tiver sido recebido com sucesso. Se precisar reprocessar, use o identificador original.

Base URL

https://uzepay-mtls.deploy.pixland.com.br

Exemplo de erro

{
  "status_code": 400,
  "message": "A requisicao apresenta dados invalidos.",
  "timestamp": "2026-05-07T10:30:00.000Z",
  "path": "/hb/accounts/individual",
  "details": [
    { "resource": "INVALID_INPUT" }
  ]
}