Saque BR Code
Documentação da API · Zypher Global
Introdução
Autenticação
Sandbox
Cobrança PIX (BRL)
Cobrança SPEI (MXN)
Cobrança USDT
Saque PIX (chave)
Saque BR Code
Saque SPEI (MXN)
Saque USDT
Splits (repasse)
Consultar Saldo
Converter Moeda
Consultar Transações
Webhooks
Tratamento de erros
POST /cashout · pix_copia_cola
Mesmo endpoint do cash-out por chave (POST /cashout), em vez de informar pix_key/pix_type, envie o pix_copia_cola (BR Code / EMV) que será PAGO. Não exige PIN (a API é autenticada pela chave). Sempre em BRL.
Elegibilidade: disponível apenas para contas habilitadas para BR Code (permissão
pix_qr_enabled). Caso contrário a API retorna Saque por BR Code não disponível para esta conta. (403). Também exige KYC verificado, permissão cashout, IP autorizado e cash-out ativo.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, aceita os apelidos brcode, emv, qrcode. Valor: se o BR Code for ESTÁTICO (valor fixo embutido), esse valor é usado; se você também enviar amount e ele divergir do valor fixo, a requisição é RECUSADA (422 — O valor informado difere do valor fixo do BR Code.). Se o BR Code for DINÂMICO (sem valor embutido), envie amount.Resposta
{ "ok": true, "e2e": "E20251124...", "transaction_id": "...", "fee": 2.5, "amount": 250, "status": "pending", "currency": "BRL" }Erros: provider inelegível (
403); KYC/permissão/IP ausentes (403); valor divergente do BR Code estático (422); saldo insuficiente; BR Code inválido/expirado.
Esta página foi útil?
