API
Platform fees on v2 Payins
Create a Payin (POST /v2/payins) accepts an optional allocation_profile object:
When the object is sent, the response and Get Payin Details return the applied split in
allocation_profile: platform_fee, platform_fee_fixed, platform_fee_amount, and the amount moved to each recipient.
- The platform fee is
amount × platform_fee% + platform_fee_fixed. Recipients share what is left. The Hello Clever processing fee comes out of the platform fee. - The request is rejected before any money moves if the profile, recipients, or platform fee are invalid. See the error list.
- Payins sent without
allocation_profileare unchanged.
Listing allocation recipients
Get Allocation Recipient Accounts (GET /v2/merchant_allocation_profiles/accounts) now accepts app-id and secret-key. Called with the receiving account’s keys, it returns the other Payments Accounts in the same currency that can receive a share. The currency is taken from the app-id, so no currency parameter is needed.
Docs: Split Payins with platform fees · Platform Fees
Payment Gateway
Platform fees on payin links
Create PayIn (POST /v3/payin_links) accepts the same allocation_profile object. Once the customer pays, Get PayIn details returns the split in transaction_info.allocation_profile.
- If
payin_method_codeis left out, the customer picks the method at checkout and the platform fee is checked against that method’s processing fee. - For card payments, the split is applied after the card is charged, once the card brand and processing fee are known. The Payin moves to received when it settles.
Fund splitting is available to Clever Connect accounts on Dedicated Balance, for AUD, USD, JPY, VND, ARS, IDR, INR and KES. Hello Clever enables it per currency: contact your account manager.