These docs are for v1.2. Click to read the latest docs for v3.0.

We have introduced a new endpoints for terminal management (to support in-person payments).

  • Terminals:Create; use this endpoint to create a terminal for a service location. You need to have an activation code (will be presented on the payment terminal). If you are a partner and have access to your sub-merchants you can also create a terminal for a service location from one of your sub-merchants. Note you need to have additional rights to use this endpoint.
  • Terminals:Delete; if you want to remove a terminal from a service location you can use this endpoint. Also here; if you are a partner you need to have access to that merchant to be able to remove a terminal for a sub-merchant. Note you can undelete your delete action within a 15 min time windows with the Terminals:Undelete endpoint.

With the introduction of V3 of our API’s we have introduced our new transaction processing platform; called the Transaction Gateway Unit platform. Together with this TGU platform we have released V1 of our Order API.

The main benefits of this Order API;

  • Brand new API's for the processing of transactions on our Transaction Gateway Unit platform
  • Support to handle multiple payments to pay for an order. E.g. an order can be paid with a voucher and with an iDEAL transaction.
  • Fully compatible with iDEAL 2.0 and all of iDEAL's new features (like fast checkout). See this page for more information: https://developer.pay.nl/docs/ideal
  • All new features (and new payment methods) will be introduced on this TGU platform
  • Easy switching between different TGU's when a TGU is unavailable due to disruptions or maintenance

We strongly advise to change your implementation to use these new Order API’s, please contact your contact person within Pay for more information.

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

The Christmas update

by Tom Bossink

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

Improvements

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.

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.

The second may update

by Tom Bossink

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:

Other small improvements

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.

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