Split Payments
Split Payments let you distribute funds from a single transaction into multiple bank accounts. This helps merchants manage VAT, revenue sharing and operational flows more easily. You can configure splits on the Dashboard or per transaction via the API.
Get Started
Before you can Split Payments, there are a few setup steps you must complete on the Dashboard:
- Get access to split payments by making a request [email protected].
- Add recipient bank accounts on your Dashboard. Some accounts may require admin approval before they can be used.
- Create a split rule. A split reference is automatically generated. (Note: A split rule remains inactive until at least one bank account is attached)
Key Concepts
There are two types of splits:
- Fixed amount: A predetermined, absolute amount is sent to a recipient.
- Percentage amount: A percentage of the transaction amount is sent to a recipient.
Split Methods
There are two ways to apply splits:
- Fixed Rule Split – Defined once on the Dashboard and reused via its reference.
- Dynamic Rule Split – Defined inline with each transaction API request.
-
To initiate a charge with splits, include one of the following fields in your charge request:Initiate Payment with Split
| Field | Type | Description |
|---|---|---|
| split_reference | String | Use a rule created on the Dashboard. Applies that rule to the transaction. |
| split_config | Object | Define a per-transaction split directly in the API request. Includes type and recipients. |
For more information on how to initiate a charge, check here.
Note:
- A Dashboard rule applies to all incoming transactions by default.
- If you send a split_reference or split_config in your API request, the API configuration will override the Dashboard rule for that transaction.
Fixed rule split
{
"amount": 400000,
"redirect_url": "https://korapay.com",
"currency": "NGN",
"reference": "reference-12345",
"narration": "Payment for product A",
"channels": [
"card"
],
"default_channel": "card",
"customer": {
"name": "John Doe",
"email": "[email protected]"
},
"notification_url": "https://korapay.com",
"split_reference": "KPY-SAS-123456789"
}
Dynamic rule split
{
"amount": 400000,
"redirect_url": "https://korapay.com",
"currency": "NGN",
"reference": "reference-12345",
"narration": "Payment for product A",
"channels": [
"card"
],
"default_channel": "card",
"customer": {
"name": "John Doe",
"email": "[email protected]"
},
"notification_url": "https://korapay.com",
"split_configuration": {
"split_type": "percentage", //percentage or flat
"split_accounts": [
{
"value": "30",
"split_account_reference" : "KPY-SPA-12345"
},
{
"value": "25",
"split_account_reference" : "KPY-SPA-56789"
}
]
}
}
For more information on using this product kindly check our FAQ’s
Updated 1 day ago
Did this page help you?
