Skip to main content
POST
/
api
/
v1
/
cashouts
Saques (Cashout)
curl --request POST \
  --url https://zeus-sandbox.autorizou.dev/api/v1/cashouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipient_id": "<string>",
  "merchant_reference": 123,
  "cashout_amount": 123,
  "cashout_fee": 123,
  "payables": [
    {
      "payables[].payment_id": "<string>",
      "payables[].amount": 123,
      "payables[].original_amount": 123
    }
  ]
}
'
Valida uma solicitação de saque (cashout) de um recebedor antes de efetivá-la, conferindo os valores liberados (payables), a taxa de saque e o valor líquido a ser transferido. É o passo de validação do fluxo de repasse para os recebedores participantes de um split.
Este endpoint pertence ao fluxo de Recebedores: o saque movimenta o saldo acumulado pelos splits (Criar Recebedor).

​
Parâmetros da Requisição

​
recipient_id
string
required
UUID (v4) do recebedor que está solicitando o saque.
​
merchant_reference
integer
required
Referência do estabelecimento associada ao saque.
​
cashout_amount
integer
required
Valor total do saque em centavos. Mínimo: 0.
​
cashout_fee
integer
required
Taxa de saque em centavos. Mínimo: 0.
​
payables
array
required
Lista de recebíveis (payables) que compõem o saque.

​
Exemplos de Requisição

curl -X POST https://zeus-sandbox.autorizou.dev/api/v1/cashouts \
    -H "Authorization: Bearer 4eC39HqLyjWDarjtT1zdp7dc" \
    -H "Content-Type: application/json" \
    -d '{
        "recipient_id": "295e3b31-1684-4355-8ee5-4bbf7b97589b",
        "merchant_reference": 12345,
        "cashout_amount": 50000,
        "cashout_fee": 367,
        "payables": [
            {
                "payment_id": "b9f8cfd4-d5b3-4b0f-8a3d-03b5c3492f10",
                "amount": 50000,
                "original_amount": 50367
            }
        ]
    }'

​
Exemplo de Resposta

{
  "recipient_id": "295e3b31-1684-4355-8ee5-4bbf7b97589b",
  "cashout_amount": 50000,
  "cashout_fee": 367,
  "net_amount": 49633,
  "valid": true,
  "payables_count": 1
}

​
Códigos de Erro

Os valores informados são inconsistentes (ex.: soma dos payables diferente do cashout_amount) ou o recebedor não está apto a sacar.
{
    "message": "Cashout amount does not match the sum of payables."
}