With multi pay-in, you can collect the funds processed by all your payment service providers (pay-in partners), and split them between the balance accounts in your balance platform.
On this page, you'll learn how you can:
- Transfer and allocate funds from your multi pay-in account to your balance accounts
- Identify webhooks triggered by multi pay-in transfers
- Reconcile third-party payments using reports
Requirements
Take into account the following requirements, limitations, and preparations for this service.
| Requirement | Description |
|---|---|
| APIÂ credentials | You must have credentials for the Checkout API. |
| Webhooks | Subscribe to any of the following webhooks: |
| Limitations | Make sure that you can allocate each individual payment to your balance accounts within 24 hours, counting from the time they settle in your multi pay-in account. This is needed to comply with financial regulations. |
Allocate funds
To transfer and allocate the funds held your multi pay-in account to the balance accounts in your platform, make a POST /payments request for each individual payment.
In the body of the request, include the following fields:
| Parameter | Required | Description |
|---|---|---|
amount |
The amount of the payment you want to transfer from your multi pay-in account to your balance accounts. | |
paymentMethod.type |
The type of the payment method. Set to multi_payin. | |
additionalData.tokenDataType |
The type of the token used for the service. Set to MultiPayIn. | |
additionalData.BalancePlatform.balanceAccount |
The unique identifier of the multi pay-in account, starting with the BA prefix. | |
merchantAccount |
The unique identifier of the merchant account where you want to process the payment. | |
reference |
Your reference for the payment, returned as merchantReference in the response. |
|
splits |
The array of objects specifying how to split the payment. The funds are allocated in your balance platform according to the instructions you include in this array. |
For each item in the splits array, specify the following parameters:
| Parameter | Required | Description |
|---|---|---|
account |
Your user's or your platform's balanceAccountId, to which you want to allocate the specified amount. You do not need to specify this field when type is Commission. |
|
amount.currency |
The currency of the part of the payment you want allocate to the specified account. |
|
amount.value |
The value of the part of the payment you want to allocate to the specified account. |
|
type |
The part of the payment you want to book to the specified account.Possible values:
|
|
reference |
Required for type BalanceAccount |
Your unique identifier for the part of the payment you want to book to the specified account. You will need this reference for refunds and reconciliation purposes. |
description |
Your description for the part of the payment you want to allocate to the specified account. This is also reflected in our reports. |
To make reconciliation easier, we recommend always to include split instructions for the transaction fees in your request. If you do not include booking instructions for any of the transaction fee types in your payment request, Adyen automatically books all transaction fees to your liable balance account. This is also reflected in your Balance Platform Accounting Report.
Here is an example of how you can allocate the funds from a USD 400.00 payment processed through a pay-in partner:
- You book USD 396.00 to your user's balance account as payment for the goods or service.
- You book USD 4.00 to your liable balance account as your commission.
- You instruct Adyen to deduct the associated fees from your liable balance account.
In the response, your reference from the request is returned as the merchantReference. You need this information for reconciliation.
Get notified about fund movements
Each fund transfer in your balance platform triggers three Transfer webhooks and a Transaction webhook.
The following tabs show the webhooks you receive when:
- The funds are deducted from your multi pay-in account
- The funds are credited to your user's balance account
- The commission is credited to your liable balance account
- The fees are deducted from your liable balance account
Reports and reconciliation
In the Balance Platform Accounting Report, we include all balance changes on all balance accounts in your balance platform, including your multi pay-in account, liable balance account, and your user's balance account.
The following table is an excerpt from the Balance Platform Accounting Report that would be generated based on the example payment request above.
| BalancePlatform | AccountHolder | BalanceAccount | Transfer Id | Transaction Id | Category | Status | Type | Booking Date | Booking Date TimeZone | Value Date | Value Date TimeZone | Currency | Amount | Payment Currency | Received (PC) | Reserved (PC) | Balance (PC) | Reference | Description | Counterparty Balance Account Id | Psp Payment Merchant Reference | Psp Payment Psp Reference | Psp Modification Psp Reference | Psp Modification Merchant Reference | Brand Variant | Reference for Beneficiary | Platform Payment Interchange | Platform Payment Scheme Fee | Platform Payment Markup | Platform Payment Commission | Platform Payment Cost Currency |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| YOUR_BALANCE_PLATFORM | AH00000000000000000000001 | BA00000000000000000000005 | 3JERI65VWKBRFIVB | internal | received | internalTransfer | 04/06/2024 11:45 | CET | USD | -400.00 | USD | -400.00 | 0.00 | 0.00 | BA00000000000000000000001 | balanceaccount | |||||||||||||||
| YOUR_BALANCE_PLATFORM | AH00000000000000000000001 | BA00000000000000000000005 | 3JERI65VWKBRFIVB | internal | authorised | internalTransfer | 05/06/2024 11:45 | CET | USD | -400.00 | USD | 400.00 | -400.00 | 0.00 | BA00000000000000000000001 | balanceaccount | |||||||||||||||
| YOUR_BALANCE_PLATFORM | AH00000000000000000000001 | BA00000000000000000000005 | 3JERI65VWKBRFIVB | EVJN42272224222B5JB8BRC84N686ZUSD | internal | booked | internalTransfer | 06/06/2024 11:45 | CET | 04/06/2024 13:30 | CET | USD | -400.00 | USD | 0.00 | 400.00 | -400.00 | BA00000000000000000000001 | balanceaccount | ||||||||||||
| YOUR_BALANCE_PLATFORM | AH00000000000000000LIABLE | BA00000000000000000LIABLE | 3JERII605AZ6HCNB | platformPayment | authorised | capture | 07/06/2024 11:45 | CET | USD | 4.00 | USD | -4.00 | 4.00 | 0.00 | Your reference for the commission | Your description for the commission | YOUR_REFERENCE | HGGKZCD6J3RZNN82 | PPKFQ89R6QRXGN82 | MRef#000001 | payment_pspCapture | Your reference for the commission | |||||||||
| YOUR_BALANCE_PLATFORM | AH00000000000000000LIABLE | BA00000000000000000LIABLE | 3JERII605AZ6HCNB | platformPayment | received | capture | 08/06/2024 11:45 | CET | USD | 4.00 | USD | 4.00 | 0.00 | 0.00 | Your reference for the commission | Your description for the commission | YOUR_REFERENCE | HGGKZCD6J3RZNN82 | PPKFQ89R6QRXGN82 | MRef#000001 | payment_pspCapture | Your reference for the commission | |||||||||
| YOUR_BALANCE_PLATFORM | AH00000000000000000000001 | BA00000000000000000000001 | 3JERII605AZ69MR8 | platformPayment | received | capture | 09/06/2024 11:45 | CET | USD | 396.00 | USD | 396.00 | 0.00 | 0.00 | Your reference for the split | Your description for the split | YOUR_REFERENCE | HGGKZCD6J3RZNN82 | PPKFQ89R6QRXGN82 | MRef#000001 | payment_pspCapture | Your reference for the split | |||||||||
| YOUR_BALANCE_PLATFORM | AH00000000000000000000001 | BA00000000000000000000001 | 3JERII605AZ69MR8 | platformPayment | authorised | capture | 10/06/2024 11:45 | CET | USD | 396.00 | USD | -396.00 | 396.00 | 0.00 | Your reference for the split | Your description for the split | YOUR_REFERENCE | HGGKZCD6J3RZNN82 | PPKFQ89R6QRXGN82 | MRef#000001 | payment_pspCapture | Your reference for the split | |||||||||
| YOUR_BALANCE_PLATFORM | AH00000000000000000LIABLE | BA00000000000000000LIABLE | 3JY1YI605AZ65FPF | EVJN4293Q224223G5KPHPX72VM4R2NUSD | platformPayment | captured | capture | 11/06/2024 11:45 | CET | 04/06/2024 13:30 | CET | USD | -2.40 | USD | 0.00 | 2.40 | -2.40 | Your reference for the fees charged by Adyen | Your description for the fees charged by Adyen | YOUR_REFERENCE | HGGKZCD6J3RZNN82 | PPKFQ89R6QRXGN82 | MRef#000001 | payment_pspCapture | Your reference for the fees charged by Adyen | 0.00 | 0.00 | 0.00 | -2.40 | USD | |
| YOUR_BALANCE_PLATFORM | AH00000000000000000LIABLE | BA00000000000000000LIABLE | 3JY1YI605AZ65FPF | platformPayment | authorised | capture | 12/06/2024 11:45 | CET | USD | -2.40 | USD | 2.40 | -2.40 | 0.00 | Your reference for the fees charged by Adyen | Your description for the fees charged by Adyen | YOUR_REFERENCE | HGGKZCD6J3RZNN82 | PPKFQ89R6QRXGN82 | MRef#000001 | payment_pspCapture | Your reference for the fees charged by Adyen | 0.00 | 0.00 | 0.00 | -2.40 | USD | ||||
| YOUR_BALANCE_PLATFORM | AH00000000000000000LIABLE | BA00000000000000000LIABLE | 3JY1YI605AZ65FPF | platformPayment | received | capture | 13/06/2024 11:45 | CET | USD | -2.40 | USD | -2.40 | 0.00 | 0.00 | Your reference for the fees charged by Adyen | Your description for the fees charged by Adyen | YOUR_REFERENCE | HGGKZCD6J3RZNN82 | PPKFQ89R6QRXGN82 | MRef#000001 | payment_pspCapture | Your reference for the fees charged by Adyen | 0.00 | 0.00 | 0.00 | -2.40 | USD | ||||
| YOUR_BALANCE_PLATFORM | AH00000000000000000LIABLE | BA00000000000000000LIABLE | 3JERII605AZ6HCNB | EVJN42CMP224223G5KPHPX88BM5KQLUSD | platformPayment | captured | capture | 14/06/2024 11:45 | CET | 04/06/2024 13:30 | CET | USD | 4.00 | USD | 0.00 | -4.00 | 4.00 | Your reference for the commission | Your description for the commission | YOUR_REFERENCE | HGGKZCD6J3RZNN82 | PPKFQ89R6QRXGN82 | MRef#000001 | payment_pspCapture | Your reference for the commission | ||||||
| YOUR_BALANCE_PLATFORM | AH00000000000000000000001 | BA00000000000000000000001 | 3JERII605AZ69MR8 | EVJN42CLN224223G5KPHPX97F34TK6USD | platformPayment | captured | capture | 15/06/2024 11:45 | CET | 06/06/2024 13:30 | CET | USD | 396.00 | USD | 0.00 | -396.00 | 396.00 | Your reference for the split | Your description for the split | YOUR_REFERENCE | HGGKZCD6J3RZNN82 | PPKFQ89R6QRXGN82 | MRef#000001 | payment_pspCapture | Your reference for the split |
Pay out
After the funds are settled in your user's balance account, they are paid out according to your already configured payout schedule. Alternatively, you can trigger an on-demand payout if needed. The payout process is the same as for the funds acquired by Adyen.