These docs are for v4. Click to read the latest docs for v5.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
❗️

Atenção: Essa versão de API será descontinuada

Essa versão da API Pagar.me já não é mais atualizada e, em breve, deixará de funcionar. Para que sua loja possa vender sem problemas, você precisa realizar sua integração usando a versão mais recente da nossa API, a V5.

No canto superior esquerdo da tela é indicado qual versão da documentação você está vendo. Clique na seta onde indica a versão e altere para a V5 para acessar a documentação.

Se você já é cliente, precisa realizar obrigatoriamente a migração para a versão V5.

Em caso de dúvidas, basta entrar em contato com o nosso time de atendimento através do e-mail, enviando a sua dúvida para [email protected] e por telefone, ligando para 4004-1330. Se você já é cliente pode também entrar em contato através do chat dentro da sua Dashboard.

🚧

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
string
required
Defaults to required

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

Query Params
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.

date
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.

int32
Defaults to null

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.

Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json