Skip to main content
POST
Criar Payout
Crie e acompanhe transferências de saídas seguras do seu saldo disponível utilizando as chaves PIX de destino cadastradas em território brasileiro.

Autorização

string
required
Use o Basic Auth codificado em 64 das suas chaves de produção.

Body

integer
required
Somas totais a retirar em centavos sem pontuação (Min: R$1,00 - 100).
string
required
Documentação/chave da conta recebedora do Bacen. Pode ser Email, CPF/CNPJ ou UUID.
string
required
Determina de que formato é a pixKey. Valores suportados:
  • CPF
  • CNPJ
  • EMAIL
  • PHONE
  • EVP (Chave Aleatória)
string
required
Identificador unívoco do seu lado para alinhar recibos. Recomendação: GUIDV4.
string
Um end-point configurado do seu lado para ouvir mudanças até que o saco atinja COMPLETED ou FAILED.
string
O nome da pessoa que receberá na conta bancária (Aprovado durante o KYC do DICT - Diretório de contatos PIX). Opcional.
string
Opcional. Caso o recebedor possua empresa associada ao destino do saque.

Response

A rota retornará o estado inicial da transferência. Como o saque bancário depende da grade horária do SPB, geralmente a resposta nasce como PENDING ou PROCESSING.

Erros de Validação Comuns (4xx):

  • Insufficient Funds (400): A sua conta, descontando os bloqueios ou saques previstos, não possui o amount para a transferência se concretizar.
  • Invalid Key (422): A formatação da chave falhou antes de ser encaminhada ao DICT para varredura.
Lembre-se de verificar sempre em nossos Webhooks para automatizar o reflexo do saque retornado de falha na carteira do seu painel e devolver o saldo virtual de volta.