Retiro BR Code

Documentación de la API · Zypher Global

Generar credenciales

POST /cashout · pix_copia_cola

Mismo endpoint que el cash-out por clave (POST /cashout), en lugar de informar pix_key/pix_type, envía el pix_copia_cola (BR Code / EMV) que será PAGADO. No requiere PIN (la API se autentica con la clave). Siempre en BRL.

Elegibilidad: disponible solo para cuentas habilitadas para BR Code (el permiso pix_qr_enabled). De lo contrario la API devuelve Retiro por BR Code no disponible para esta cuenta. (403). También requiere KYC verificado, el permiso cashout, IP autorizada y cash-out activo.
Body
{
  "currency": "BRL",
  "pix_copia_cola": "00020126580014br.gov.bcb.pix0136...5204000053039865802BR6304ABCD",
  "amount": 250.00,
  "description": "Pagamento fornecedor",
  "webhook_url": "https://seusistema.com/webhooks/zypherglobal"
}
Campo pix_copia_cola, acepta los alias brcode, emv, qrcode. Valor: si el BR Code es ESTÁTICO (valor fijo incrustado), se usa ese valor; si además envías amount y difiere del valor fijo, la solicitud es RECHAZADA (422 — El valor informado difiere del valor fijo del BR Code.). Si el BR Code es DINÁMICO (sin valor incrustado), envía amount.
Respuesta
{ "ok": true, "e2e": "E20251124...", "transaction_id": "...", "fee": 2.5, "amount": 250, "status": "pending", "currency": "BRL" }
Errores: proveedor no elegible (403); KYC/permiso/IP ausentes (403); valor distinto del BR Code estático (422); saldo insuficiente; BR Code inválido/expirado.
AnteriorRetiro PIX (clave) Siguiente Retiro SPEI (MXN)
¿Esta página fue útil?