ReloadBankDocs
Criar conta

Começando

Documentação da API

A API Reload Bank permite receber pagamentos via PIX (QR Code, copia e cola e checkout hospedado), criar links de pagamento, enviar saques PIX e consultar transações e saldo — tudo com uma interface REST simples e notificações em tempo real por webhook.

JSON em tudo

Requisições e respostas em JSON (UTF-8), com campos em snake_case.

Valores em reais

Números com até 2 casas decimais: 10.5 = R$ 10,50. Nunca em centavos.

Datas ISO 8601

Sempre em UTC, ex.: 2026-10-16T14:30:00.000Z.

REST + Webhooks

Crie cobranças via API e receba a confirmação por webhook assinado.

Base URL

Todas as rotas da API são relativas à base URL abaixo e devem ser chamadas via HTTPS.

https://reloadbank.app/api/v1

O prefixo curto também é aceito: /v1/pix/cash-in é equivalente a /api/v1/pix/cash-in.

Operações reais

Não há um ambiente de testes separado: as cobranças geram PIX pagáveis em qualquer banco e os saques são liquidados pela instituição parceira, sempre com dinheiro real. Para validar a sua integração, crie uma cobrança com o valor mínimo (R$ 5,00), pague-a com a sua própria conta e confira o webhook transaction.paid — o valor, já descontada a taxa, fica no seu saldo.

Conta aprovada e 2FA

As operações financeiras exigem a conta aprovada na verificação de identidade (contas em análise recebem 403 account_pending). Saques exigem ainda a verificação em duas etapas (2FA) ativa.

Convenções

  • Envie Content-Type: application/json em requisições com corpo. Corpos acima de 64 KB são recusados com 413 payload_too_large.
  • Valores monetários (amount, fee, net_amount, saldos) são números em reais com no máximo 2 casas decimais. Envie 49.9, nunca "49,90" nem 4990.
  • Datas seguem ISO 8601 em UTC. Campos ausentes são retornados como null.
  • Erros seguem sempre o envelope { "error": { "code", "message" } } — veja Erros.

Quick start em 3 passos

  1. Gere suas credenciais

    No Dashboard, acesse a seção de credenciais de API e crie um par client_id / client_secret (a criação é confirmada com o código do 2FA). O secret é exibido uma única vez — guarde-o em um cofre ou variável de ambiente.

  2. Obtenha um access token

    curl -X POST "https://reloadbank.app/api/v1/auth/token" \
  -H "Content-Type: application/json" \
  -d '{
  "client_id": "SEU_CLIENT_ID",
  "client_secret": "SEU_CLIENT_SECRET"
}'

  3. Crie sua primeira cobrança PIX

    curl -X POST "https://reloadbank.app/api/v1/pix/cash-in" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 100,
  "external_id": "pedido-1042",
  "description": "Pedido #1042"
}'

    A resposta traz o pix.qr_code (copia e cola) e um checkout_url pronto para enviar ao cliente. Quando o pagamento cair, você recebe o webhook transaction.paid.

Continuar para Autenticação