Cotar um saque
Calcula um saque sem executar nada: quanto sai, em quantos envios, qual a taxa e qual o teto do que pode ser pedido agora.
Autenticação
A sessão do painel autentica esta rota, e ela é lida de forma autoritativa: não há parâmetro em que o chamador aponte para outra conta.
Esta rota não exige escopo nomeado — o que não quer dizer que ela seja aberta: sem a credencial acima ela recusa.
Exige sessão de vendedor. O saldo cotado e sacado é sempre o da sessão: não há campo em que o chamador escolha outra conta.
Parâmetros
Corpo da requisição
application/json.
| Campo | Tipo | Descrição |
|---|---|---|
amountCentsobrigatório | inteiro (centavos) | Quanto você quer sacar, em centavos inteiros. |
currencyobrigatório | um de: `BRL`, `USD`, `EUR` | A moeda do saque. |
{
"amountCents": 129900,
"currency": "BRL"
}Respostas
200 · sucesso
{
"debtTotalCents": 129900,
"effectiveWithdrawableCeilingCents": 129900,
"legCount": 1,
"legs": [
{
"amountCents": 129900,
"dispatch": 1,
"dispatchLabel": "exemplo",
"feeBearer": "seller",
"feeCents": 129900
}
],
"monthlyCeilingCents": 129900,
"monthlyCeilingUsedCents": 129900,
"netAmountCents": 129900,
"platformFeeCents": 129900,
"requestedAmountCents": 129900,
"totalFeeCents": 129900,
"withdrawableTotalCents": 129900
}Cotação calculada. NENHUM saldo se moveu e nada foi compensado: os totais são leitura, e withdrawableTotalCents é o teto do que pode ser PEDIDO agora. Cada perna é um ENVIO, identificado por posição e rótulo. A origem do dinheiro não é nomeada nesta superfície.
409 · conflito
A cotação não pôde ser calculada, e reason diz qual das condições fechou: o valor não cabe no que está disponível para saque, ficou abaixo do mínimo, ou falta preço cadastrado para calculá-la. Se a chave Pix cadastrada era a do documento anterior, a recusa vem com o código PAYOUT_PIX_KEY_REPLACEMENT_REQUIRED e sem reason: cadastre uma chave nova antes de cotar.
Erros desta rota
| Status | Código | Quando | O que fazer |
|---|---|---|---|
| 409 | QUOTE_REFUSED | A cotação não pôde ser calculada, e reason diz qual condição fechou: o valor não cabe no que está disponível para saque, ficou abaixo do mínimo, ou falta preço cadastrado para calculá-la. | Leia reason antes de repetir. Valor acima do disponível ou abaixo do mínimo se resolve pedindo outro valor; falta de preço cadastrado é do nosso lado, e reenviar não resolve. |
| 409 | PAYOUT_PIX_KEY_REPLACEMENT_REQUIRED | A chave Pix cadastrada era a do documento anterior. É a mesma recusa do pedido de saque, dada já na cotação para a tela não cotar um valor que o pedido recusaria. A resposta traz só o código e a mensagem. | Cadastre uma nova chave Pix e cote de novo. Repetir antes disso devolve sempre 409. |
Os códigos são estáveis e fazem parte do contrato. A lista completa, com todos os vocabulários, está na tabela de erros.