Bem-vindo à documentação Pagar.me

Aqui você vai encontrar guias e exemplos para te ajudar
a integrar com a melhor API de Pagamentos do Brasil!

Começar

Você também pode buscar ou navegar pelas categorias

Assim que uma transação é concluída, o ciclo de vida dela está apenas começando. Isto é, os recebíveis atrelados a ela só ficarão disponíveis em uma data futura, de acordo com os prazos para transações com cartão de crédito. Porém, é possível que você precise desse dinheiro antes desse prazo, e é aí que entra a antecipação.

A antecipação é um produto oferecido pelo Pagar.me, que possibilita que o cliente adiante certa quantia de dinheiro que só iria estar disponível em uma data futura. Veja mais sobre o assunto na FAQ em: O que é antecipação?

1. Conceitos básicos

Imagine que você já fez algumas transações, então já existem recebíveis a cair na sua conta em uma data futura. Veja a seguir alguns conceitos que vão ajudar a entender o que é possível fazer com as nossas antecipações.

Que as antecipações comecem!

1.1 Posso antecipar tudo?

Assim que as suas antecipações são aprovadas, é definido um percentual antecipável, que define quanto do seu saldo a receber você pode antecipar. Veja o exemplo a seguir para entender como isso funciona:

Digamos que o seu percentual antecipável seja 50% e você já possui R$ 10.000,00 de vendas concretizadas (saldo a receber). Neste cenário, é feito o seguinte cálculo:

- Percentual antecipável = 50%, ou seja: 0,5;
 - Vendas concretizadas = R$10.000,00;
 - Posso antecipar = Volume antecipável * Vendas concretizadas = 0,5 * 10.000 = R$5.000,00

É importante perceber que essa conta não é uma constante. A porcentagem do volume antecipado muda quando novas transações são feitas na sua loja, já que o valor total é alterado. É possível entender isso melhor vendo um exemplo.

Digamos que os R$5.000,00 da conta anterior foram antecipados, mas mais R$2.000,00 de vendas foram concretizadas:

- Volume já antecipado = R$5.000,00
 - Vendas concretizadas = R$10.000,00 + R$2.000,00 = R$12.000,00
 - Percentual antecipado = Volume já antecipado / Vendas concretizadas = 5.000 / 12.000 = 41,67%

Com isso, o seu percentual antecipado passa a ser menor do que o antecipável. Isso significa que, se você quiser, é possível antecipar mais.

1.2 Antecipações do fim ou do início?

Ao criar uma antecipação é necessário determinar um valor e um período start ou end. O parâmetro valor é auto-explicativo, indicando quanto você quer antecipar; já o parâmetro período é algo que vale a pena dar uma olhada mais detalhada.

De uma forma simples, quando você especifica um valor, usamos um algoritmo que engloba alguns recebíveis para antecipar e chegar a essa quantia. A grande questão é a decisão de quais recebíveis deveriam ser atingidos: os do fim ou os do início.

É aí que entra o período: se for especificado uma antecipação do início, são englobados os recebíveis cujas datas de pagamento são mais próximas de hoje. Já se o período de fim for escolhido, são englobados os recebíveis com data de pagamento mais distante. Veja o exemplo:

Diferentes períodos para uma antecipação

Existem vantagens e desvantagens de antecipar de um período ou do outro. Antecipar do início é mais barato, uma vez que antecipa-se um recebível por menos dias. No entanto, dessa forma cria-se um período em que não existem mais recebíveis a cair no saldo. Já antecipar do fim não cria esse buraco, mas custa mais caro, uma vez que antecipa-se mais dias dos recebíveis. Veja mais sobre isso em: Como é feito o cálculo da antecipação?

📘

Não consigo antecipar exatamente X reais!

Ao fazer uma antecipação, escolhemos um número inteiro de recebíveis, mas nem sempre esses valores — o que você deseja e o que de fato antecipamos — serão exatamente iguais, dado os valores variáveis dos recebíveis.

Nesses casos, antecipamos o valor mais próximo antes de chegar no valor desejado.

2. Modelos de antecipação

Agora que você entende os conceitos de antecipação, é hora de conhecer os modelos que oferecemos.

2.1 Spot

Neste modelo, você escolhe quando e quanto antecipar, respeitando os limites do percentual antecipável. Ou seja, se você não precisa sempre de antecipações, pode usar o modelo Spot para fazer isso apenas quando for necessário. Veja mais em Como criar uma antecipação Spot?

2.2 Automática

Já com este modelo, você escolhe uma periodicidade (diária, semanal ou mensal) e o procedimento é feito automaticamente pelo sistema nos intervalos estabelecidos. Veja mais sobre como esse modelo funciona na nossa FAQ em: Quais são os modelos de antecipação disponíveis?

📘

Alguns pontos sobre os dois modelos de antecipação

  • Não é possível utilizar um modelo híbrido, ou seja, automatizar um volume e antecipar manualmente o resto;
  • Se quiser, você mesmo pode mudar do modelo Automático para o Spot;
  • Para mudar do modelo Spot para o Automático ou mesmo para ativar o modelo Automático, é preciso entrar em contato conosco pelo e-mail [email protected].

Updated about a year ago


Próximo

Agora que você já entende o básico, aprenda como criar uma antecipação com a API Pagar.me

Criação

Overview


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.