Need help?

Multi Split Payments in API

The Multi-Split Payment feature allows merchants to distribute the payout of a single transaction across a primary account and multiple sub-accounts. This offers enhanced flexibility, enabling merchants to allocate funds to different recipients based on pre-configured or dynamic splitting rules.

JSON Request Format

Merchants must include the 'splits' array of objects in the request body to define how the transaction is divided. Each entry in the array uses the 'id' parameter to identify the subaccount where the funds will be allocated.

Example:

"splits": [
  {
    "id": 1
  },
  {
    "id": 6
  },
  {
    "id": 8
  }
]

Custom Split Format with Values

Merchants can further customize how the transaction is split by using the 'type' and 'value' fields. This allows specifying whether the split should be a flat amount or a percentage of the total transaction after the MDR deducted.

Example:

"splits": [
  {
    "id": 1,
    "type": "flat",
    "value": "300"
  },
  {
    "id": 6,
    "type": "percentage",
    "value": "10"
  },
  {
    "id": 8
  },
  {
    "id": 9,
    "type": "flat",
    "value": "100"
  }
]

Parameter Details:

  • id (Required): A unique identifier for the subaccount receiving the split.
  • type (Optional): Specifies how the split should be calculated. Possible values are:
    1. flat: A fixed amount is deducted from the total transaction value.
    2. percentage: A percentage-based deduction from the total transaction value.
  • value (Optional if type is provided): The value associated with the split, either a fixed amount (for flat) or a percentage (for percentage).

Note: Multi-split payments are not supported for form-based requests.