Onboard your merchants

When you have registered your merchant, you need to supply additional onboarding data so that the merchant file can be checked by our boarding team.

Once the registration is properly submitted, transactions can usually be processed right away. As a licensed financial institution, Pay. is obligated to perform KYC (Know Your Customer) checks to prevent money laundering and the funding of illegal activities.

For this, we'll request various documents and information. After these documents are submitted and reviewed by our onboarding team, the merchant will undergo a thorough evaluation based on several factors. Once these checks are completed, PAY. can start clearing and settlement to the merchant's bank account for the processed funds.

Using our API's

Get the status

If you want to request the status of your merchants, the following endpoints are available

EndpointDescription
Merchants:BrowseReturns from all merchants configured under your account the basic data
Merchant:GetReturns the basic data for a single merchant based on the provided M-code. Note; the data in the output is the same as in the Merchant:Browse
Merchant:InfoGet detailled information for a single merchant, including clearingAccount, Licenses, AuthenticationTokens and Services data and outstanding documents requests

In all of these endpoints we are returning a status, a boardingStatus and a payoutStatus .


The status can contain:

StatusDescription
ACTIVEThe merchant is active and can process payments.
INACTIVEThe merchant is not active.

The boardingStatus can contain

StatusDescription
REGISTEREDThe merchant is registered but needs to supply additional information.
ONBOARDINGThe merchant has supplied all information needed for onboarding, merchant file is being checked by our onboarding department.
ACCEPTEDThe merchant is accepted and can process payments.
SUSPENDEDThe merchant is suspended, cannot process payments anymore but is able to login in my.pay.nl to e.g. do a refund for a transaction.
OFFBOARDEDThe merchant is offboarded, cannot process payments anymore and cannot login anymore to my.pay.nl.

The payoutStatus can contain

StatusDescription
ENABLEDClearing is enabled and will be transferred to the clearing account of the merchant
DISABLEDClearing is disabled or frozen

Providing additional KYC information

Persons associated to the merchant

Due to our KYC policies we need to have insights in all persons that are associated to the merchant. You need to provide insights in this information for our boarding department.

You can use the License:Create endpoint to deliver this information to Pay.

Use this recipe to get more insights into this endpoint


Providing documents

If you call the Merchants:Info endpoint for your merchant we return for each license /person linked to the merchant and on merchant level the needed KYC information in the documents object.

E.g.

{
    "documents": [
        {
            "code": "D-2919-1014-9000",
            "type": "coc_extract",
            "status": "REQUESTED",
            "name": "CoC extract of <company name>",
            "description": "To verify your company we need to have an extract of the Chamber of Commerce for <company name> with CoC number <nr>. This document must not be older then 6 months.",
            "translations": {
                "name": {
                    "nl_NL": "KvK uittreksel van <company name>",
                    "en_GB": "CoC extract of <company name>",
                    "de_DE": "Handelskammerauszug NOORT VASTGOED IN Teuben BVTD",
                    "fr_FR": "Extrait Kbis NOORT VASTGOED IN Teuben BVTD",
                    "it_IT": "Estratto REA (visura) NOORT VASTGOED IN Teuben BVTD"
                },
                "description": {
                    "nl_NL": "Om je bedrijf te verifiëren hebben wij een uittreksel van de Kamer van Koophandel voor <company name> met KVK nummer <nr>. Dit document mag niet ouder zijn dan 6 maanden.",
                    "en_GB": "To verify your company we need to have an extract of the Chamber of Commerce for <company name> with CoC number <nr>. This document must not be older then 6 months."
                }
            },
            "createdAt": "2025-05-01T14:25:51+02:00",
            "createdBy": null,
            "acceptedAt": null,
            "modifiedAt": null,
            "modifiedBy": null,
            "deletedAt": null,
            "deletedBy": null
        }
    ]
}


The documents can be provided using the Documents:Add endpoint

Use this recipe to get more insights into this endpoint



Send in for review

When all documents for a merchant are delivered and the merchant data is ready to be reviewed by our boarding department you can call this endpoint to notify our boarding department to review your merchant. Use the Merchant:ToReview endpoint to notify our boarding department.



In our portal

Navigate to the merchant management page in https://my.pay.nl. On this page you get an overview of all merchants that are configured under your account. You are able to filter on a certain status or you can set additional filters like M-code, company name etc.

As highlighted in the screenshot above various options are possible

OptionNameDescription
ImitateIf you have the rights to view our portal as your (sub-)merchant this option is visible. If you click on it you imitate as this merchant and you are able to see our portal in the same way the merchant sees it.
DownloadThis option allows you to download all the merchant documents
Compliance stateThis option gives you an overview of the compliance state of the merchant. Documents that are needed can be uploaded here and additional data (e.g. the date of birth) of a person/user linked to the merchant can be updated here.
Data managerThe data manager; if needed you can request additional information from your sub-merchant
Merchant dataGives an overview of the merchant data, including authentication tokens and services/sales location that are configured.

The most important options are explained in more detail in the following sections.

The compliance state option

Gives an overview of the compliance state of your (sub)-merchant.

Required compliance data can be supplied here and documents can be uploaded.

The data manager option

If you want to add additional (compliance) data or documents you can use the data manager.

If you for example want to add a 'proof of address' document, you can select this option. A popup appears where you can indicate if we should mail this request to the (sub)merchant.

The document can be added if you open the compliance state of the merchant. Here you also have the option to delete the document request.

View merchant data option

The merchant data option gives you an overview of all relevant merchant data to give support. In the screenshot below you see the data that we show.

If you have the appropriate rights you can edit or add a sales location on your merchant or activate a Softpos terminal for your merchant.