We have released a few changes in the last months. Below a summary👇

Changes

• It was already possible to start a transaction with the Transaction:Create API with an SL-code and secret as authentication. It is now also possible to request the status of the transaction with the Transaction:Statuswith an SL-code and secret on rest.pay.nl.
• We have added pagination to the Terminals:Browse endpoint
• We fixed a typo in the Transaction:Refundendpoint. The description is has a maxLength of 32 instead of 64
• We have added a new endpoint Payout:Clearing, with this endpoint you can create an instant clearing on the revenue group linked to the provided service. If you want to use this endpoint, please contact your accountmanager. Specific rights are needed if you want to use this endpoint.
• We have added a boardingStatus and a payoutStatus field to the Merchants:Get, Merchants:Browse and Merchants:Info. A full description of these statusses can be found here: https://developer.pay.nl/docs/object-status

We have released a few small updates in the past weeks, see it as a Christmas gift 🎄🧑‍🎄. Read more below 👇

Improvements

• When updating a license to an UBO or to an authorized to sign person or when creating a license which is an UBO or authorized to sign person we will automatically request for an identification (document). In the response of the update or create call an identification document is now requested.
• The available balance per turnovergroup is added to the Balance:Dashboard (https://developer.pay.nl/reference/get_balance)
• In the Merchant:Update (https://developer.pay.nl/reference/patch_merchants-merchantcode) we have added the country of residence. You are now able to update this country of residence (for a merchant). Note this will trigger a review of the merchant file.
• We have implemented a few improvements in the Transaction:Create API
  • The BTW number is now successfully stored when creating a transaction;
  • The validation on regionCode (in the delivery address and invoice address) is removed and this field is added to the documentation.
• In the Merchants:Info (https://developer.pay.nl/reference/get_merchants-merchantcode-info) API we have added the Pay. account manager and for each sales/service location the website and the websiteURLs that are configured in the output.
• In the Terminals:Browse (https://developer.pay.nl/reference/get_terminals) and Terminals:Get (https://developer.pay.nl/reference/get_terminals-terminalcode) we have added the supplier of the terminal and for each brand the Acquirer and AcquirerMID to the output.
• We fixed an issue in the Transaction:Refund (https://developer.pay.nl/reference/patch_transactions-transactionid-refund), the correct RefundID is now returned.

We have released quite a few new endpoints in the last months. Read more below 👇

New endpoints

We have released quite a few new endpoints. Note for all these endpoints you need to have the proper rights.

• Licenses: Get, Browse, Create, Update, Delete and Undelete. See for more info: https://developer.pay.nl/reference/get_licenses-licensecode. These endpoints can be used e.g. to add a new license (account) to a (sub-)merchant. You can also add the compliance data (e.g. UBO status etc).
• ContactMethods:Get, Browse, Create, Update, Delete and Undelete. See for more info: https://developer.pay.nl/reference/get_contactmethods-contactmethodcode. These endpoints can be used e.g. to add a new contact method to a (sub-)merchant.
• AuthenticationTokens:Get, Browse, Create, Delete and Undelete. See for more info: https://developer.pay.nl/reference/get_authenticationtokens-authenticationtokencode. These endpoints can be used e.g. to add an authentication token to a (sub-)merchant.
• Turnovergroups:Get, Browse, Create, Delete and Undelete. See for more info: https://developer.pay.nl/reference/get_turnovergroups-turnovergroupcode. These endpoints can be used e.g. to add an turnovergroup to a (sub-)merchant.
• ClearingAccounts:Get, Browse, Create, Delete and Undelete. See for more info: https://developer.pay.nl/reference/get_clearingaccounts-clearingaccountcode. These endpoints can be used e.g. to add a clearingaccount to a (sub-)merchant.
• Merchant:Update. See for more info: https://developer.pay.nl/reference/patch_merchants-merchantcode. This endpoint can be used to update merchant data.
• Merchant:UpdatePackage. See for more info: https://developer.pay.nl/reference/patch_merchants-merchantcode-package. This endpoint can be used to update the package. To get a list of available packages you can use the Packages:Get (https://developer.pay.nl/reference/get_packages) endpoint. When updating the corresponding settings which belong to that package will be applied.
• Merchant:ToReview. See for more info: https://developer.pay.nl/reference/patch_boarding-merchantcode-ready. This endpoint can be used to notify our boarding department that the merchant is ready to be reviewed.

Other improvements

• In the Transaction:Create response we have added a few new data elements when an instore payment has been done.
  • A hash; a unique key of the transaction which can be used to get the status of the payment or the request a receipt
  • A cancelURL; an URL which can be used to cancel the instore payment
  • An orderStatusURL; an URL which can be used to retrieve the status of the instore payment

We call this update the early summer ☀️ update. We have released a few updates and a new endpoint. Read more below 👇

Reporting

We have released a new endpoint that gives an overview of the active balance of a merchant, inlcuding information about the next and previous clearing. If you are a partner and supply a merchant code and you have access to that merchant we will provide the data from that merchant. If no merchant code is provided your own balance information is returned. Note you need to have the correct rights to use this endpoint.

Read more here: https://developer.pay.nl/reference/get_balance

Other improvements

• In the Authorisation:Capture, the Transaction:Status and the Transaction:Info response the merchant reference is now returned instead of the consumer reference.
• In the Terminals:Browse you can now supply a merchant code as query parameter to filter the list of terminals for a certain merchant. See for more information: https://developer.pay.nl/reference/get_terminals.
• Some query parameters in the Invoice:Lines and Clearing:Lines endpoints where not correctly described in the documentation, we fixed that.
• In the Merchant:Create endpoint you can now supply a visitAddress for each person/account.
• The Documents:Add endpoint now supports multiple files (of the same file-type), these files will be merged into one document.

Again we have released an update. The second one in May 👏. This release contains a few updates and new endpoints. Read more below 👇

Merchant management

We have released new endpoints to retrieve:

• Invoice lines; with this endpoint you can retrieve the invoice lines. If you are a partner and have access to your sub-merchants you can retrieve also the invoice lines for your sub-merchants, see for more information. https://developer.pay.nl/reference/get_invoicelines .
• Clearing lines; with this endpoin you can retrieve the clearing lines. If you are a partner and have access to your sub-merchants you can retrieve also the clearing lines for your sub-merchants, see for more information: https://developer.pay.nl/reference/get_clearinglines.
• An invoice/clearing line contains a unit type (e.g. per percentage or per quantity). We have a Core API available to retrieve all unit types Pay is using (https://developer.pay.nl/reference/get_billingunittypes).
• Furthermore an invoice/clearing line contains a billing or clearing type, e.g. to invoice iDeal transactions or to indicate we have cleared iDeal transactions. We have a two Core API availables to retrieve:
  • All billing types incl. how they are grouped on the invoice available (https://developer.pay.nl/reference/get_billinglinetypes)
  • all clearing types incl. how they are grouped on the clearing available (https://developer.pay.nl/reference/get_clearinglinetypes

Other small improvements

• The Service:GetConfig response now contains a list of available TGU's; see for more information (https://developer.pay.nl/reference/get_services-config). For more information regarding the Pay platform and TGU's please refer to; https://developer.pay.nl/docs/platform
• The Core API to retrieve the languages that Pay supports (https://developer.pay.nl/reference/get_languages) referred to an .png image. However in the image pack that we supply only .svg images are available. We now refer to the correct .svg image in the API.

We have released a small update with two new endpoints. Read more below 🙌

Merchant management

We have released new endpoints to:

• Suspend a merchant; see for more information; https://developer.pay.nl/reference/delete_merchants-merchantcode
• Unsuspend a merchant; see for more information; https://developer.pay.nl/reference/post_merchants-merchantcode-unsuspend

We have released an update. Read more below 👏

Core data; BillingLineTypes and UnitTypes

We have introduced new endpoints to retrieve Core data for the new Billing API that will be launched soon.

• BillingLineTypes; a Pay. invoice contains multiple billing lines which are grouped. This API returns all groups that are available. See for more information; https://developer.pay.nl/reference/get_billinglinetypes
• UnitTypes; each invoice line can have his own unit (e.g. per quantity or per percentage). This API returns all unit types that are available. See for more information; https://developer.pay.nl/reference/get_billingunittypes

PaymentVerificationMethods

A payment can be secured by different methods. On a card present transaction (on a payment terminal) it is known ad the Card Verification Method (CVM). iDEAL transactions can be verified by e.g. a QR code or by an app2app payment. We combine all these options in the PaymentVerificationMethods

With the Core data API; PaymentVerificationMethods you can retrieve a list of all methods. See for more information; https://developer.pay.nl/reference/get_paymentverificationmethods

And with the Transaction:Status and Transaction:Info endpoints the used method is returned if it is available.

Support for different "base URLs"

For the Transaction:Create, Transaction:Status and Transaction:Info endpoints support for different base URLs is added. In this documentation environment you can select (in the API explorer) against which base URL you want to try you API request.

Merchant:Create

We have introduced a few changes in the Merchant:Create endpoint

• The Pay. welcome e-mail will only be sent if loginAccount=true.
• The phone number and e-mail adress of a person is now optional. It is not required anymore

We have released quite a big update. Read more below 👏

AuthorisationGroups

We have introduced a new endpoint to retrieve the AuthorisationGroups (https://developer.pay.nl/reference/get_authorisationgroups). If you call this API then you will retrieve PAY.'s public groups. If your account has rights to create own groups, you will also retrieve these groups.

Merchant:Create

We have introduced several enhancements to this endpoint:

• You can submit one or more clearing accounts
• You can supply compliance data (e.g. pep indication, ubo status etc) for each person linked to the merchant
• You can directly create authentication tokens. You can indicate which authorisation groups needs to be linked to this token.
• The account will be linked to the merchant if there is already an account available for the e-mail address that is supplied. Note; the account needs to accept in the PAY. admin that he/she is related to that company.
• You can directly indicate which authorisation groups needs to be linked to the account that you have created
• We return the secrets (ie the token , the service secret and the license secret), these can be used in other API calls.

The full API definition, including some samples can be found here; https://developer.pay.nl/reference/post_merchants

Other improvements

• The Languages API also returns a link to an image URL
• The Categories API now returns the initialMCC and initialRiskCategory that is linked to each category
• The Countries API also returns nationality data, including translations;
• The Merchant:GetConfig endpoint is removed, instead the Service:GetConfig endpoint is changed. You can authenticate with an AT-code/token or with an SL-code/secret. If AT-code/token is used the serviceID needs to be included in the body parameters. See; https://developer.pay.nl/reference/get_services-config
• The Service:GetConfig API is enlarged with encryptionKeys
• If there are no translations available (mainly in the Core API's) we now return translations: null instead of translations:[], since the translations are returned in objects instead of arrays.

We have released a few small improvements. Read more below! 🤝

Merchant:Create

if you create a merchant as a partner of Pay the merchant will be created under your partner account. For more information, please refer to: https://developer.pay.nl/reference/post_merchants

Transaction:Create

You can send a reference with refers to e.g your internal order id when you create a transaction. This field is now mapped to the correct field in the Pay. admin. With this improvement you can see which reference you have send if you open the details of a transaction. For more information, please refer to: https://developer.pay.nl/reference/post_transactions

We have introduced v2 of our API's. The mean reasons for this version bump is that we now provide error details according RFC7807 for all our API's and that we have introduced an updated response for the Service:GetConfig and Merchant:GetConfig. We have also added some minor changes. More details below 🌱

New way to provide error details

We now adhere to the Problem details for HTTP APIs standard (RFC7807; https://www.rfc-editor.org/rfc/rfc7807).

When HTTP response code 400 or 422 is returned in the body the details are provided as follow:

{
    "type": "https://tools.ietf.org/html/rfc2616#section-10",
    "title": "An error occurred",
    "detail": "merchant.name: Is empty\nmerchant.coc: Is empty",
    "violations": [
        {
            "propertyPath": "merchant.name",
            "message": "Is empty",
            "code": "PAY-2828"
        },
        {
            "propertyPath": "merchant.coc",
            "message": "Is empty",
            "code": "PAY-2828"
        }
    ]
}

Updated response of the Service:GetConfig and Merchant:GetConfig

We have introduced a new response of the Service:GetConfig and Merchant:GetConfig. With this change the frontend implementation to create your own checkout will become much more easier. For a detailed description, please check https://developer.pay.nl/docs/create-the-checkout

Other changes

• You can now authenticate the Transaction:Create API (https://developer.pay.nl/reference/post_transactions) with an SL-code and a secret besides an AT-code and a secret
• Introduced a new endpont to upload documents; Documents:Add (https://developer.pay.nl/reference/post_documents)
• Added support for the accept-languageparameter in the header. If supplied the API will return 400/422 error message in the language specified, if available. If there is no translation available, we will fallback to error messages in English.