v1

latestOpenAPI 3.1.02026-07-26477322.4 KB

Simulando uma Antecipação Spot

Obtem previsões precisas sobre o valor a ser recebido, os custos envolvidos na operação, e a data de pagamento. Para iniciar a simulação da antecipação, é necessário utilizar a rota:

get/recipients/{recipient_id}/bulk_anticipations/simulate

Path parameters

recipient_idstring required

ID do recebedor para o qual deseja simular a antecipação.

Query parameters

timeframestring required

Define o período de onde os recebíveis serão escolhidos para simulação — ou seja, do inicio ou do fim da sua agenda de recebíveis.

requested_amountinteger required

Valor líquido, em centavos, que você deseja receber na antecipação, o valor deve estar entre o limite antecipável do recebedor. Caso queira consultar os limites antecipáveis utilize a rota /limits.

payment_datestring required

Data que você deseja receber a antecipação em sua conta Pagar.me. O parâmetro payment_date pode ser para qualquer dia no futuro e do dia atual até as 11h, caso já tenha passado desse horário, por favor adicione um payment_date para o próximo dia útil. Data em string no formato ISO 8601

Response

200

amountinteger

feeinteger

fraudCoverageFeeinteger

anticipationAmountinteger

anticipationFeeinteger

timeframestring

paymentDatestring

startIntervalDatestring

endIntervalDatestring

Example response

{
  "amount": 1000000,
  "fee": 20000,
  "anticipationAmount": 900000,
  "anticipationFee": 80000,
  "timeframe": "start",
  "paymentDate": "2025-08-10T00:00:00.000Z",
  "startIntervalDate": "2025-08-05T00:00:00.000Z",
  "endIntervalDate": "2024-12-18T00:00:00.000Z"
}