Introduction

A license (AL-…) links an Account (A-…) to a Merchant (M-…). It is one of the core merchant management objects.

Use licenses to:

register persons related to the merchant (contact persons, staff)
supply KYC data (UBO, authorised to sign, PEP)
grant or restrict access to my.pay.nl via authorisation groups

During merchant registration you can already add persons. Use the Licenses APIs when you need to add or update persons afterwards, or as part of onboarding.

Using our API's

Endpoint	Use
Licenses:Create	Add a person / license under a merchant. If the supplied e-mailaddress does not exists in our system a new account will also be created.
Licenses:Browse	Full details for a merchant (`merchant` required)
Licenses:List	Lightweight list (`code`, `name`, `language`) for for dropdowns or lookups without pagination
Licenses:Get	Single license
Licenses:Update	Update rights, notifications or compliance data
Licenses:Delete	Remove a license (soft-delete)
Licenses:Undelete	Restore within 15 minutes

Creating a license

Call Licenses:Create. Required: person. Optional: merchantCode.

Configure at least:

identity (firstName, lastName, email, …)
platform — login rights (loginAccount, authorisation / authorisationGroups)
notificationGroup — technical / financial / operations
complianceData — when the person is a UBO and/or authorised to sign

Step-by-step:

After creating UBO/signee licenses, continue onboarding via Merchant:Info and Documents:Add.

Browse vs List

Browse — full license objects for one merchant (KYC / admin screens)
List — minimal fields for dropdowns and lookups; merchant optional without pagination

Delete and undelete

Delete soft-removes the license.
Undelete is only possible within a 15 minute window.