Request transaction reports

If you want to get detailed statistical information regarding the transactions your (sub)merchants has done (e.g. to calculate the amount for the invoice you need to sent to your (sub)merchant, you can use the Statistics:Management endpoint.

This endpoint supports filtering and grouping. With filtering you can e.g. specify the period and with grouping you can group the results in max 2 levels.

E.g. if you want to get statistical information for transactions done in May 2025 for all your sub-merchants grouped per paymentMethod, you can use the following request:

https://rest.pay.nl/v2/statistics/management ?startDate=2025-05-01&endDate=2025-05-31 &groupBy[0]=merchantCode &groupBy[1]=paymentMethod

Results will look like:

{
    "statistics": [
        {
            "id": "M-3421-2120",
            "label": "Classic Stores",
            "data": [
                {
                    "id": "10",
                    "label": "iDEAL",
                    "data": [
                        {
                            "volume": 258,
                            "costs": 3,
                            "transactions": 13,
                            "averagePaidAmount": 20,
                            "internalVolume": 258,
                            "externalVolume": 0,
                            "totalVolume": 258
                        }
                    ]
                },
                {
                    "id": "138",
                    "label": "PayPal",
                    "data": [
                        {
                            "volume": 2,
                            "costs": 0,
                            "transactions": 1,
                            "averagePaidAmount": 2,
                            "internalVolume": 0,
                            "externalVolume": 2,
                            "totalVolume": 2
                        }
                    ]
                }
            ]
        }
    ]
}

the groupBy[0]=merchantCode indicates that the first level of grouping is on merchantCode, thus on (sub)merchant level.

the groupby[1]=paymentMethod indicates that the second level of grouping is on paymentMethod level.

The data object, contains the following fields

Pay out clearings through your own platform

📘

This API is only available on our legacy api platform for now. Please use https://rest-api.pay.nl as hostname for this api.

If you want to be completely flexible when your (sub)merchants are receiving a clearing from Pay you can use the the Merchant:AddClearing API to create a clearing for your (sub)merchants. You can only use this API if the clearing frequency for your (sub)merchant is set to MANUAL.

This function should be called after 05.00am CET as the daily totals of the clearings are calcuated at 4.00 AM CET each day.

Use the following recipe for a step-by-step walkthrough of this API

Settle your invoices with the balance of your (sub)merchant

📘

This API is only available on our legacy api platform for now. Please use https://rest-api.pay.nl as hostname for this api.

You can add an invoice for your (sub)merchant with the Merchant:AddInvoice API. This invoice can contain your platform costs and the transaction costs that you want to invoice to your sub-merchant.

The invoice amount will be deducted from the balance of the sub-merchant and will be added to your own balance.

Use the following recipe for a step-by-step walkthrough of this API

The result of this API call is that we add two transactions (stats records) into our system;

• On partner level we will book a transaction on 'Pay. betaling - Interne betaling (BIJ)' with the invoice amount you have specified in the API call
• On (sub)merchant level we will book a transaction on 'Pay. betaling - Interne betaling (AF)' with the invoice amount you have specified in the API call.