Why this feature exists
Before this release, a platform that collected one payment for several parties received the whole amount into one Payments Account. It then had to work out each party’s share and move the money itself after the payment arrived. That meant extra reconciliation, a delay before each party saw its money, and no built-in way to keep a platform fee. With this feature, Hello Clever allocates the payment as part of the Payin. Each Allocation Account’s share appears in its own balance, linked to the original Payin, and the platform fee stays in the Collecting Payments Account.Signals to look for
A merchant is a likely fit when one or more of these is true:
The merchant must also meet the prerequisites. A merchant on the Aggregated Balance model cannot use this feature, because the balance model cannot be changed after onboarding.
Before you start
Confirm all three before taking the merchant through the steps:- Dedicated Balance. In the Merchant Portal, open Payments Accounts > All Balances. The line under the page title reads Dedicated balance for a Dedicated Balance account.
- A supported currency. Fund splitting can be enabled for AUD, USD, JPY, VND, ARS, IDR, INR, and KES.
- Fund splitting enabled for that currency. Hello Clever enables it per currency. Without it, every request fails with
Fund splitting is not enabled for this currency.
Getting a merchant started
1
Step 1: Create a Payments Account to collect payments
The merchant clicks Create account in the top-right corner of the Merchant Portal and adds a Payments Account for collecting customer payments. This is the Collecting Payments Account.The merchant creates Payins with this account’s
app-id and secret-key.2
Step 2: Create the Allocation Accounts
The merchant adds one Payments Account for each party that will receive a share, for example one per seller, again with Create account. Each must be in the same currency as the Collecting Payments Account. New accounts appear in the Payments Accounts table on the All Balances screen with the status Active.To list the Allocation Accounts, call Get Allocation Recipient Accounts with the Collecting Payments Account’s
app-id and secret-key. The response gives each account’s account_uuid. The Collecting Payments Account is never listed, because it cannot receive an allocation share.3
Step 3: Configure an allocation profile
Allocation profiles are created in the Merchant Portal.
- Select the currency, open Payments Accounts > All Balances, and click Manage allocation profiles. The Allocation Profiles list shows each profile and its status.
- Click + next to Allocation Profiles.
- Under General, enter a Profile name.
- Under Allocation Rules, enter the Platform fee: a percentage of the transaction amount, plus an optional fixed amount in the profile currency. Leave the fixed amount at
0.00for a percentage-only fee. - Under Recipients, enter an Allocation share for each slot (Recipient 1, Recipient 2, and so on). A profile has up to five slots. The allocation shares must add up to 100% on their own. The platform fee is taken first and is not part of that total: the shares divide what is left after it. You do not choose accounts here: they are named in the API call in step 4.
- Review Live Preview. Enter a typical Transaction amount and select each Payment method the merchant accepts: PayID, Visa, Mastercard, American Express (Amex), and Diners, each domestic and international, plus Other card. Each method shows its Processing fee. The Collecting Payments Account panel shows the amount allocated to each recipient, Platform fee collected, Processing fee, and Amount (Net). Each recipient panel shows its Transaction amount and Amount (Net).
- Click Save. The profile appears in the list as Active.
- Select the profile and click the copy icon next to Profile ID (
map_...). The merchant needs this ID in step 4.
A saved profile cannot be edited in this release: the Edit button is unavailable. To change an allocation, create a new profile and click Deactivate on the old one. A deactivated profile cannot be used on new Payins.
4
Step 4: Use the APIs to process payments and allocate funds
The merchant adds an
allocation_profile object to each v2 Payin, or to each Payment Gateway 3 payin link, using the Collecting Payments Account’s keys:uuid: the Profile ID from step 3. The profile must be Active and in the Payin currency.recipients: theaccount_uuidvalues from step 2, in slot order. The first account receives the Recipient 1 share. Send exactly one Allocation Account per slot, each only once, and never the Collecting Payments Account.
allocation_profile. For a payin link, it appears once the customer has paid. Have the merchant test the full flow in sandbox first. See Split Payins with platform fees for complete requests, responses, and sandbox testing.Checking the result
For example, with a profile set to a 5% platform fee, a fixed amount of AUD 2.00, Recipient 1 at 40%, and Recipient 2 at 60% (40 + 60 = 100), an AUD 1,000.00 PayID Payin is allocated like this:
What the merchant sees:
- Allocation Accounts: each share appears as its own Payin in that account’s history, linked to the original Payin. Allocation Accounts do not receive a separate webhook.
- Collecting Payments Account: the original Payin, with the platform fee it collected. The webhook goes to this account’s endpoint, as for any Payin.
- Card payments: the allocation appears after the card is charged, once the card brand and processing fee are known. Bank transfer, PayID, QR, and other non-card Payins are allocated when the Payin is created.
- Settlement: each Payments Account settles its own balance.