Split into installments

Configure Split into installments

When creating an installment plan with Split, define whether the transferred amount will be calculated per installment, distributed from a total amount, or applied as a percentage.

The general rules for walletId, netValue and limits are in Payment Split.

Choose how to define the Split

NeedFieldBehavior
Define how much will be transferred in each installmentfixedValueThe same amount is applied to each installment
Define a total amount for the entire installment plantotalFixedValueAsaas distributes the amount among the installments
Define a percentagepercentualValueThe percentage is applied to the netValue of each installment

How it works

%%{init: {"flowchart": {"nodeSpacing": 28,"rankSpacing": 32,"diagramPadding": 8,"padding": 10}}}%%
flowchart TD
    A["Define the Split rule"] --> B["Create the installment plan"]
    B --> C["Generate the installments"]
    C --> D["Receive each installment"]
    D --> E["Settle the corresponding Split"]
    E --> F["Receive the Webhook"]

    classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,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

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

    linkStyle default stroke:#94A3B8,stroke-width:2px

Define an amount per installment

Use fixedValue when you already know how much should be transferred in each installment.

For example, in an installment plan of R$ 100.00 split into 4 installments, to transfer R$ 40.00 in total, configure R$ 10.00 per installment:

{
  "totalValue": 100.00,
  "installmentCount": 4,
  "split": [
    {
      "walletId": "48548710-9baa-4ec1-a11f-9010193527c6",
      "fixedValue": 10.00
    }
  ]
}

At the end of the four installments, the total amount configured for this recipient will be R$ 40.00.

Define a total amount for the installment plan

Use totalFixedValue when you want to provide the total amount to be distributed among all installments.

Example:

{
  "totalValue": 300.00,
  "installmentCount": 3,
  "split": [
    {
      "walletId": "0b763922-aa88-4cbe-a567-e3fe8511fa06",
      "totalFixedValue": 100.00
    }
  ]
}

In this case, Asaas distributes the R$ 100.00 among the three installments:

1st installment: R$ 33.33
2nd installment: R$ 33.33
3rd installment: R$ 33.34

The rounding difference is applied to the last installment.

Define a percentage

Use percentualValue when the transfer should proportionally follow the net amount of each installment:

{
  "totalValue": 300.00,
  "installmentCount": 3,
  "split": [
    {
      "walletId": "0b763922-aa88-4cbe-a567-e3fe8511fa06",
      "percentualValue": 6
    }
  ]
}

In this flow, Asaas calculates 6% of the netValue of each installment.

📘

Important

percentualValue is not calculated on the total gross amount of the installment plan. The calculation is made on the net amount of each generated charge.

If you need to distribute a previously calculated total monetary amount across the entire installment plan, use totalFixedValue.

See the Create new payment endpoint.

Track the settlement

Each installment has its own charge and its own Split processing.

When a Split is settled, use the event:

PAYMENT_SPLIT_DONE

The event is triggered individually for each settled Split. In an installment plan of three charges with Split, three events may occur, as each installment is received and its Split is settled.

Use additionalInfo.splitId to identify the corresponding Split.

See Payment events.

Next steps


Did this page help you?