Saques
Pedir saque
Manda o saldo disponível por Pix para a chave que você envia no pedido (SAQ-API-).
POST
Escopo
withdrawals:write, 2FA ligado na conta e IP liberado na chave de API. O saque vai para a chave Pix que você manda no pedido (destination) ou para o recebedor de um Pix Copia e Cola (copyPaste), só um dos dois. Não precisa cadastrar a chave antes. Limite de 20 pedidos por minuto.
string
required
8 a 128 caracteres, única por saque. Repetir com os mesmos dados devolve o mesmo saque.
integer
required
Valor em centavos que chega na chave. A tarifa sai além desse valor (
total). A partir do mínimo da conta (BELOW_MINIMUM).object
A chave Pix que vai receber. Sem
destination e sem copyPaste: 422 DESTINATION_REQUIRED.string
Pix Copia e Cola: o saque vai para a chave do código. Se o código tem valor,
amount precisa ser igual (AMOUNT_MISMATCH).string
Até 140 caracteres, para o seu extrato.
Resposta
string
SAQ-API- + 12.string
processing (em andamento). Depois: completed, failed ou rejected.integer
O que chega na chave.
integer
Tarifa.
integer
amount + fee, o que saiu do saldo.string
api.object
string | null
Identificador do Pix, preenchido quando concluído.
string | null
Motivo quando
failed ou rejected.string
Pedido.
string | null
Conclusão.
Se você tem subcontas, o que é delas não sai no seu saque: passando disso,
422 SUBACCOUNT_FUNDS (a mensagem diz quanto dá para sacar). GET /v1/balance mostra subaccounts e free.