Cobrança PIX (BRL)

Documentação da API · Zypher Global

Gerar credenciais

POST /cashin · "currency": "BRL"

Rota única para todas as moedas, a moeda é definida pelo campo currency (padrão BRL). O campo amount decide o MODO: com amount = cobrança DINÂMICA (valor fixo por cobrança); sem amount = sua CHAVE PIX FIXA (valor aberto, o pagador escolhe quanto).

Cobrança dinâmica (por valor)

Envie o amount → devolvemos um QR PIX de VALOR FIXO para AQUELE pagamento. Cada cobrança é única e some depois de paga/expirada. É o fluxo do dia a dia (checkout, pedido único).

Body
{
  "currency": "BRL",
  "amount": 123.45,
  "name": "Cliente Pix",
  "document": "12345678900",
  "description": "Pedido #123",
  "external_id": "PEDIDO-123",
  "webhook_url": "https://seusistema.com/webhooks/zypherglobal",
  "splits": [
    { "username": "usuario1", "percentage": 10 },
    { "username": "usuario2", "percentage": 5 }
  ]
}
Resposta
{
  "ok": true,
  "qr_img": "data:image/png;base64,...",
  "copyPaste": "000201...",
  "code": "...",
  "request_number": "pr_...",
  "transaction_id": "pr_..."
}

Consulte depois pelo request_number (um pagamento só). Veja Consultar Transações.

Chave PIX fixa (valor aberto · estática)

Chame a MESMA rota /cashin SEM o campo amount → devolvemos um QR de VALOR ABERTO (o pagador escolhe quanto pagar). CADA chamada gera um QR NOVO (copy-paste próprio) amarrado ao external_id que VOCÊ envia. Autenticação, KYC e conta são os mesmos do cash-in normal.
Body
{
  "currency": "BRL",
  "external_id": "PEDIDO-123",
  "webhook_url": "https://seusistema.com/webhooks/zypherglobal",
  "splits": [
    { "username": "usuario1", "percentage": 10 }
  ]
}
Resposta
{
  "ok": true,
  "static": true,
  "open_value": true,
  "external_id": "PEDIDO-123",
  "copyPaste": "00020126580014br.gov.bcb.pix...",
  "qr_url": "https://quickchart.io/qr?text=...",
  "transaction_id": "acc000094602601"
}
  • O external_id é SEU (você envia, a gente NÃO gera). Fica amarrado ao QR e volta no webhook. Como cada chamada gera um QR novo, gere UM por pedido → rastreio por pedido.
  • Reutilizou o MESMO QR em vários pagamentos? Todos voltam com o MESMO external_id, reconcilie pelo e2e (único por pagamento). O crédito é sempre individual (trava anti-duplicidade pelo e2e).
  • O campo origin: "static" distingue este fluxo do QR dinâmico no webhook.

Revende pros seus próprios clientes? O external_id é o pedido do SEU sistema, o valor cai no seu saldo e você repassa o webhook pro cliente final.

Splits, webhook e consulta funcionam igual nos dois modos: Splits (repasse) · Webhooks · Consultar Transações.
AnteriorSandbox Próximo Cobrança SPEI (MXN)
Esta página foi útil?