You can create split configuration profiles to automatically split transactions processed through your user's store. The rules you set in the profile define how and to which balance account to book the funds and fees associated with the transaction. If you don't include split instructions in a split configuration profile or in your Checkout API or Terminal API payment request, Adyen books the funds and fees to your platform's liable balance account.
To split transactions automatically, you must:
- Create a split configuration profile in your Customer Area or using the Management API.
- Link the profile to your user's store when you create or update the store using the Management API. It is not possible to link profiles to stores using the Customer Area, unless you onboarded your user through Onboarding on invite.
Requirements
| Requirement | Description |
|---|---|
| Integration type | You must have a platform model integration on Adyen for Platforms. |
| API credential roles | If you want to create and manage split configuration profiles through API requests, your Management API credential must have the following role:
|
| Customer Area roles | If you want to create and manage split configuration profiles in your Customer Area, ask our Support Team to enable the Manage new split configuration settings role for your admin user. The admin user can then grant this role to other users. |
| Limitations | You can only link a split configuration profile to a store using the Management API. |
| Setup steps | Before you begin, contact our Support Team to enable split configuration profiles for your platform. |
How it works
A split configuration profile defines the conditions for when and instructions on how to split transactions processed through your user's store. You can link the same split configuration profile to multiple stores.
When you associate a profile with your user's store, you must also specify which of your user's balance accounts to use for booking the splits. We book all your users' funds and fees to that balance account.
Create a split configuration profile
A split configuration profile consists of one or more rules that determine whether the split logic is applied to a transaction. When you create the profile, you must create its first rule at the same time.
You can create a split configuration profile in your Customer Area, or by using the Management API.
Link the profile to a store
You must link the split configuration profile to your user's store using the Management API. You have two options:
- Create a new store with the split configuration profile by making a POST /stores request.
- Update an existing store with the split configuration profile, by making a PATCH /stores/{storeId} request.
In the body of either request, include the splitConfiguration object with the following parameters:
- splitConfigurationId: the unique identifier of the split configuration profile.
- balanceAccountId: the unique identifier of the balance account to which the split amounts and fees must be booked, depending on the defined split logic.
After the store is successfully created or updated, Adyen starts evaluating every transaction processed through the store and applies the split instructions of the rule with the highest priority condition.
The following example shows how you can apply a split configuration profile to all payments processed through an existing store.
The response contains the full store details, including the split configuration profile information.
After the store is successfully updated, Adyen starts evaluating every transaction processed through the store and applies the split instructions of the rule with the highest priority condition.