Simulando uma Antecipação Spot

get

https://api.pagar.me/1/recipients/{recipient_id}/bulk_anticipations/simulate

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: /recipients/:recipient_id/bulk_anticipations/simulate.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Atenção
É importante notar que o campo payment_date utiliza unixTimeStamp como valor. Para gerar o unixTimeStamp de uma data, é possível utilizar o console do Google Chrome com o seguinte código em Javascript : new Date("2017-12-25T02:00:00.000Z").getTime() que retornará 1514167200000

Após realizar a simulação, é possível solicitar uma antecipação com o valor simulado através da rota de criação de antecipações.

Path Params

recipient_id

string

required

Defaults to required

Query Params

timeframe

string

Defaults to 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.

payment_date

string

Defaults to 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.

requested_amount

string

Defaults to 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.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Atenção

200200

400400