Request an anticipation

Anticipate the receipt of a one-time charge or an eligible installment plan.

Before requesting it, simulate the anticipation to validate the operation's conditions and identify whether documentation will need to be sent.

Choose what to anticipate

The behavior depends on the charge type:

To anticipate the complete installment plan, use the installment ID in installment.

Each installment also has its own charge ID. When you need to find the charges of an installment plan, see List payments of an installment.

How it works

%%{init: {"flowchart": {"nodeSpacing": 28,"rankSpacing": 32,"diagramPadding": 8,"padding": 10}}}%%
flowchart TD
    A["Identify the charge"] --> B["Simulate the anticipation"]
    B --> C{"Documentation required?"}

    C --> CSim(("Yes"))
    C --> CNao(("No"))

    CSim --> D["Prepare the documents"]
    CNao --> E["Request the anticipation"]
    D --> E

    E --> F["Track the processing"]
    F --> G["Reconcile the result"]

    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. Simulate the anticipation

Before requesting, use:

POST /v3/anticipations/simulate

Provide payment for a charge or installment for an installment plan.

See the Simulate anticipation endpoint.

Check isDocumentationRequired in the simulation result.

When the field indicates it is required, prepare the necessary electronic invoices or service agreements before requesting the anticipation.

2. Request the anticipation

Use:

POST /v3/anticipations

For a one-time charge:

{
  "payment": "pay_626366773834"
}

To anticipate a complete installment plan, provide the corresponding identifier in installment.

When the simulation indicates required documentation, send the necessary files in the documents field.

See the Request anticipation endpoint.

3. Track the anticipation

The request has its own processing cycle. Use Webhooks to keep your application in sync with status changes.

Among the events that may indicate the result of the operation are:

See Anticipation events.

For a one-off query, use the anticipation ID:

GET /v3/anticipations/{id}

See the Retrieve a single anticipation endpoint.

Next steps

• Simulate an anticipation
• Request an anticipation
• Retrieve an anticipation
• List the account's anticipations
• Track Anticipation events
• See the rules for Split in anticipated payments