Cobro PIX (BRL)

Documentación de la API · Zypher Global

Generar credenciales

POST /cashin · "currency": "BRL"

Ruta única para todas las monedas, la moneda se define por el campo currency (por defecto BRL). El campo amount decide el MODO: com amount = cobro DINÁMICO (valor fijo por cobro); sem amount = tu CLAVE PIX FIJA (valor abierto, el pagador elige cuánto).

Cobro dinámico (por valor)

Envía el amount → devolvemos un QR PIX de VALOR FIJO para ESE pago. Cada cobro es único y desaparece tras pagarse/expirar. Es el flujo del día a día (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 }
  ]
}
Respuesta
{
  "ok": true,
  "qr_img": "data:image/png;base64,...",
  "copyPaste": "000201...",
  "code": "...",
  "request_number": "pr_...",
  "transaction_id": "pr_..."
}

Consulta luego por el request_number (un solo pago). Ver Consultar Transacciones.

Clave PIX fija (valor abierto · estática)

Llama a la MISMA ruta /cashin SIN el campo amount → devolvemos un QR de VALOR ABIERTO (el pagador elige cuánto pagar). CADA llamada genera un QR NUEVO (copy-paste propio) vinculado al external_id que TÚ envías. Autenticación, KYC y cuenta son los mismos del cash-in normal.
Body
{
  "currency": "BRL",
  "external_id": "PEDIDO-123",
  "webhook_url": "https://seusistema.com/webhooks/zypherglobal",
  "splits": [
    { "username": "usuario1", "percentage": 10 }
  ]
}
Respuesta
{
  "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"
}
  • El external_id es TUYO (tú lo envías, nosotros NO lo generamos). Queda vinculado al QR y vuelve en el webhook. Como cada llamada genera un QR nuevo, genera UNO por pedido → rastreo por pedido.
  • ¿Reutilizaste el MISMO QR en varios pagos? Todos vuelven con el MISMO external_id, concilia por el e2e (único por pago). El crédito siempre es individual (bloqueo anti-duplicados por el e2e).
  • El campo origin: "static" distingue este flujo del QR dinámico en el webhook.

¿Revendes a tus propios clientes? El external_id es el pedido de TU sistema, el valor entra en tu saldo y tú retransmites el webhook al cliente final.

Splits, webhook y consulta funcionan igual en los dos modos: Splits (reparto) · Webhooks · Consultar Transacciones.
AnteriorSandbox Siguiente Cobro SPEI (MXN)
¿Esta página fue útil?