v1

latestOpenAPI 3.1.02026-07-26477322.4 KB

Criando uma antecipação

post/recipients/{recipient_id}/bulk_anticipations

Request body

payment_datestring required

Data de pagamento da antecipação. Data no formato ISO 8601

timeframestring required

Define o período de onde os recebíveis serão escolhidos. start define recebíveis próximos, perto de serem pagos, e end define recebíveis longes, no final de todos recebíveis que você possui para receber. String start ou end

requested_amountinteger required

Valor líquido, em centavos, que você deseja receber de antecipação

automatic_transferboolean

Define se o valor da antecipação será transferido automaticamente para a conta bancária do recebedor

Response

200

idstring

statusstring

amountinteger

feeinteger

fraud_coverage_feeinteger

anticipation_feeinteger

automatic_transferboolean

typestring

timeframestring

payment_datestring

created_atstring

updated_atstring

{"stackTrail":"paths:/recipients/{recipient_id}/bulk_anticipations:post:responses:200:content:application/json:schema:properties:anticipation_tax","oasType":"schema","type":"unknown"}

Example response

{
  "id": "ba_123456789",
  "status": "approved",
  "amount": 100000,
  "fee": 5000,
  "anticipation_fee": 3000,
  "type": "spot",
  "timeframe": "start",
  "payment_date": "2025-08-20T00:00:00.000Z",
  "created_at": "2025-08-19T14:23:00.000Z",
  "updated_at": "2025-08-20T10:15:00.000Z"
}