ReloadBankDocs
Criar conta

Checkout

Links de pagamento

Um link de pagamento é uma página de checkout PIX hospedada pela Reload Bank, com valor fixo, que você pode enviar por WhatsApp, e-mail ou redes sociais — sem precisar integrar a criação de cobranças. Cada pagamento gera uma transação PIX_IN na sua conta.
POST/api/v1/payment-links
GET/api/v1/payment-links

Criar link

Parâmetros do corpo

CampoTipoObrigatórioDescrição
titlestringSimNome do produto ou serviço exibido no checkout (3–80 caracteres).
descriptionstringNãoTexto exibido abaixo do título (até 500 caracteres; quebras de linha são preservadas).
amountnumberSimValor fixo em reais, até 2 casas decimais. Mínimo R$ 5,00 e máximo R$ 50.000,00.
methodsstring[]NãoMeios aceitos. Hoje o único disponível é pix (padrão ["pix"]); outros valores retornam 422 method_unavailable.

Retorna 201 Created com o objeto Link de pagamento. Erros de validação retornam 422 validation_error; contas que ainda não estão ativas recebem 403 account_pending.

Listar links

GET /payment-links não recebe parâmetros e retorna { data: [...] } com os 100 links mais recentes da conta (ativos e inativos), do mais novo para o mais antigo. Não há paginação.

Objeto Link de pagamento

CampoTipoObrigatórioDescrição
idstringSimIdentificador do link. Aparece como payment_link_id nas transações geradas.
urlstringSimEndereço público do checkout: https://reloadbank.app/c/{slug}. É o link que você compartilha com o comprador.
titlestringSimTítulo exibido no checkout.
descriptionstring | nullSimDescrição exibida no checkout.
amountnumberSimValor em reais.
methodsstring[]SimMeios aceitos — hoje sempre ["pix"].
max_installmentsintegerSimSempre 1 (parcelamento não se aplica ao PIX).
activebooleanSimSe o link aceita pagamentos. Links são criados ativos e podem ser desativados pelo dashboard.
created_atstringSimData de criação (ISO 8601, UTC).

Página de checkout

Ao abrir a url, o comprador vê o nome da sua empresa, o título, a descrição e o valor, informa nome, e-mail e CPF/CNPJ e recebe o QR Code e o PIX copia e cola (validade padrão de 1 hora). A página acompanha o pagamento e confirma assim que o PIX é recebido.

  • Cada pagamento cria uma transação PIX_IN, com as mesmas regras, taxas e status das criadas pela API.
  • Elas trazem payment_link_id com o id do link, description igual ao título do link e payer com os dados informados pelo comprador. external_id e metadata ficam null.
  • Os webhooks dessas transações são enviados para a URL de webhooks da conta (não há postback_url por link).
  • Links inativos, ou de contas que não estão ativas, exibem a página “Link indisponível”.

Conciliando vendas de um link

Use o campo payment_link_id recebido no webhook transaction.paid para identificar qual link originou a venda. Exemplo de transação gerada por um link:

Webhook de uma venda via link
{
  "event": "transaction.paid",
  "data": {
    "id": "cm2r8x1qz0004lk08abcd1234",
    "external_id": null,
    "type": "PIX_IN",
    "status": "PAID",
    "amount": 497,
    "fee": 5.72,
    "net_amount": 491.28,
    "description": "Curso de Fotografia",
    "pix": {
      "txid": "K7Q2M9X4T1B8N6R3W5Z0C2V7H",
      "end_to_end_id": "E00000000202610161432K8D2LQ7ZP1M",
      "qr_code": "00020101021226580014br.gov.bcb.pix013600000000-0000-0000-0000-0000000000005204000053039865406100.005802BR5912LOJA EXEMPLO6009SAO PAULO62290525K7Q2M9X4T1B8N6R3W5Z0C2V7H63040000",
      "expires_at": "2026-10-16T15:30:00.000Z"
    },
    "checkout_url": "https://reloadbank.app/pay/cm2r8x1qz0004lk08abcd1234",
    "payer": {
      "name": "Maria Silva",
      "document": "12345678909",
      "email": "[email protected]"
    },
    "failure_reason": null,
    "metadata": null,
    "paid_at": "2026-10-16T14:32:11.000Z",
    "refunded_at": null,
    "created_at": "2026-10-16T14:30:00.000Z",
    "updated_at": "2026-10-16T14:32:11.000Z",
    "payment_link_id": "cm2rc1m4n000flk08link6789"
  },
  "created_at": "2026-10-16T14:32:11.204Z"
}

Dica

Para liberar o acesso ao produto automaticamente, trate o webhook transaction.paid filtrando por data.payment_link_id.
Criar link
curl -X POST "https://reloadbank.app/api/v1/payment-links" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Curso de Fotografia",
  "description": "Acesso vitalício às 24 aulas + certificado.",
  "amount": 497,
  "methods": [
    "pix"
  ]
}'
Resposta
{
  "id": "cm2rc1m4n000flk08link6789",
  "url": "https://reloadbank.app/c/k3v9qpz2mx",
  "title": "Curso de Fotografia",
  "description": "Acesso vitalício às 24 aulas + certificado.",
  "amount": 497,
  "methods": [
    "pix"
  ],
  "max_installments": 1,
  "active": true,
  "created_at": "2026-10-16T12:00:00.000Z"
}
Listar links
curl -X GET "https://reloadbank.app/api/v1/payment-links" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Resposta da listagem
{
  "data": [
    {
      "id": "cm2rc1m4n000flk08link6789",
      "url": "https://reloadbank.app/c/k3v9qpz2mx",
      "title": "Curso de Fotografia",
      "description": "Acesso vitalício às 24 aulas + certificado.",
      "amount": 497,
      "methods": [
        "pix"
      ],
      "max_installments": 1,
      "active": true,
      "created_at": "2026-10-16T12:00:00.000Z"
    }
  ]
}