Alliance Partners - Managing Submerchant Cash Flows
1. Retrieve Submerchants
Receive a list of all submerchants.
https://developer.pay.nl/reference/get_merchants
2. Retrieve Transaction Reports for Your Merchants
If you want to receive detailed statistical information about the transactions performed by your (sub)merchants, for example to calculate the invoice amount that you need to charge to your (sub)merchant, you can use the Statistics:Management endpoint.
https://developer.pay.nl/docs/manage-the-money-flow#request-transaction-reports
3. Pay Out Clearings Through Your Own System
If you want full flexibility regarding when your (sub)merchants receive a settlement from Pay., you can use the Merchant:AddClearing API to create a clearing for your (sub)merchants. This API can only be used if the settlement frequency for your (sub)merchants is set to MANUAL.
This functionality must be called after 05:00 CET, as daily clearing totals are calculated every day at 04:00 CET.
When you, as a merchant or partner, initiate a withdrawal through the Merchant:AddClearing API, this may cause confusion on the clearing invoice if the withdrawal amount differs from the sum of the individual transactions. The example below explains how this works.
3.1 Example Scenario
Suppose a merchant has the following available ledger balance:
| Payment Type | Quantity | Amount |
|---|---|---|
| iDEAL | 50 | € 5,000 |
| Credit Card | 10 | € 2,000 |
| Bancontact | 5 | € 2,500 |
| Bank Transfer | 5 | € 500 |
| Total | € 10,000 |
The partner initiates a clearing through the API for € 6,000.
What happens?
- The available ledger balance is € 10,000.
- The partner only wants to pay out € 6,000.
- However, the transactions that make up the balance have not yet been included in a clearing.
- To provide a correct clearing specification and support reconciliation, we perform the following steps.
The solution on the clearing invoice
- We create an additional revenue line called "Clearing opening balance" for € -4,000 to reduce the ledger balance to the desired payout amount.
- We create the clearing including this adjustment line, resulting in the required payout of € 6,000 (€ 10,000 balance minus € 4,000).
- Afterwards, we create a second revenue line called "Clearing closing balance" for € +4,000 to offset the previous adjustment. The remaining balance is restored to € 4,000.
Example on the clearing invoice
| Payment Type | Quantity | Amount |
|---|---|---|
| iDEAL | 50 | € 5,000 |
| Credit Card | 10 | € 2,000 |
| Bancontact | 5 | € 2,500 |
| Bank Transfer | 5 | € 500 |
| Pay.payment - Clearing opening balance | 1 | - € 4,000 |
| Total | € 6,000 |
The Clearing closing balance will appear afterwards as a correction to offset the earlier opening balance.
In the next clearing, the amount will be used again as the starting balance. In the example below, the available balance is € 14,000 and a clearing of € 12,000 is created.
| Payment Type | Quantity | Amount |
|---|---|---|
| Pay.payment - Clearing closing balance | 1 | € 4,000 |
| iDEAL | 45 | € 4,500 |
| Credit Card | 12 | € 3,000 |
| Bancontact | 5 | € 1,500 |
| Bank Transfer | 5 | € 1,000 |
| Pay.payment - Clearing opening balance | 1 | - € 2,000 |
| Total | € 12,000 |
3.2 Why Is This Important?
This ensures that merchants can correctly reconcile their transactions with the clearing in which the actual payout took place.
All transactions that contributed to the ledger balance have already been included in the clearing related to that payout. They are therefore not included again in a later clearing, preventing duplicate entries.
3.3 Important for Partners
If you use a withdrawal amount in the API that is lower than the current ledger balance, we automatically create an internal opening balance/closing balance adjustment for the difference.
These adjustments are not paid out and exist purely for correct reporting and reconciliation purposes.
4. Settle Invoices Using the Balance of a Submerchant
With the Merchant:AddInvoice API, you can add an invoice for your (sub)merchant. This invoice can include your platform fees as well as the transaction fees that you want to charge to your (sub)merchant.
The invoice amount is deducted from the balance of the (sub)merchant and added to your own balance.