BR Code withdrawal
API Documentation · Zypher Global
Introduction
Authentication
Sandbox
PIX charge (BRL)
SPEI charge (MXN)
USDT charge
PIX withdrawal (key)
BR Code withdrawal
SPEI withdrawal (MXN)
USDT withdrawal
Splits (pass-through)
Check Balance
Convert Currency
Query Transactions
Webhooks
Error handling
POST /cashout · pix_copia_cola
Same endpoint as the key-based cash-out (POST /cashout), instead of providing pix_key/pix_type, send the pix_copia_cola (BR Code / EMV) that will be PAID. No PIN required (the API is authenticated by the key). Always in BRL.
Eligibility: available only for accounts enabled for BR Code (the
pix_qr_enabled permission). Otherwise the API returns BR Code cash-out not available for this account. (403). It also requires verified KYC, the cashout permission, an authorized IP and cash-out enabled.Body
{
"currency": "BRL",
"pix_copia_cola": "00020126580014br.gov.bcb.pix0136...5204000053039865802BR6304ABCD",
"amount": 250.00,
"description": "Pagamento fornecedor",
"webhook_url": "https://seusistema.com/webhooks/zypherglobal"
}Field
pix_copia_cola, accepts the aliases brcode, emv, qrcode. Amount: if the BR Code is STATIC (fixed amount embedded), that amount is used; if you also send amount and it differs from the fixed amount, the request is REJECTED (422 — The amount provided differs from the BR Code fixed amount.). If the BR Code is DYNAMIC (no embedded amount), send amount.Response
{ "ok": true, "e2e": "E20251124...", "transaction_id": "...", "fee": 2.5, "amount": 250, "status": "pending", "currency": "BRL" }Errors: ineligible provider (
403); missing KYC/permission/IP (403); amount differs from the static BR Code (422); insufficient balance; invalid/expired BR Code.
Was this page helpful?
