Docs
Saques e saldo

Visão geral de saques e saldo

Como o dinheiro sai da sua conta Accelerazione por Pix, como consultar saldo e extrato, e as diferenças em relação à API de cobranças.

A API de saques transfere dinheiro da sua conta Accelerazione para uma chave Pix. A API de extrato mostra o saldo e as movimentações das contas. Juntas, elas fecham o ciclo: você recebe com cobranças, acompanha o saldo e saca.

Fluxo do dinheiro: cobranças pagas entram no saldo disponível; o saque reserva o valor e passa por análise; aprovado, vira Pix para a chave de destino; recusado, cancelado, expirado ou com falha, o valor volta ao saldo. Seu servidor consulta saldo e extrato e acompanha o saque pela API

Antes de começar

Valores de saque e de extrato seguem a mesma regra das cobranças: inteiros em centavos. 1990 é R$ 19,90 em toda a API.

CobrançasSaquesExtrato
NotificaçãoWebhookNão tem; consulteNão tem; consulte
Formato de erroProblem Details, código em typeProblem Details, código em typeerror, message, retryable

O que você precisa

  1. Permissões na chave de API: withdrawals para saques e bank-accounts para extrato. Peça à equipe de integração.
  2. O accountId da sua conta, um UUID entregue no credenciamento. É a conta de onde sai o saque.
  3. A chave Pix de destino cadastrada. Por padrão, o saque só vai para a chave Pix registrada como destino de saque da sua conta.
  4. Os IPs de saída do seu servidor, se a sua conta usar lista de IPs permitidos nas rotas de saque.

Ambientes

Saques e extrato estão disponíveis somente em produção. O sandbox não expõe essas rotas: uma chamada lá responde 404. Combine com a equipe de integração como homologar o fluxo, normalmente com saques de valor baixo em produção.

Como um saque anda

  1. Você pede o saque. A API confere o saldo disponível, reserva o valor e responde 201 com status: "processando".
  2. O saque passa por uma análise. Não há prazo garantido para essa etapa.
  3. Aprovado, o Pix é enviado à chave de destino e o saque fica transferido, com o identificador do Pix (pixEndToEndId).
  4. Se o saque for rejeitado, cancelado, expirar ou falhar, o valor reservado volta ao saldo.

Não há webhook de saque. Acompanhe pela consulta.

Nesta seção

Nesta página