Introdução - Antecipação

Solicite uma antecipação

Antecipe o recebimento de uma cobrança avulsa ou de um parcelamento elegível.

Antes de solicitar, simule a antecipação para validar as condições da operação e identificar se será necessário enviar documentação.

Escolha o que antecipar

O comportamento depende do tipo de cobrança:

Cenário	Como antecipar
Cobrança avulsa	Informe o ID da cobrança em `payment`
Parcelamento no cartão de crédito	Pode ser antecipado integralmente ou por parcela
Parcelamento no boleto	Antecipe cada parcela individualmente

Para antecipar o parcelamento completo, utilize o ID do parcelamento em installment.

Cada parcela também possui seu próprio ID de cobrança. Quando precisar localizar as cobranças de um parcelamento, consulte Listar cobranças de um parcelamento.

Como funciona

%%{init: {"flowchart": {"nodeSpacing": 28,"rankSpacing": 32,"diagramPadding": 8,"padding": 10}}}%%
flowchart TD
    A["Identificar a cobrança"] --> B["Simular a antecipação"]
    B --> C{"Documentação obrigatória?"}

    C --> CSim(("Sim"))
    C --> CNao(("Não"))

    CSim --> D["Preparar os documentos"]
    CNao --> E["Solicitar a antecipação"]
    D --> E

    E --> F["Acompanhar o processamento"]
    F --> G["Conciliar o resultado"]

    classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px,font-size:17px
    classDef decisao fill:#FEF3C7,stroke:#D97706,color:#78350F,stroke-width:3px,font-size:17px
    classDef validacao fill:#E0F2FE,stroke:#0284C7,color:#0C4A6E,stroke-width:2px,font-size:17px
    classDef sucesso fill:#DCFCE7,stroke:#16A34A,color:#14532D,stroke-width:3px,font-size:17px

    classDef respostaSim fill:#22C55E,stroke:#15803D,color:#FFFFFF,stroke-width:3px,font-size:16px
    classDef respostaNao fill:#EF4444,stroke:#B91C1C,color:#FFFFFF,stroke-width:3px,font-size:16px

    class A inicio
    class C decisao
    class B,D,E,F validacao
    class G sucesso

    class CSim respostaSim
    class CNao respostaNao

    linkStyle default stroke:#94A3B8,stroke-width:2px
    linkStyle 2 stroke:#22C55E,stroke-width:4px
    linkStyle 3 stroke:#EF4444,stroke-width:4px

1. Simule a antecipação

Antes de solicitar, utilize:

POST /v3/anticipations/simulate

Informe payment para uma cobrança ou installment para um parcelamento.

Consulte o endpoint Simular antecipação.

Verifique isDocumentationRequired no resultado da simulação.

Quando o campo indicar obrigatoriedade, prepare as notas fiscais eletrônicas ou contratos de prestação de serviços necessários antes de solicitar a antecipação.

2. Solicite a antecipação

Utilize:

POST /v3/anticipations

Para uma cobrança avulsa:

{
  "payment": "pay_626366773834"
}

Para antecipar um parcelamento completo, informe o identificador correspondente em installment.

Quando a simulação indicar documentação obrigatória, envie os arquivos necessários no campo documents.

Consulte o endpoint Solicitar antecipação.

🚧
Atenção
Caso a cobrança a ser antecipada possua split de pagamento definido, é preciso observar as regras de execução do Split em cobranças antecipadas.

3. Acompanhe a antecipação

A solicitação possui um ciclo de processamento próprio. Utilize Webhooks para manter sua aplicação sincronizada com as mudanças de status.

Entre os eventos que podem indicar o resultado da operação estão:

Evento	O que indica
`RECEIVABLE_ANTICIPATION_CREDITED`	O valor da antecipação foi creditado
`RECEIVABLE_ANTICIPATION_DENIED`	A solicitação foi negada
`RECEIVABLE_ANTICIPATION_CANCELLED`	A antecipação foi cancelada

Consulte os Eventos para antecipações.

Para uma consulta pontual, utilize o ID da antecipação:

GET /v3/anticipations/{id}

Consulte o endpoint Recuperar uma única antecipação.

Próximos passos

Updated 10 days ago

Did this page help you?