You can create a split configuration profile to automatically evaluate and split transactions processed through your user's store. The rules you set in the profile define how and/or to which balance account to book the following:
- The payment amount and all types of transaction fees associated with the payment
- Your platform's commission and additional commission to your user's balance account
- The refund amount and associated fees
- The chargeback amount and associated fees
- The leftover amount after currency conversion
- Surcharges
- Gratuity (tips)
You can associate the split configuration profile you create with one of your user's balance accounts when you link the profile to a store. All amounts and fees that you want to book to your user are booked to the same balance account. If you don't include split instructions in the profile or API request, the funds and fees are booked to your platform's liable balance account by default.
To split transactions automatically:
- 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.
Requirements
| Requirement | Description |
|---|---|
| Integration type | You must have an online or in-person integration with Adyen. |
| 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. |
| Setup steps | Before you begin:
|
Step 1: Create a split configuration profile
You can create a split configuration profile in your Customer Area, or by using the Management API. When you create the profile, you must create its first rule at the same time.
Step 2: Link the profile to a store
You must link the split configuration profile to 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. Use this option when your user does not have an existing store.
- Update an existing store with the split configuration profile, by making a PATCH /stores/{storeId} request. Use this option if you have already created a store for your user and want to apply a split configuration profile to this store.
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 splitLogic.
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.