🚧

Upgrade to the latest version

These docs are for version 2023-12-01. We encourage you to upgrade to version 2024-10-16 to access new features. Please see the changelog for more information.

Amount splits can be passed in the payin config request to represent how the payin should be split amongst multiple parties.

Platform fee split

Currently only one PLATFORM amount split is allowed. This can be used to charge a flat rate fee to the merchant in addition to, or instead of, merchant fees. This fee is paid out to the platform on a daily basis.

In order to specify a platform fee, the type should be set to PLATFORM.

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

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.

Display in 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 section 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"
}