Skip to main content

​
Módulo Pix Out (v2)

A API v2 oferece um fluxo de transferências Pix Out (cash-out) para envio de valores a outras chaves Pix.
A API de Pix Out exige um IP fixo e seguro de origem para as requisições. Chamadas originadas de IPs desconhecidos ou não autorizados serão bloqueadas.
Pix Out para qualquer chave Pix é uma funcionalidade de Banking as a Service (BaaS) e precisa ser habilitada explicitamente. Por padrão, sua conta só está autorizada a solicitar transferências Pix Out para a própria chave Pix.
  1. Criar transferência Pix Out
  2. Listar transferências Pix Out
  3. Consultar transferência Pix Out por ID
  4. Cancelar transferência Pix Out pendente

​
Tipos de chave Pix suportados

  • CPF — 11 dígitos
  • CNPJ — 14 dígitos
  • EMAIL — endereço de e-mail válido
  • PHONE — número com 10-15 dígitos (opcionalmente com +)
  • EVP — chave aleatória (UUID)

​
Status possíveis

StatusDescrição
pendingTransferência criada, aguardando processamento
in_analysisEm análise pelo provedor
processingSendo processada
paidTransferência concluída com sucesso
rejectedRejeitada pelo provedor
cancelledCancelada pelo usuário
errorErro no processamento
unknownStatus desconhecido ou não mapeado
Transferências em status error devem ser reportadas ao suporte para reconciliação. Se a transferência falhou, ainda pode ser atualizada para cancelled ou paid caso tenha sido efetivada.

​
Notificações via webhook

A API envia webhooks automaticamente a cada mudança de status da transferência. Consulte a seção Webhooks de Transferência para detalhes sobre estrutura, tipos de evento e exemplos de payload.
Com esses quatro endpoints, você cobre o ciclo completo de cash-out via Pix.