Summary
This Product Guide Document outlines the features of Split Payout functionality. The goal is to provide users with a seamless and efficient way to split payments among multiple recipients. The Split Payout Processing feature enables businesses to seamlessly manage split payments, ensuring that funds are distributed correctly to multiple parties involved in a transaction. This feature is particularly beneficial for marketplaces, e-commerce platforms, and service providers that facilitate transactions between multiple parties.
Introduction
This guide provides comprehensive information on initiating and managing Split Payout transactions through our platform. Split Payouts enable you to process transactions with multiple recipients seamlessly.
Key Features
- Seamless Split Payout Processing: Integrate the Split Payout Processing feature into your existing transaction processing workflow to automate payout distribution.
- Granular Split Payout Control: Define the split payout rules for each transaction, specifying the amount to be distributed to each party.
- Automated Reconciliations: Generate detailed split payout reconciliation reports to ensure accurate and transparent payout processing.
1. Getting Started
1.1 Prerequisites
Before utilizing the Split Payouts feature, merchant should be assigned the following:
- Transaction api with Split Payout details.
- Valid API credentials and authentication.
- Live Deposit Account Under Accounts Section.
- PSP Account for the Merchant under Accounts Section.
- Profile should have Split payout enabled.
1.2 Create Split request
To create Split request, a split object should be sent during the payment request.
Request Method: POST URL: https://secure.clickpay.com.sa/payment/request Header: Authorization: Server API Key (Required)
{
"profile_id": 47128,
"tran_type": "sale",
"tran_class": "ecom",
"cart_id": "cart_11123",
"cart_currency": "SAR",
"cart_amount": 158.56,
"cart_description": "Description of the items/services",
"paypage_lang": "en",
"customer_details": {
"name": "first last",
"email": "email@domain.com",
"phone": "0522222222",
"street1": "address street",
"city": "dubai",
"state": "du",
"country": "AE",
"zip": "12345"
},
"shipping_details": {
"name": "name1 last1",
"email": "email1@domain.com",
"phone": "+966XXXXXXXXX",
"street1": "street2",
"city": "dubai",
"state": "dubai",
"country": "AE",
"zip": "54321"
},
"split_payout": [
{
"entity_id": 1000,
"entity_name": "Restaurant",
"item_description": "Meal",
"item_total": "133.56",
"msc_flag": "p",
"beneficiary": {
"name": "Customer Name",
"account_number": "SAXX0X0000XXX000XXXXX000",
"country": "SA",
"bank": "bank name",
"bank_branch": "",
"email": "email@domain.com",
"mobile_number": "+966XXXXXXXXX",
"address_1": "Riyadh",
"address_2": ""
}
},
{
"entity_id": 1001,
"entity_name": "Agency",
"item_description": "Delivery Fee",
"item_total": "15.00",
"msc_flag": "Z",
"beneficiary": {
"name": "customer name",
"account_number": "SAXX0X0000XXX000XXXXX000",
"country": "SA",
"bank": "bank name",
"bank_branch": "",
"email": "email@gmail.com",
"mobile_number": "+966XXXXXXXXX",
"address_1": "Riyadh",
"address_2": ""
}
},
{
"entity_id": 1002,
"entity_name": "Tip",
"item_description": "Tip",
"item_total": "10.00",
"msc_flag": "Z",
"beneficiary": {
"name": "customer name",
"account_number": "SAXX0X0000XXX000XXXXX000",
"country": "SA",
"bank": "Bank name",
"bank_branch": "",
"email": "email@domain.com",
"mobile_number": "+966XXXXXXXXX",
"address_1": "Riyadh",
"address_2": ""
}
}
],
"callback": "none",
"return": "none"
}| Parameter | Description | Required |
|---|---|---|
| split_payout | The Split Object which contains, the stakeholders of current transaction. If it is defined at least two entities should be provided. | Optional |
| split_payout. entity_id | Unique Entity Id, defined by the merchant | Required |
| split_payout. entity_name | Entity name | Required |
| split_payout.item_description | A brief description for the item | Optional |
| split_payout. item_total | The amount that should be paid for related entity | Required |
| split_payout.msc_flag | The msc_flag can be set to one of the following values: F = Full MSC is applied to this item P = Proportional MSC is applied to this item Z = Zero MSC R = Remainder of MSC If one item has ‘F’ as the flag, then all other items must have ‘Z’. The item set to ‘F’ will take the entire MSC for the total transaction amount. If an item as ‘P’ as the flag, then the MSC charged to that item will be a proportion of the total MSC based on what proportion of the total transaction this item Required represents. If using ‘P’ as one of the flags, then one item must have ‘R’ as it’s flag, for that item to take the remainder of any MSC that has not been allocated elsewhere. | Required |
| split_payout. beneficiary.name | Beneficiary Name as defined in the bank | Required |
| split_payout. beneficiary. account_number | Beneficiary account (IBAN, VIBAN) | Required |
| split_payout. beneficiary. country | Beneficiary Bank’s country | Required |
| split_payout. beneficiary. bank | The name of Beneficiary bank | Optional |
| split_payout. beneficiary. Bank_branch | The bank branch | Required |
| split_payout. beneficiary.email | Beneficiary email | Required |
| split_payout. Beneficiary.address_1 | Beneficiary address | Required |
| split_payout. Beneficiary.address_2 | Beneficiary additional address | Optional |
If the request is valid, PT will return a URL to the checkout page where the merchant should redirect the customer to complete the payment.
Once the user completes the payment successfully, transaction logs can be found in the merchant portal with the split payout details as below.
1.3 Split Transaction Report:
- The Split Transaction Report is automatically generated in the merchant dashboard on the following day for transactions completed on the current day.
- Merchant users can conveniently view a summary of consolidated payout amounts for all transactions per entity within the generated report.
- The report provides clear insights into the disbursed amounts allocated to each respective entity and the transactions involved in the payout.
- Accessing this report enhances transparency by presenting a comprehensive overview of daily entity payout amounts.
1.4 Split Payouts Section: Merchant Dashboard
Once the payout is generated merchant user can view the Split Payout request generated under Deposit tab of Merchant Dashboard
Once the payout is completed successfully the batch status will be changed to Completed.
User will be able to download the Split payout batch details from same screen.