Split Overview
A Split represents a revenue sharing configuration that determines how payment amounts are distributed between different receivers. Splits can be defined at various levels (company, product, offer, order, bill, or payment) and can be calculated as either absolute amounts or percentages.
This object is not returned by any endpoint. You set product splits through the splits param of Create a product.
Split Schema
| Field | Description | Type |
|---|---|---|
| id | Unique identifier (UUID) | String |
| receiver_id | Identifier of the receiver who will receive this split portion | String |
| take_rate_type | How the split is calculated. Can be absolute (fixed amount in cents) or percentage (percentage of total) | String |
| take_rate | The split value - either cents amount (for absolute) or decimal percentage (for percentage, e.g., 0.15 for 15%) | Float |
| owner_type | Type of entity that owns this split (Company, Product, Offer, Order, Bill, or Payment) | String |
| owner_id | Identifier of the owner entity | String |
| payment_method_configuration_id | Payment method configuration associated with this split | String |
| created_at | Indicates when the record was created in ISO8601 format | String |
| updated_at | Indicates when the record was last updated in ISO8601 format | String |
| receiver | Receiver object (id, company_id) | Object |
Take Rate Type Values
| Value | Description |
|---|---|
| absolute | The take_rate represents a fixed amount in cents that will be allocated to the receiver |
| percentage | The take_rate represents a percentage (as decimal, e.g., 0.25 = 25%) of the total amount to be allocated |
Split Rules
- Payment splits must use
absolutetake_rate_type - Company, Product, Offer, and Order splits must use
percentagetake_rate_type - All splits for the same owner and payment method configuration must have the same take_rate_type
- For absolute splits: The sum of all take_rate values must equal the owner’s amount_cents
- For percentage splits: The sum of all take_rate values must equal 1.0 (representing 100%)
- Product splits must reserve at least 3% (
0.03) to the product’s company - Bill splits can have at most one payment method configuration enabled per payment method and receiver
- Payment splits must have the same payment method configuration for all splits of that payment