Split Payments

Automatically split collected funds across your own wallets

List split rule sets

List split rules API: retrieve every split rule set on your account with its collecting wallet and allocations. Parameters, responses and code samples.

Create a split rule set

Create split rule API: share each payment into a collecting wallet across your wallets by percentage or fixed amount. Parameters, responses and code samples.

Retrieve a split rule set

Get split rule API: retrieve one split rule set by ID with its collecting wallet, allocations and active status. Parameters, responses and code samples.

Replace a split rule set

Replace split rule API: fully replace a split rule set's attributes and its percentage or fixed allocations. Parameters, responses and code samples.

Delete a split rule set

Delete split rule API: remove a split rule set, or deactivate it if it was already used on a payment split. Parameters, responses and code samples.

Activate a split rule set

Activate split rule API: turn on a split rule set so every payment into its collecting wallet is shared out. Parameters, responses and code samples.

Deactivate a split rule set

Deactivate split rule API: stop a split rule set so payments into its collecting wallet are no longer shared. Parameters, responses and code samples.