Split Payout (split_payout)

In this manual, we are going to walk you through the split_payout parameter, which is the required list of objects defining stakeholders in the transaction. Each entity included in this list receives a designated payout amount, supporting multi-party transactions within a single batch..

The Parameter Key	split_payout
Data Type	Object
Description	The Split Object which contains, the stakeholders of current transaction. If it is defined at least two entities should be provided.
Required	❌
Sample	{ "split_payout": [ {}, {}, ... {} ] }
Parameter	Data Type	Required	Min	Max
entity_id	integer	✔	-	-
	Unique Entity Id, defined by the merchant
entity_name	string	✔	-	-
	Entity name
item_description	string	❌	-	-
	A brief description for the item.
item_total	string	✔	-	-
	The amount that should be paid for related entity.
msc_flag	string	✔	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.