Manage the Money Flow
Retrieve Transaction Reports
Would you like detailed insight into the transactions of your (sub)merchants? You can use the Statistics:Management endpoint.
This allows you to:
- Generate revenue reports
- Analyze transaction costs
- Calculate invoices for merchants
- Group results by merchant or payment method
- Filter reports by specific periods
The endpoint supports both filtering and grouping of results. This makes it easy to create reports that align with your administrative processes.
View Insights in the PAY. Portal
In addition to using the API, you can also gain direct insight into transactions, revenue, and payouts through the PAY. portal. Here you will find various reports and dashboards that allow you to analyze the financial performance of your merchants without requiring a technical integration.
For a comprehensive overview of the available insights and reports, please refer to the Help Center article Insights:
👉 https://support.pay.nl/nl/knowledge/inzichten
Available Statistical Data
The reporting includes, among others, the following data:
| Field | Description |
|---|---|
| Volume | The total transaction volume |
| Costs | Transaction fees charged by PAY. |
| Transactions | The total number of transactions |
| Average Paid Amount | The average paid amount |
| Internal Volume | Volume of transactions where PAY. processes the money flow |
| External Volume | Volume of transactions where PAY. is not involved in the money flow |
| Total Volume | Total volume (internal + external) |
Using this data, you can, for example, determine which costs should be passed on to your merchants or perform additional analyses.
More information
View the complete technical documentation for the Statistics:Management endpoint in the Developer API documentation.
Manage Payouts Yourself Through Your Platform
Would you like full control over when your (sub)merchants receive a payout? You can manually create payouts (clearings) through the API.
When Is This Possible?
This functionality can only be used when the merchant's payout frequency is set to MANUAL.
Important Consideration
Daily clearing totals are calculated every day at approximately 04:00 CET. Therefore, we recommend executing this API request only after 05:00 CET.
Use Cases
Manual clearings are particularly useful when:
- You decide when merchants are paid out.
- You want to perform additional checks before funds are released.
- You want to align payouts with your own processes or contractual agreements.
- You operate a marketplace or platform model where payouts are centrally controlled.
More information
Refer to the Merchant:AddClearing Developer API documentation for implementation details.
Settle Invoices Against the Merchant Balance
In addition to payouts, you can also settle costs against the available balance of a (sub)merchant. To do this, you can register an invoice through the API.
What Can Be Invoiced?
An invoice may include, for example:
- Platform fees
- Service fees
- Transaction fees
- Subscription fees
- Other agreed charges
The invoice is then automatically processed within the merchant's balance.
How Does Settlement Work?
When an invoice is created:
- The invoice amount is deducted from the balance of the (sub)merchant.
- The same amount is added to the balance of your partner account.
This enables direct settlement within the PAY. platform without requiring a separate payment transaction.
Administrative Processing
When an invoice is processed, PAY. automatically records two internal transactions:
| Level | Transactie |
|---|---|
| Partner Account | Internal credit of the invoice amount |
| (Sub)merchant | Internal debit of the invoice amount |
This ensures the money flow remains fully transparent in the administration of both the partner and the merchant.
More information
For technical implementation details, please refer to the documentation for Merchant:AddInvoice.
Summary
With the PAY. API, as a platform or partner, you can
✅ Retrieve detailed transaction reports
✅ Manage payouts manually
✅ Settle costs and invoices against merchant balances
✅ Maintain full control over the money flow within your platform
If your primary need is operational reporting and dashboards, many insights can also be viewed directly in the PAY. portal through the Help Center article Insights.
For technical API specifications, request examples, and implementation instructions, please refer to the PAY. Developer documentation: https://developer.pay.nl/docs/manage-the-money-flow