You can implement amount splits in two steps:

• Configure the payin config to apply an amount split
• Configure the Deposit Report Component to show the amount split fees

Configure the payin

Currently only one platform amount split is allowed. This can be used to charge a flat rate fee to the merchant in addition to merchant billing fees. This fee is deposited to the platform on a daily basis in a platform fee deposit.

The platform amount split is configured on the create payin config request:

  {
    "merchant_id": "{{merchant_id}}",
    "idempotency_key": "{{idempotency_key}}",
    "amount": 10000,
    "currency_code": "USD",
+   "amount_splits": [
+     {
+       "amount": 500
+       "currency_code": "USD",
+       "type": "PLATFORM",
+     }
+   ]
  }

The type should be set to PLATFORM and the amount must be less than the payin amount.

In this example, the $100 payin with a $5 platform fee would result in $95 (minus billing fees) being deposited to the merchant and $5 being deposited to the platform.

If no amount splits are provided, the total amount will be allocated to the specified merchant. Additionally, any remaining amount not specified by the amount splits will be allocated to the specified merchant.

Configure deposit report

When embedding the Deposit Report Component, you should display the amount split fee to your merchant by customizing the activity columns in the integrated Deposit Details Component.

See the activity column configuration of the deposit report component guide for details on how to customize the columns. The following column should be added:

{
    "name": "Platform Fees",
    "type": "builtin",
    "value": "split_remainder_amount"
}