Skip to main content
A split distributes the amount received by a receivable among one or more split recipients. It is configured the same way across Dynamic QR Codes, Static QR Codes, and Boletos.
All examples use fictitious data.

Where it applies

Splits are optional. When the split array is omitted, the receivable is created without any split.

Split configurations

A split is configured with the top-level split array.
Each item in the array describes one portion of the split:

Split type

For a R$ 100.00 received amount:

Split recipients

A split entry always references a counterparty_recipient_id. This ID identifies a split recipient that you create beforehand. Create a recipient with:
The recipient carries the counterparty identity (tax_number, name) and a reference, selected with ref_type. The reference fields are sent at the top level of the body — which ones are required depends on ref_type.

Pix key recipient

Bank account recipient

The response returns the recipient id. Use that id as the counterparty_recipient_id in your split configurations.

Merchant

When a receivable is split, you can optionally register the merchant that owns the split with the merchant object.
When merchant is sent, it is saved as the org split merchant.

Complete examples

Dynamic QR Code with split

Boleto with split

For the remaining boleto fields (discounts, fine, interest, boleto type), see the Create Boleto guide.