# PAY. Documentation
> PAY provides access to 75+ Payment methods by a simple API and transfers transaction data into readable and smooth management information.
## Guides
- [Introduction](https://developer.pay.nl/docs/introduction.md): Choose the right PAY integration path and find support channels for plugins, merchant integrations, and partner integrations.
- [Our platform](https://developer.pay.nl/docs/platform.md): Theses pages will help you get started with Pay. Understanding our platform and API structure.
- [Transaction Gateway Unit](https://developer.pay.nl/docs/transaction-gateway-unit.md): Processing payments is done in one of our Transaction Gateway Unit systems.
- [Global Management System](https://developer.pay.nl/docs/global-management-system.md): System to manage all settings, perform transaction management and get insights in your flows
- [Payment Option ID's / SubID's](https://developer.pay.nl/docs/payment-option-ids-subids.md): Here you will find the payment option id's (grouped by categories) and sub id's
- [Transaction Statuses](https://developer.pay.nl/docs/transaction-statuses.md)
- [Core Data](https://developer.pay.nl/docs/core-data.md): Get objects you need to process payments and perform Merchant management
- [Authentication Methods](https://developer.pay.nl/docs/authentication-methods.md)
- [Transaction Types](https://developer.pay.nl/docs/transaction-types-1.md): Here you will see the different transaction types you can use to send in the right Point of Interaction
- [Categories](https://developer.pay.nl/docs/categories.md): List of Categories that can be used to assign to a Service or Merchant
- [Account setup](https://developer.pay.nl/docs/pay-account-setup.md): Setting up your Pay. account is the first step to accessing our comprehensive range of payment services. This guide will walk you through the registration & onboarding process, ensuring that you select the necessary payment methods.
- [Manage your account](https://developer.pay.nl/docs/manage-your-account.md)
- [Getting the credentials](https://developer.pay.nl/docs/getting-the-credentials.md): Credentials are needed to authenticate against our API's, or to use our plugins or SDK's
- [Enabling payment methods](https://developer.pay.nl/docs/enabling-payment-methods.md): Enable payment methods so that you can start making payments
- [Next steps](https://developer.pay.nl/docs/next-steps.md): Start using our prebuilt plugins, our SDK's or build your own integration
- [How to use this portal](https://developer.pay.nl/docs/how-to-use.md): This developer portal is a highly interactive playground to test requests and view responses. On this we explain how to use it.
- [Terminology](https://developer.pay.nl/docs/terminology.md): Here you will find explanations for terms used in Payment Processing. If you find a text with a underline, you can hover and read more about it.
- [Objects](https://developer.pay.nl/docs/objects.md): We love objects. On this page we give an overview of all objects within our platform.
- [Parameters](https://developer.pay.nl/docs/glossary.md): Here you will find descriptions of all parameters used in API calls.
- [Statuses](https://developer.pay.nl/docs/object-status.md): A Pay. object can return a status. On this page we give an overview of all statuses.
- [Error codes](https://developer.pay.nl/docs/error-codes.md): Whenever an error occurs, an error code is included in the response body for easy identification, benefiting both you and us in quickly pinpointing the error.
- [API Definition](https://developer.pay.nl/docs/api-defenition.md): This section outlines an overview of our API standards and practises, ensuring consistent interactions. Below you will find information on our versioning and change policy, supported http codes etc.
- [No-code payments](https://developer.pay.nl/docs/no-code-payments.md): On this page we explain all the ways you can create no-code payments through the Collect Desk in my.pay.nl or in our apps.
- [Payment link by E-mail](https://developer.pay.nl/docs/payment-link-by-e-mail.md): Create payment links in a few steps!
- [Payment link by SMS](https://developer.pay.nl/docs/payment-link-by-sms.md): Create payment links in just a few steps
- [QR-code payments](https://developer.pay.nl/docs/payment-link-by-qr-code.md): Creating QR codes
- [Instore payment](https://developer.pay.nl/docs/instore-payment-1.md): Start a transaction on your physical payment terminal in no time!
- [Gift card redeem](https://developer.pay.nl/docs/gift-card-redeem.md): Easily redeem giftcards online or instore
- [Pay by creditcard](https://developer.pay.nl/docs/payment-credit-card.md): Easily charge a creditcard by a mail or telephone order
- [Sepa direct debit](https://developer.pay.nl/docs/payment-link-by-sepa-direct-debit.md): Easily send a direct debit request.
- [Plugins](https://developer.pay.nl/docs/plugins.md)
- [CCV Shop](https://developer.pay.nl/docs/ccv-shop.md): In this section we will explain the steps needed to connect your account to CCV Shop.
- [CS-Cart](https://developer.pay.nl/docs/cs-cart.md)
- [Magento2](https://developer.pay.nl/docs/magento2.md): In this section we will explain the steps needed to connect your account to Magento2.
- [Lightspeed](https://developer.pay.nl/docs/lightspeed.md): In this section we will explain the steps needed to connect your account to Lightspeed.
- [Opencart3](https://developer.pay.nl/docs/opencart.md): In this section we will explain the steps needed to connect your account to Opencart3.
- [Prestashop](https://developer.pay.nl/docs/prestashop.md): In this section we will explain the steps needed to connect your account to Prestashop.
- [Shopify](https://developer.pay.nl/docs/shopify.md): In this section we will explain the steps needed to connect your account to Shopify.
- [Shopware6](https://developer.pay.nl/docs/shopware6.md): In this section we will explain the steps needed to connect your account to Shopware.
- [VirtueMart](https://developer.pay.nl/docs/virtuemart.md)
- [WooCommerce](https://developer.pay.nl/docs/woocommerce.md): In this section we will explain the steps needed to connect your account to WooCommerce.
- [Libraries & SDK's](https://developer.pay.nl/docs/libraries-sdks.md): Next to plugins we also provide production ready Libraries & SDK's to make working with our services easier.
- [Partner integrations](https://developer.pay.nl/docs/partner-integrations.md): This page is under construction. More Partner Integrations will be added soon.
- [Built by partners](https://developer.pay.nl/docs/built-by-partners.md): Powerful Integrations from our trusted partners
- [PayByLink by in3](https://developer.pay.nl/docs/paybylink-by-in3.md)
- [Accepting Payments](https://developer.pay.nl/docs/accepting-payments.md): Using Pay you can quickly set up payments
- [PAY.Parts (beta)](https://developer.pay.nl/docs/use-payparts-beta.md): A suite of pre-built UI components that you can embed in your own checkout to accept payments.
- [Create a session from your backend](https://developer.pay.nl/docs/create-a-session-from-your-backend.md): In order to use a component of Pay.Parts in your frontend you need to initialize a session. A session is initialized by sending a POST request from your backend.
- [Add components to your frontend](https://developer.pay.nl/docs/add-components-to-your-frontend.md)
- [Express buttons](https://developer.pay.nl/docs/express-buttons.md): Pay.Parts rendering the express checkout buttons.
- [Handle events](https://developer.pay.nl/docs/handle-events.md)
- [Translations](https://developer.pay.nl/docs/translations.md)
- [Payment processing flows](https://developer.pay.nl/docs/payment-method-flows.md)
- [Gateway redirect](https://developer.pay.nl/docs/standard-payment-flow.md)
- [iDEAL](https://developer.pay.nl/docs/ideal.md): Specific transaction examples for iDEAL are listed here
- [Pay By Bank](https://developer.pay.nl/docs/pay-by-bank.md): Start a Pay By Bank payment
- [Klarna](https://developer.pay.nl/docs/klarna.md): Specific transaction examples for Klarna are listed here
- [Payment-Based Checkout (fastCheckout)](https://developer.pay.nl/docs/payment-based-checkout-fastcheckout.md): If you like to receive the payers data from the payment method to feed into your order system
- [Card Input Component](https://developer.pay.nl/docs/card-not-present.md): Process payments via the card rails of Visa, Mastercard, American Express or Bancontact.
- [Embedded Payment flow](https://developer.pay.nl/docs/embedded-payment-flow.md): Use the embedded flow so that payer does not leave your checkout page
- [InPerson Payments](https://developer.pay.nl/docs/inperson.md): Accept card present transactions on an iPhone or an Android device
- [Standalone](https://developer.pay.nl/docs/standalone.md): Using our PAY.POS app standalone, easy to use!
- [Cloud Connect](https://developer.pay.nl/docs/inperson-payments-cloud.md): Start a payment on a terminal that is connected to our cloud host for anywhere in the world.
- [Local Connect](https://developer.pay.nl/docs/local-connect.md): Start a payment on a terminal via your local network
- [Cloud ECR (legacy)](https://developer.pay.nl/docs/instore.md): Connecting your instore terminal to a TGU for Worldline Terminal (Yomani)
- [Same Device (Inject)](https://developer.pay.nl/docs/through-an-inject.md): Integrate our PAY.POS application on your own device.
- [Full integrated (SDK)](https://developer.pay.nl/docs/full-integrated-sdk.md): Build Seamless Card Present In-App Payments with PAY's Full Integrated SDK
- [Transaction Processing only (by contract) ](https://developer.pay.nl/docs/transaction-processing-only-by-contract.md): Process payments by loading a processing contract of Pay. into your payment terminal
- [Giftcards & Vouchers](https://developer.pay.nl/docs/giftcards-vouchers.md)
- [Authorize and Capture](https://developer.pay.nl/docs/authorise-and-capture.md): Manage a transaction that has an active authorisation.
- [Banktransfer Initiated (DBT)](https://developer.pay.nl/docs/banktranfer-initiated.md): Payments that are received on Virtual IBANs or Private IBAN's that can't be assigned to an order (no acceptcode) will be send into this route.
- [Direct Debit & Mandates](https://developer.pay.nl/docs/direct-debit-mandates.md): Direct debit (also known as SEPA direct debit) is a payment method that automatically debits funds from the consumer's bank account.
- [Recurring payments](https://developer.pay.nl/docs/recurring-payments.md): Tokenization brings you the option to use cardholder's details without saving the card details. Most common use cases are monthly subscription fee's for memberships.
- [Split payments](https://developer.pay.nl/docs/split-payments.md): Ideal for Marketplaces; purchasing goods from multiple sellers in a single basket.
- [Payouts ](https://developer.pay.nl/docs/payouts-1.md): Send Payouts to IBAN accounts via SCT or SICT (Instant)
- [Load the configuration](https://developer.pay.nl/docs/load-the-configuration.md): Load the enabled payment methods, other settings and build the UI
- [Images & Icons](https://developer.pay.nl/docs/images-icons-1.md): We provide a GitHub repository that keeps you in sync with the latest updates to brand icons for Payment Methods, issuers, and other vendors.
- [Handling the exchange calls](https://developer.pay.nl/docs/handling-the-exchange-calls.md): Getting status notifications via our exchanges
- [Exchange calls](https://developer.pay.nl/docs/exchange-handling.md): Various payment types with various exchange calls
- [Direct Debits](https://developer.pay.nl/docs/exchanges-direct-debits-mandates.md)
- [Orders](https://developer.pay.nl/docs/orders-1.md)
- [Pay.POS](https://developer.pay.nl/docs/exchange-paypos.md)
- [Payouts](https://developer.pay.nl/docs/payouts.md)
- [Refunds](https://developer.pay.nl/docs/refunds.md)
- [Tokenization](https://developer.pay.nl/docs/exchange-tokenization.md)
- [Retry schemes](https://developer.pay.nl/docs/retry-schemes.md): Schemes for additional attempts after failed exchange calls
- [Signing](https://developer.pay.nl/docs/signing-1.md): Verify that an exchange request originates from a TGU or GMS owner server
- [Return to returnURL](https://developer.pay.nl/docs/return-the-payer.md): Location the payer is sent to when the payment reaches a final state
- [Use our sandbox](https://developer.pay.nl/docs/use-our-sandbox-mode.md): Implement the flow without any test cards
- [Test your Integration](https://developer.pay.nl/docs/testing-your-integration.md): Verify that your integration with the Multicore Platform works as intended
- [1. Your first test](https://developer.pay.nl/docs/1-minimum-input.md): Start an simple payment, and provide us the data, check if the first test passes so you can perform more complex tests
- [2. Delivery & invoice addresses](https://developer.pay.nl/docs/2-an-order-with-delivery-invoice-addresses.md)
- [3. A B2B order](https://developer.pay.nl/docs/3-a-b2b-order.md)
- [4. Belgian customers](https://developer.pay.nl/docs/4-an-order-with-a-belgian-customer.md)
- [5. Partner-integration code](https://developer.pay.nl/docs/5-an-order-with-a-partner-integration-code.md): If you are a certified integrator, we like you to prove that transactions from your integration are transferred correctly.
- [6. Stats data](https://developer.pay.nl/docs/6-an-order-with-stats-data.md)
- [7. Google Analytics code](https://developer.pay.nl/docs/7-an-order-with-a-google-analytics-code.md)
- [8. Customer data](https://developer.pay.nl/docs/8-an-order-with-customer-data.md)
- [9. Multibyte characters](https://developer.pay.nl/docs/9-an-order-with-multibyte-characters.md): we like you to check an order with Mutlibytes characters, to check if names and fields are provided and encoded properly.
- [Partner registration](https://developer.pay.nl/docs/registration.md)
- [Settlement & clearing data](https://developer.pay.nl/docs/clearing-settlement-data.md)
- [Integration guides](https://developer.pay.nl/docs/integration-guides.md): Step-by-step guides on how to create various integrations with our platform.
- [POS Cloud connect guide](https://developer.pay.nl/docs/pos-integration-guide.md): Integrate a POS connection with our platform in 5 simple steps.
- [1. Retrieve available terminals](https://developer.pay.nl/docs/retrieve-available-terminals.md): To fetch the available terminals and their corresponding configurations for a merchant, you can utilize the Terminals:Browse API.
- [2. Initiate a transaction](https://developer.pay.nl/docs/initiate-a-transaction.md): To initiate a POS transaction, you need to use the Order:Create API.
- [3. Initiate a refund transaction](https://developer.pay.nl/docs/initiate-a-refund-transaction.md): To initiate a POS refund transaction, you need to use the Order:Create API.
- [4. Poll status from the POS device](https://developer.pay.nl/docs/verify-the-status.md): To check the status of a InPerson transaction, this call should be send direcly from the POS machine to Cloud Connect System.
- [6. Backend Status Calls (optional)](https://developer.pay.nl/docs/retrieve-supplier-data.md): IF you need to request the status of a InPerson Payment from a trusted backed server
- [Enhancements](https://developer.pay.nl/docs/enhancements.md): Get the most out of POS software by applying the optimizations and tips below.
- [Certification](https://developer.pay.nl/docs/certification.md): The purpose of the certification is to ensure the quality and reliability of the POS integration.
- [Paylink integration guide](https://developer.pay.nl/docs/paylink-integration-guide.md): Initiate a payment link in just a few simple steps.
- [1. Initiate a transaction](https://developer.pay.nl/docs/initiate-a-transaction-1.md): To initiate a paylink transaction, you need to use the Order:Create API.
- [2. Verify the status](https://developer.pay.nl/docs/verify-the-status-1.md): To check the status of a paylink, use the Order:Status API.
- [3. Enhancements](https://developer.pay.nl/docs/3-enhancements.md): Get the most out of your payment links by applying the optimizations and tips below.
- [DirectDebit Integration guide](https://developer.pay.nl/docs/direct-debit-integration-guide.md): Initiate a direct debit in just a few simple steps.
- [1. Create a mandate](https://developer.pay.nl/docs/1-create-a-mandate.md): To initiate a mandate, you need to use the Mandate:Create API.
- [2. Flexible mandate: DirectDebit:Add](https://developer.pay.nl/docs/2-flexible-mandate-directdebitadd.md): To initiate a DirectDebits on an active mandate, you need to use the DirectDebit:add
- [3. DirectDebit status](https://developer.pay.nl/docs/3-directdebit-status.md): DirectDebits can have several status, below we will describe how you should handle them.
- [E-commerce integration guide](https://developer.pay.nl/docs/e-commerce-integration-guide.md): Integrate the Pay. payment solutions into your platform.
- [1. Create an order](https://developer.pay.nl/docs/create-an-order.md): To initiate a transaction, you need to use the Order:Create API.
- [2. Retrieve order status](https://developer.pay.nl/docs/retrieve-order-status.md)
- [3. Handling Exchange calls](https://developer.pay.nl/docs/exchange-calls-handling.md)
- [4. Test your own integration](https://developer.pay.nl/docs/test-your-own-integration.md)
- [Getting started](https://developer.pay.nl/docs/getting-started.md): If you are looking to integrate Pay. for third parties, you can register for an account using our registration process.
- [Introduction](https://developer.pay.nl/docs/introduction-3.md)
- [Register your merchants](https://developer.pay.nl/docs/register-your-merchants.md): To process payments for your merchants on your platform, they first need to have an account with Pay.
- [Onboard your merchants](https://developer.pay.nl/docs/onboard-your-merchants.md): 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.
- [Clearing and invoice settings](https://developer.pay.nl/docs/clearing-and-invoice-settings.md): Manage clearing and invoice settings
- [Manage the moneyflow](https://developer.pay.nl/docs/manage-the-money-flow.md)
- [Clearing accounts](https://developer.pay.nl/docs/clearing-accounts.md): The bank account to which we clear your revenue.
- [Turnover groups](https://developer.pay.nl/docs/turnovergroups.md): Use different turnover groups if your merchant want to get more insights in their revenue.
- [Services /sales locations](https://developer.pay.nl/docs/services-sales-locations.md): Link payment methods to your merchant's website, physical store or cash register and process payments.
- [Trademarks](https://developer.pay.nl/docs/trademarks-2.md): Use trademarks for clear communication with your customers
- [Licenses](https://developer.pay.nl/docs/licenses.md): Connect persons (accounts) to a merchant for platform access and KYC
## API Reference
- [Order:Create](https://developer.pay.nl/reference/api_create_order-1.md): Create an order on this TGU. An order represents the total order as it exists in your shop and can be fulfilled through one or more payments.
- [Order:Update](https://developer.pay.nl/reference/api_update_order-1.md): Update an order with a reference and/or description. This action is only allowed for orders of the type 'payment_based_checkout' and only if the value to update is currently not set.
- [Order:Status](https://developer.pay.nl/reference/api_get_status-1.md): Retrieve the current status of an order along with its corresponding payment attempts.
- [Order:Payment](https://developer.pay.nl/reference/api_create_order_payment.md): Append a new payment based on an existing pending order. When the summed amount of all completed payments reaches the order amount, the order will be completed.
- [Order:Approve](https://developer.pay.nl/reference/api_approve_order-1.md): Approve an order that is flagged for a risk check by the Verify module, continuing the regular order flow.
- [Order:Decline](https://developer.pay.nl/reference/api_decline_order-1.md): Decline an order that is flagged for a risk check by the Verify module, refunding all payments made on this order.
- [Order:Capture](https://developer.pay.nl/reference/api_capture_order-1.md): Capture an order that has an active reservation (Status 95). Reservations are commonly used for CreditCard and Buy now, Pay later payments. By using this API, the entire order will be captured.
- [Order:CaptureAmount](https://developer.pay.nl/reference/api_capture_amount-1.md): Capture a specific amount on an order that has an active reservation (Status 95). Reservations are commonly used for CreditCard and Buy now, Pay later payments. With this API, you can capture a specific amount from the order while the reservation remains active.
- [Order:CaptureProducts](https://developer.pay.nl/reference/api_capture_products-1.md): Capture an order that has an active reservation (Status 95). Reservations are commonly used for CreditCard and Buy now, Pay later payments. By using this API, the entire order will be captured.
- [Order:Void](https://developer.pay.nl/reference/api_void_order-1.md): Cancel an order with an active reservation (Status 95), voiding all payments made for that order as well.
- [Order:Abort](https://developer.pay.nl/reference/api_abort_order-1.md): Abort an order, halting the regular order flow and voiding any payment attempts made to fulfill this order.
- [Order:Retry](https://developer.pay.nl/reference/api_retry_order.md): Retry an order that has a failed endstate by resetting the order status. Please note that the Order type will be changed to PAYLINK and the pointOfInteraction to ECOMMERCE. Also, any existing payments will not be removed.
- [Order:Accept](https://developer.pay.nl/reference/api_accept_order.md): Accept an order with a lower amount than the original order amount.
- [Voucher:payment](https://developer.pay.nl/reference/api_post_vouchers_payment.md): This endpoint initiates a voucher (gift card) payment in the Transaction Gateway Unit API. It allows your system to process a payment using a voucher as the payment method in a direct request.
Use this API when you want to charge a voucher for an order amount and begin a payment transaction using voucher credentials (e.g., card number and PIN). This is part of the voucher & gift card payment flow, enabling you to handle voucher-based payments directly through your backend integration.
- [Voucher:info](https://developer.pay.nl/reference/api_post_vouchers_info.md): This endpoint retrieves information about a voucher (gift card).
Use this API when you want to validate a voucher and check the amount, expiry date and brand information of the voucher.
- [Service:GetConfig](https://developer.pay.nl/reference/get_services-config.md): Get the complete configuration of a service location. you can use this to create your own checkout. You need to authenticate with an AT code (as username) and the corresponding token (as password) or you can authenticate with a SL code (as username) and the corresponding secret (as password).
- [authenticate](https://developer.pay.nl/reference/686211a23f2bf051ed06ad4fe6c1ce1b-2.md): API handles the calls for starting and authenticating the transaction in one go. The merchant calls this API with the same parameters as the Transaction Start V16 with the necessary card data appended to it. For existing transactions the orderId and entranceCode can be passed on instead of the transaction details. Note: this API will try to process the transaction based upon the settings for the service. This can result in an 3DS challenge, for which the necessary data will be returned. The payload of the challenge must be sent to the Authorization API. In case of an SCA Exempted (Low-value-payment) or frictionless transaction the authorization will be handled in this request.
- [getAuthenticationStatus](https://developer.pay.nl/reference/9127090d4da0784100517935a43fd1e7-2.md): If the integrated 3DSecure is used for authentication this API can be used to get the status of the 3DSecure session.
- [authorize](https://developer.pay.nl/reference/d8a03bda20cafdf5fb63243c496b614a-2.md): API handles the calls for starting and completing the transaction in one go. The merchant calls this API with the same parameters as the Transaction Start V16 with the necessary card data appended to it. For existing transactions the orderId and entranceCode can be passed on instead of the transaction details. Note: this API can only handle: 1. NON 3DS transactions - no fallback to 3DS auth 2. 3DS transactions where the merchant provides the 3DS data (using 3rd party 3DSecure provider) 3. 3DS transactions where the merchant adds the transaction ID of the integrated 3DSecure provider 4. Wallet transactions (e.g. Apple Pay / Google Pay)
- [getEncryptionKeys](https://developer.pay.nl/reference/cf8eb044c5d15652a2f422d0083881cc-2.md): Returns the public keys the merchant can use for encrypting the card details of the consumer before submitting these to our API.
- [getCardInfo](https://developer.pay.nl/reference/6bf1c1978ceadffdda65a50f03af790c-2.md): API returns the details for the given card number. Card number can be passed on as plain text or via CSE.
- [getCardToken](https://developer.pay.nl/reference/39cd7b9f1e762c4b9987cdd4684dc279.md): API returns a token that is generated for the provided card data. The token can be used to complete the next steps in the payment process.
- [addToken](https://developer.pay.nl/reference/863bad74c68534fca01fb5a7557ea792-1.md)
- [Mandate:Create](https://developer.pay.nl/reference/post_directdebits-mandates.md): Create a mandate, on a mandate direct debit transactions are executed. You always need a mandate for a direct debit transaction. You can create a mandate for a single direct debit transaction, for a recurring or flexible direct debits.
- [Mandate:Get](https://developer.pay.nl/reference/get_directdebits-mandates-mandateid.md): List all mandates on which a direct debit transaction can be executed
- [Mandates:Browse](https://developer.pay.nl/reference/get_directdebits-mandates.md): List all mandates on which a direct debit transaction can be executed
- [Mandate:Delete](https://developer.pay.nl/reference/delete_directdebits-mandates-mandateid.md): Delete a mandate, no more direct debits will /can be executed
- [DirectDebit:Add](https://developer.pay.nl/reference/post_directdebits.md): Initiate a DirectDebit for a Mandate. Only applicable for “Flexible” mandates.
- [DirectDebit:Get](https://developer.pay.nl/reference/get_directdebits-directdebitid.md): Get a specific directdebit transaction
- [DirectDebits:Browse](https://developer.pay.nl/reference/get_directdebits.md): List all executed directdebit transactions
- [Payout:Clearing](https://developer.pay.nl/reference/post_payout-clearing.md): Create a new clearing based on the revenue group linked to the provided service.
- [Payout:Create](https://developer.pay.nl/reference/post_payout.md): Send a payment to an IBAN number, based on the settings in the ServiceLocation the transaction can be send via SCT (Sepa Credit Transfer) in 24 hours or SICT (Sepa Instant Credit Transfer in 15 seconds)
- [Server2Server integration](https://developer.pay.nl/reference/full-whitelabel-integration.md): Native API Integrations
- [Terminal Payments](https://developer.pay.nl/reference/terminal-payments.md): Proces transaction via a cloud terminal
- [Payment:Status](https://developer.pay.nl/reference/get_api-status.md): Get the status of a Pin transaction. The customer has 45 seconds to finalize the pin transaction. To check if the pin terminal is available for a new transaction you can poll the status. You can request the status through the statusUrl parameter that has been returned when you have started the pin transaction.
- [Payment:Cancel](https://developer.pay.nl/reference/get_api-cancel.md): Cancel a pin transaction which has been started on a pin terminal.
- [Voucher:Create](https://developer.pay.nl/reference/post_vouchers-transaction.md): To capture funds of a giftcard via a point of sale or eCommerce environment you can call this API. The giftcard must be activated on the sales location.
- [Transaction:Info](https://developer.pay.nl/reference/get_transactions-transactionid.md): Get all detailed information of a transaction. You can use the EX code or the order ID to retrieve the detailed transaction information
- [Transaction:Load](https://developer.pay.nl/reference/get_transactions-transactionid-load.md): Load a transaction which has been started, so that the transaction can be finalized on another device. The transaction can only be loaded if a transaction has the status 20, 50 and 90 (PENDING)
- [Transaction:LoadUUID](https://developer.pay.nl/reference/get_transactions-load.md): Load a transaction which has been started, so that the transaction can be finalized on another device. The transaction can only be loaded if a transaction has the status 20, 50 and 90 (PENDING). You need to authenticate with the orderid (as username) and the entrancecode (as password) or only the uuid (as username) of the transaction
- [Transaction:Refund](https://developer.pay.nl/reference/patch_transactions-transactionid-refund.md): Add a refund for a transaction. You can use the EX code or the order ID to refund the transaction
- [Refund:Delete](https://developer.pay.nl/reference/delete_refunds-code.md): Delete a specific refund. You can only delete a refund if the refund is not processed yet. You need to have access to the refund otherwise you cannot delete it.
- [Transaction:Cancel](https://developer.pay.nl/reference/patch_transactions-transactionid-cancel.md): Transactions that have the status pending (which implies that the payment is waiting for an action) can be cancelled. If you cancel a transaction a new processing action cannot be started. A cancel of the transaction will not stop the money flow. The payment state of the transaction will be set to CANCEL (-90). You can use the EX code or the order ID to cancel the transaction
- [Verify:Approve](https://developer.pay.nl/reference/patch_transactions-transactionid-approve.md): Transactions that have the status verify (which implies that a transaction needs to be checked) can be approved to collect the funds and to set the payment state to PAID (100). You can use the EX code or the order ID to approve the transaction
- [Verify:Decline](https://developer.pay.nl/reference/patch_transactions-transactionid-decline.md): Transactions that have the status verify (which implies that a transaction needs to be checked) can be declined to release the authorisation on a card or to refund the original transaction. The payment state is set to CANCEL (-64). You can use the EX code or the order ID to decline the transaction
- [Authorisation:Capture](https://developer.pay.nl/reference/patch_transactions-transactionid-capture.md): Transactions that have the status authorize (is used by credit card payments or Buy now, Pay later payments) needs an extra action to convert the payment state to a PAID (100) transaction. This can be achieved by capturing the transaction. You can use the EX code or the order Id to capture the transaction
- [Authorisation:Void](https://developer.pay.nl/reference/patch_transactions-transactionid-void.md): Transactions that have the status authorize (is used by credit card payments or Buy now, Pay later payments) can be voided to reverse the authorisation and to set the the payment state to CANCEL (-90). You can use the EX Code or the order Id to void the transaction
- [AuthenticationToken:Create](https://developer.pay.nl/reference/authentication_token_create_post.md): Creates a new authentication token under a merchant. You can also specify which authorisation groups needs to be linked to the token. You can also supply a merchantCode. If a merchantCode is supplied then you need to have access to that merchant. You need to authenticate with an AT-code as username and a token as password
- [AuthenticationToken:Update](https://developer.pay.nl/reference/authentication_token_update_patch.md): Update an existing authentication token. You can only update the authentication token if it is associated with your own merchant registration. If the authentication token is not associated with your own merchant registration, you must have access to the corresponding merchant.
- [AuthenticationToken:Get](https://developer.pay.nl/reference/authentication_token_authentication_token_get.md): Get the details of a specific authentication token. Note you need to have access to the merchant if the authentication token is not available under your own merchant registration
- [AuthenticationTokens:Browse](https://developer.pay.nl/reference/authentication_token_authentication_tokens_get.md): Get all authentication tokens. If you do not supply a merchantCode we return the authentication tokens that are available under your own merchant registration. If you supply a merchantCode you need to have access to that merchant
- [AuthenticationTokens:List](https://developer.pay.nl/reference/authentication_token_authentication_token_list_get.md): Get a list (without pagination) of all authentication tokens. If you do not supply a merchantCode we return the tokens that are available under your own merchant registration. If you supply a merchantCode you need to have access to that merchant.
- [AuthenticationToken:Delete](https://developer.pay.nl/reference/authentication_token_remove_delete.md): Deletes an authentication token. Note you need to have access to the merchant if the authentication token is not available under your own merchant registration
- [AuthenticationToken:Undelete](https://developer.pay.nl/reference/authentication_token_undelete_post.md): Undelete an authentication token that was recently deleted. This can only be done within a 15 minute time window
- [AuthorisationGroup:Create](https://developer.pay.nl/reference/authorisation_group_create_post.md): Create your custom authorisation group
- [AuthorisationGroup:Update](https://developer.pay.nl/reference/authorisation_group_update_patch.md): Update your custom authorisation group
- [AuthorisationGroup:Browse](https://developer.pay.nl/reference/authorisation_group_authorisation_groups_get.md): Get all AuthorisationGroups that are applicable and configured. You can use the AuthorisationGroup code (the AG-code) to give an account specific rights in e.g. the Merchants:Create API. If you have the appropriate rights you can also create your own custom authorisation groups
- [AuthorisationGroup:Get](https://developer.pay.nl/reference/authorisation_group_authorisation_group_get.md): Get a specific authorisationGroup
- [AuthorisationGroup:Info](https://developer.pay.nl/reference/authorisation_group_authorisation_group_info_get.md): Get detailed information regarding a specific authorisationGroup
- [AuthorisationGroups:List](https://developer.pay.nl/reference/authorisation_group_authorisation_groups_list_get.md): Get a list (without pagination) of all authorisation groups. If you do not supply a merchantCode we return the authorisation groups that are available under your own merchant registration. If you supply a merchantCode you need to have access to that merchant.
- [AuthorisationGroup:Delete](https://developer.pay.nl/reference/authorisation_group_remove_delete.md): Delete your custom authorisation group
- [ClearingAccounts:Create](https://developer.pay.nl/reference/post_clearingaccounts.md): Creates a new clearing account for a merchant. The clearing accounts needs to be a business clearing account, private accounts are not accepted. You can also supply a merchantCode. If a merchantCode is supplied then you need to have access to that merchant
- [ClearingAccounts:Update](https://developer.pay.nl/reference/patch_clearingaccounts-clearingaccountcode.md): Updates a clearing account under a merchant. You can only update the clearing account if the account is not yet approved by our boarding department. You can also update a clearing account for your merchant, but you need to have access to that merchant.
- [ClearingAccounts:Get](https://developer.pay.nl/reference/get_clearingaccounts-clearingaccountcode.md): Get the details of a specific clearing account. Note you need to have access to the merchant if the clearing account is not available under your own merchant registration
- [ClearingAccounts:Browse](https://developer.pay.nl/reference/get_clearingaccounts.md): Get all clearing accounts. If you do not supply a merchantCode we return the clearing accounts that are available under your own merchant registration. If you supply a merchantCode you need to have access to that merchant
- [ClearingAccounts:List](https://developer.pay.nl/reference/merchant_clearing_accounts_get.md): Retrieve all clearing accounts which you have access to
- [ClearingAccounts:Delete](https://developer.pay.nl/reference/delete_clearingaccounts-clearingaccountcode.md): Deletes a clearing account. Note you need to have access to the merchant if the clearing account is not available under your own merchant registration
- [ClearingAccounts:Undelete](https://developer.pay.nl/reference/post_clearingaccounts-clearingaccountcode-undelete.md): Undelete a clearing account that was recently deleted. This can only be done within a 15 minute time window.
- [ContactMethods:Browse](https://developer.pay.nl/reference/contact_method_contact_methods_get.md): Get the details of a specific contact method. Note you need to have access to the merchant if the contact method is not available under your own merchant registration.
- [ContactMethod:Create](https://developer.pay.nl/reference/contact_method_create_post.md): Creates a new contact method for a merchant. You can indicate per contact method if the contact details are public. If they are public they can be used in communication with end users. You can also supply a merchantCode. If a merchantCode is supplied then you need to have access to that merchant.
- [ContactMethod:Get](https://developer.pay.nl/reference/contact_method_contact_method_get.md): Get the details of a specific contact method. Note you need to have access to the merchant if the contact method is not available under your own merchant registration.
- [ContactMethod:Delete](https://developer.pay.nl/reference/contact_method_remove_delete.md): Deletes a contact method. Note you need to have access to the merchant if the contact method is not available under your own merchant registration.
- [ContactMethod:Update](https://developer.pay.nl/reference/contact_method_update_patch.md): Updates a contact method for a merchant. All fields for the request are optional. Note you need to have access to the merchant if the contact method that you want to update is not available under your own merchant registration.
- [ContactMethod:Undelete](https://developer.pay.nl/reference/contact_method_undelete_post.md): Undelete a contact method that was recently deleted. This can only be done within a 15 minute time window.
- [Documents:Add](https://developer.pay.nl/reference/post_documents.md): Upload a (compliance) document as base64. Uploading is done based on a document code, the content of the document needs to be encoded to base64. You can also specify the filename. You need to authenticate with an AT code (as username) and the corresponding token (as password) or you can authenticate with an AL code (as username) and the corresponding secret (as password)
- [Icon:Get](https://developer.pay.nl/reference/icon_icon_get.md): Get the avatar/profile/logo for an object.
- [Icon:Update](https://developer.pay.nl/reference/icon_update_patch.md): Update the avatar/profile/logo for an object. This endpoint is to facilitate an upload of an image for an object
- [Icon:Delete](https://developer.pay.nl/reference/icon_remove_delete.md): Delete the avatar/profile/logo for an object.
- [Layout:Create](https://developer.pay.nl/reference/layout_create_post.md): Create a layout which will be used on interaction with the end-user, e.g. our hosted payment page, payment terminal, second chance emails etc. You can also supply a merchantCode. If a merchantCode is supplied then you need to have access to that merchant.
- [Layout:Files](https://developer.pay.nl/reference/layout_files_upload_post.md): Upload files for the layout.
- [Layout:Update](https://developer.pay.nl/reference/layout_update_patch.md): Updates a layout which will be used on interaction with the end-user, e.g. our hosted payment page, payment terminal, second chance emails etc. You need to have access to the merchant to update a layout
- [Layout:Get](https://developer.pay.nl/reference/layout_layout_get.md): Get a specific layout. You need to have access to the merchant to retrieve the branding
- [Layout:Info](https://developer.pay.nl/reference/layout_info_get.md): Get all information regarding a specific layout. You need to have access to the merchant to retrieve the layout
- [Layouts:Browse](https://developer.pay.nl/reference/layout_layouts_get.md): Get an overview with layouts
- [Layouts:List](https://developer.pay.nl/reference/layout_layouts_list_get.md): Get a list (without pagination) of all layouts. If you do not supply a merchantCode we return the layouts that are available under your own merchant registration. If you supply a merchantCode you need to have access to that merchant.
- [Layout:Delete](https://developer.pay.nl/reference/layout_remove_delete.md): Delete a specific layout. You need to have access to the merchant to delete the layout
- [Layout:DeleteFile](https://developer.pay.nl/reference/layout_files_remove_delete.md): Delete uploaded files for a layout.
- [Layout:Undelete](https://developer.pay.nl/reference/layout_undelete_post.md): Undelete a layout that was recently deleted. This can only be done within a 15 minute time window
- [Licenses:Create](https://developer.pay.nl/reference/post_licenses.md): Create a new license and a Pay account under a merchant. You can indicate if the license is authorized to sign or an UBO and you can indicate which rights the account should have. You can also supply a merchant. If a merchant is supplied then you need to have access to that merchant. You need to authenticate with an AT-code as username and a token as password.
- [Licenses:Update](https://developer.pay.nl/reference/patch_licenses-licensecode.md): Updates a license under a merchant. You can indicate if the license is authorized to sign or an UBO and you can indicate which rights the account should have. You need to have access to that merchant to update the license. You need to authenticate with an AT-code as username and a token as password.
- [Licenses:Get](https://developer.pay.nl/reference/get_licenses-licensecode.md): Get a specific license linked to a merchant.
- [Licenses:List](https://developer.pay.nl/reference/get_licenses-list.md): Get a list of basic information for all licenses (without pagination). If you do not supply a merchant we return the licenses that are available under your own merchant registration. If you supply a merchant you need to have access to that merchant. You need to authenticate with an AT-code as username and a token as password.
- [Licenses:Browse](https://developer.pay.nl/reference/get_licenses.md): Get all licenses linked to a merchant.
- [Licenses:Delete](https://developer.pay.nl/reference/delete_licenses-licensecode.md): Remove a license from a merchant. You can unsuspend within a 15 minute time window.
- [Licenses:Undelete](https://developer.pay.nl/reference/post_licenses-licensecode-undelete.md): Unsuspend a license that was recently deleted. This can only be done within a 15 minute time window.
- [Merchants:Create](https://developer.pay.nl/reference/post_merchants.md): Register a merchant so that the merchant is able to use Pay. to process payments
- [Merchant:Update](https://developer.pay.nl/reference/patch_merchants-merchantcode.md): Update the merchant data. If you want to update the relating objects (e.g. authentication tokens or accounts etc) you can use the specific endpoints for that. You need to have access to the merchantCode that you supply or it needs to be your own merchantCode. You need to authenticate with an AT-code as username and the corresponding token as password.
- [Merchant:UpdateSettings](https://developer.pay.nl/reference/setting_merchant_update_settings_patch.md): Update the settings for a merchant. If a merchantCode is supplied then you need to have access to that merchant.
- [Merchants:UpdatePackage](https://developer.pay.nl/reference/patch_merchants-merchantcode-package.md): Update the package. If a merchantCode is supplied then you need to have access to that merchant. You need to authenticate with an AT-code as username and the corresponding token as password.
- [Merchant:ToReview](https://developer.pay.nl/reference/patch_boarding-merchantcode-ready.md): When all documents for a merchant are delivered to Pay 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. Note you need to have access to the merchant to call this endpoint
- [Merchant:AddClearing](https://developer.pay.nl/reference/post_v5-merchant-addclearing-json.md): Add a clearing for a sub-merchant. If e.g. the clearing frequency is set to manual for your sub-merchant you determine when your sub-merchant will be cleared.
- [Merchant:AddInvoice](https://developer.pay.nl/reference/post_v8-alliance-addinvoice-json.md): Use this endpoint to add an invoice for a merchant. This invoice can contain platform and 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 balance.
- [Merchants:Browse](https://developer.pay.nl/reference/get_merchants.md): Get a list of all merchants
- [Merchant:Get](https://developer.pay.nl/reference/get_merchants-merchantcode.md): Get the details of a specific merchant
- [Merchant:Info](https://developer.pay.nl/reference/merchant_info_get.md): Get detailed information of a specific merchant
- [Merchants:List](https://developer.pay.nl/reference/merchant_merchants_list_get.md): Get a list (without pagination) of all your merchants.
- [Merchants:Search](https://developer.pay.nl/reference/merchant_imitate_search_get.md): Find a merchant based on M-code or (part of the) company name
- [Merchant:Switch](https://developer.pay.nl/reference/account_license_enable_patch.md): Switch from merchant if your account has access to multiple merchants. With this switch you are able to retrieve data from that merchant if you have authenticated with a JWT token. You need to have access to the merchant that you want to switch to.
- [Merchant:Whitelabel](https://developer.pay.nl/reference/merchant_whitelabel_get.md): Get the whitelabel settings for a merchant. These whitelabel settings are used the change the look & feel of the Pay portal
- [Merchant:Delete](https://developer.pay.nl/reference/delete_merchants-merchantcode.md): Delete a merchant. The merchant is not able to process payments anymore and cannot login to Pay anymore
- [Merchant:Undelete](https://developer.pay.nl/reference/post_merchants-merchantcode-undelete.md): Undelete a merchant that was recently deleted. This can only be done within a 15 minute time window
- [MerchantAddress:Create](https://developer.pay.nl/reference/merchant_address_post.md): Create an address for a merchant. If you supply a merchantCode you need to have access to that merchant to create an address.
- [MerchantAddress:Update](https://developer.pay.nl/reference/merchant_address_update_patch.md): Update an existing address. All fields for the request are optional. Note you need to have access to the merchant if the address that you want to update is not available under your own merchant registration.
- [MerchantAddress:Get](https://developer.pay.nl/reference/merchant_address_merchant_address_get.md): Get the details of a specific address. Note you need to have access to the merchant if the address is not available under your own merchant registration
- [MerchantAddresses:Browse](https://developer.pay.nl/reference/merchant_address_merchant_addresses_get.md): Get all addresses. If you do not supply a merchantCode we return the addresses that are available under your own merchant registration. If you supply a merchantCode you need to have access to that merchant
- [MerchantAddress:List](https://developer.pay.nl/reference/merchant_address_merchant_address_list_get.md): Retrieve a simple list of all Addresses. You can supply a merchant code to retrieve the addresses for that merchant. If no merchant code is provided, the addresses associated with your own merchant registration will be returned.
- [MerchantAddress:Delete](https://developer.pay.nl/reference/merchant_address_delete.md): Delete an address. Deleted addresses can be restored within 15 minutes.
- [MerchantAddress:Undelete](https://developer.pay.nl/reference/merchant_address_undelete_post.md): Undelete an address that was recently deleted.
- [Packages](https://developer.pay.nl/reference/package_packages_get.md): Retrieve the pre-configured packages (also known as sign-up profiles) for the merchant/partner. Use the CP or action code to register a merchant, ensuring the correct settings are configured upon the creation of the merchant.
- [Service:Create](https://developer.pay.nl/reference/service_create_post.md): In order for a merchant to use our processing APIs the merchant needs to have at least one service registered. A merchant can have multiple services, normally one for each service they offer. You can also supply a merchant, if you have access to that merchant you can create a service for that merchant.
- [Service:Update](https://developer.pay.nl/reference/service_update_patch.md): Updates a single service. Note that the request can only be successful when you have permission to access that service.
- [Service:UpdateSettings](https://developer.pay.nl/reference/service_settings_update_patch.md): Update settings of your service. You need to have access to that service to be able to update the settings
- [Service:Get](https://developer.pay.nl/reference/service_service_get.md): Retrieve a single service based on the given SL-code. Note that the request can only be successful when you have permission to access that service.
- [Services:List](https://developer.pay.nl/reference/service_services_list_get.md): Get a list (without pagination) of all services. If you do not supply a merchantCode we return the services that are available under your own merchant registration. If you supply a merchantCode you need to have access to that merchant.
- [Services:Browse](https://developer.pay.nl/reference/service_services_get.md): Get all services. If you do not supply a merchant we return the services that are available under your own merchant registration. If you supply a merchant you need to have access to that merchant. You need to authenticate with an AT-code as username and a token as password.
- [Service:Info](https://developer.pay.nl/reference/service_info_get.md): Get detailed information about a single service (incl. settings and enabled payment methods) based on a SL-code. You need to have access to the merchant to get a specific service for a merchant.
- [Service:GetAvailablePaymentMethods](https://developer.pay.nl/reference/service_payment_methods_get.md): Get all available payment methods for a service with the boarding status. So if you have requested a payment method, you can also see the status of the needed boarding for that specific payment profile. You need to have access to that service to get the data.
- [Service:EnablePaymentMethod](https://developer.pay.nl/reference/service_payment_method_enable_post.md): Enable payment method for a service. You need to have access to that service and the payment methods that you want to enable is allowed on your service.
- [Service:DisablePaymentMethod](https://developer.pay.nl/reference/service_payment_method_disable_delete.md): Disable payment method for a service. You need to have access to that service.
- [Service:UpdatePaymentMethod](https://developer.pay.nl/reference/service_payment_method_update_patch.md): Update the settings of a payment method on a specific service. The payment method needs to be enabled and you need to have access to that service.
- [Service:DeleteUrl](https://developer.pay.nl/reference/service_url_remove_delete.md): Delete a URL from a service. You need to have access to that service to be able to delete a url.
- [Services:AddUrl](https://developer.pay.nl/reference/service_url_create_post.md): Add URL(s) to a service. Supply the serviceId for which the Urls needs to be added. You need to have access to that service to be able to add url(s).
- [Service:Delete](https://developer.pay.nl/reference/service_remove_delete.md): Removes a service based on the given SL-code. Note that the request can only be successful when you have permission to access that service.
- [PaymentLink:Create](https://developer.pay.nl/reference/post_services-serviceid-paymentlink.md): You can create a payment page for invoice payments & donations
- [Terminals:Create](https://developer.pay.nl/reference/post_terminals.md): Create a terminal for a service location from a merchant so that the terminal can be used.
- [Terminals:Update](https://developer.pay.nl/reference/terminal_assignment_terminal_assignment_update_patch.md): Update a specific terminal linked to your account. You can update the name, description, and point of sale (service) for the terminal.
- [Terminals:Get](https://developer.pay.nl/reference/get_terminals-terminalcode.md): Get for a specific terminal linked to your account the contract details, active terminal brands and the actual status of the terminal
- [Terminals:Browse](https://developer.pay.nl/reference/get_terminals.md): Get a list of all terminals linked to your account. Including the contract details, active terminal brands and the actual status of a terminal
- [Terminals:List](https://developer.pay.nl/reference/terminal_assignment_terminal_assignments_list_get.md): Get a list (without pagination) of all terminals. If you do not supply a merchantCode we return the terminals that are available under your own merchant registration. If you supply a merchantCode you need to have access to that merchant.
- [Terminals:Delete](https://developer.pay.nl/reference/delete_terminals-terminalcode.md): Remove a terminal from a merchant. You can undelete within a 15 minute time window
- [Terminals:Undelete](https://developer.pay.nl/reference/post_terminals-terminalcode-undelete.md): Undelete a terminal that was rececently deleted. This can only be done witin a 15 minute time window
- [Trademark:Create](https://developer.pay.nl/reference/trademark_create_post.md): Create a trademark for a merchant, which can then be linked to a sales location. These trademarks will be displayed on the payer's statement.
- [Trademark:Get](https://developer.pay.nl/reference/trademark_trademark_get.md): Get the details of a specific trademark.
- [Trademarks:Browse](https://developer.pay.nl/reference/trademark_trademarks_get.md): Retrieve all trademarks. If no merchantCode is provided, we will return the trademarks available under your own merchant registration. If a merchantCode is supplied, you must have access to that merchant.
- [Trademarks:List](https://developer.pay.nl/reference/trademark_trademarks_list_get.md): Retrieve a list of all trademarks. If no merchantCode is provided, we will return the trademarks available under your own merchant registration. If a merchantCode is supplied, you must have access to that merchant.
- [Trademark:Delete](https://developer.pay.nl/reference/trademark_remove_delete.md): Delete a trademark for a merchant. This will unlink the trademark from all sales locations. The trademark can be restored for 15 minutes after deletion before it is permanently deleted.
- [Trademark:Undelete](https://developer.pay.nl/reference/trademark_undelete_post.md): Undelete a trademark for a merchant, which can then be linked to a sales location again. This is only possible within 15 minutes after deletion.
- [TurnoverGroups:Browse](https://developer.pay.nl/reference/turnover_group_turnover_groups_get.md): Retrieve all turnover groups. You can supply a merchant code to retrieve the turnover groups for that merchant. If no merchant code is provided, the turnover groups associated with your own merchant registration will be returned.
- [TurnoverGroup:Get](https://developer.pay.nl/reference/turnover_group_turnover_group_get.md): Retrieve the details of a specific turnover group. If the turnover group is not associated with your own merchant registration, you must have access to the corresponding merchant.
- [TurnoverGroup:Create](https://developer.pay.nl/reference/turnover_group_turnover_group_create_post.md): To gain better insights into your revenue or to manage multiple clearing accounts, you can create a turnover group. This group can be configured on a Service (SL) for efficient management. You can also create a turnover group for a merchant different from your own; however, you must have access to that merchant.
- [TurnoverGroup:Delete](https://developer.pay.nl/reference/turnover_group_turnover_group_delete_delete.md): Delete a turnover group. This will unlink the turnover group from all services. The turnover group can be restored for 15 minutes after deletion before it is permanently deleted.
- [TurnoverGroup:Update](https://developer.pay.nl/reference/turnover_group_turnover_group_update_patch.md): Update an existing turnover group. You can only update the turnover group if it is associated with your own merchant registration. If the turnover group is not associated with your own merchant registration, you must have access to the corresponding merchant.
- [TurnoverGroup:Undelete](https://developer.pay.nl/reference/turnover_group_turnover_group_undelete_post.md): Undelete a turnover group, which can then be linked to a service again. This is only possible within 15 minutes after deletion.
- [TurnoverGroups:List](https://developer.pay.nl/reference/turnover_group_turnover_group_list_get.md): Retrieve a simple list of all turnover groups. You can supply a merchant code to retrieve the turnovergroups for that merchant. If no merchant code is provided, the turnover groups associated with your own merchant registration will be returned.
- [VerifyRules:Browse](https://developer.pay.nl/reference/verify_rule_verify_rules_get.md): Get all verify rules. If you do not supply a merchant we return the verify rules that are available under your own merchant registration. If you supply a merchant you need to have access to that merchant. You need to authenticate with an AT-code as username and a token as password.
- [VerifyRule:Create](https://developer.pay.nl/reference/verify_rule_create_post.md): Mark certain data points as reliable (positive) or unreliable (negative) and our VERIFY module will take this into account in the decision making. If a merchant is supplied then you need to have access to that merchant. You need to authenticate with an AT-code as username and a token as password.
- [VerifyRule:Get](https://developer.pay.nl/reference/verify_rule_verify_rule_get.md): Get a specific verify rule. You can supply the verify rule code or you can supply the data point value if you don’t know the code. You need to authenticate with an AT-code as username and a token as password.
- [VerifyRule:Delete](https://developer.pay.nl/reference/verify_rule_remove_delete.md): Delete a verify rule. You can supply the verify rule code or you can supply the data point value if you don’t know the code. You need to authenticate with an AT-code as username and a token as password.
- [VerifyRule:Update](https://developer.pay.nl/reference/verify_rule_update_patch.md): Update a data point as reliable (positive) or unreliable (negative) and our VERIFY module will take this into account in the decision making. You can supply the VerifyRule code or you can supply the data point value if you don’t know the code. You need to authenticate with an AT-code as username and a token as password.
- [Account:Set2FA](https://developer.pay.nl/reference/account_2fa_patch.md): Setup two factor authentication for an account. You need to supply which method you want to use. The support methods are OTP (one time password with an authenticator app) or SMS
- [Account:GenerateQR](https://developer.pay.nl/reference/account_2fa_generate_qr_get.md): Generate a QR to use with a OTP (one time password) authenticator app. You will receive a base64 string which can be converted to a QR code
- [Account:Trigger2FA](https://developer.pay.nl/reference/account_2fa_trigger_post.md): If SMS is configured on your account an SMS will be sent to the mobile phone number that is configured in your account.
- [Account:Verify2FA](https://developer.pay.nl/reference/account_2fa_verify_post.md): Verify the one time password (received with SMS or received from your authenticator app). If the one time password is correct you will receive a JWT token and a refresh token. The JWT token expires in one hour. You can refresh your JTW token with a call to Account:RefreshToken with the refresh token
- [Account:Me](https://developer.pay.nl/reference/account_me_get.md): Get the current account
- [Account:Me](https://developer.pay.nl/reference/account_me_patch.md): Patch account information linked to the provided JWT token
- [Account:Licenses](https://developer.pay.nl/reference/account_licenses_get.md): Returns all merchants that you have access to
- [Account:DeleteLicense](https://developer.pay.nl/reference/account_license_delete.md): Remove yourself from a merchant
- [Account:SetPassword](https://developer.pay.nl/reference/account_password_patch.md): Set the password of an account. You need to supply a password and a token. This token will be sent in the mail when you have forgotten your password or when you have created your account. If 2FA is not set for your account, you will receive in the response a new token which can be used only to set 2FA for your account
- [Account:ResetPassword](https://developer.pay.nl/reference/account_password_recover_post.md): Use this endpoint to reset your password when the password has lost. This will send an email with a one time password change link. This link contains a token. You can use the Account:SetPassword endpoint with this token to set a new password for this account
- [Account:Support](https://developer.pay.nl/reference/account_support_get.md): Use this endpoint to retrieve a support control code. This support control code is used when you contact support, for example when you have lost your 2FA code
- [Account:Token](https://developer.pay.nl/reference/account_token_post.md): Create a token for a given account
- [Account:TokenRefresh](https://developer.pay.nl/reference/account_token_refresh_post.md): Use the refresh token to obtain a new JWT and (optionally new) refresh token to authenticate with against the API.
- [Account:UnlinkDevice](https://developer.pay.nl/reference/account_unlink_device_delete.md): Unlink a device from an account
- [Accounts:VerifyEmailChange](https://developer.pay.nl/reference/account_email_verify_patch.md): Use this endpoint to verify the e-mail address of an account. You need to supply a a token. This token will be sent in the mail when you have request an e-mail change
- [Authenticate:Login](https://developer.pay.nl/reference/post_login-authenticate.md): Retrieve a handshake to redirect a user to the Pay platform so that a user can access the Pay platform without entering login credentials. Note that the user needs to have the correct rights to use this feature. You need to authenticate this API with the AT-code as username and the token as password
- [Permissions](https://developer.pay.nl/reference/api_operation_permissions_get.md): Retrieve the permissions for the supplied scope and subject
- [Balance:Dashboard](https://developer.pay.nl/reference/get_balance.md): Gives an overview of the active balance of a merchant, including information about the next and the previous clearing. You can supply a merchant code. If you are a partner and you have access to that merchant code we will provide you the data. If no merchant code is provided your own balance information returned
- [Balance:Deposit](https://developer.pay.nl/reference/balance_deposit_create_post.md): This API add funds to your balance. You can add a merchant code so that you can add funds to a merchant where you have access to (default = active merchantCode).
- [Balance:Withdraw](https://developer.pay.nl/reference/balance_withdraw_create_post.md): This API withdraw funds from your balance which will be settled in a next settlement. You can add a merchant code so that you can withdraw funds also from a merchant where you have access to (default = active merchantCode).
- [Balance:Year](https://developer.pay.nl/reference/balance_year_get.md): This API gives an end of year overview
- [Balance:Date](https://developer.pay.nl/reference/balance_date_get.md): This API gives the balance and costs on the specified date
- [Clearings:Settlements](https://developer.pay.nl/reference/clearing_settlements_get.md): A Pay. clearing contains multiple clearing lines. This API returns the clearing grouped by settlements, including the clearing lines. You can filter on a merchant code, so if you are a partner and you have right to that merchants you can retrieve the clearing information for your merchant. You can also filter on settlement code and clearing id.
- [Clearings:Browse](https://developer.pay.nl/reference/clearing_clearings_get.md): This API returns a summary of the clearings. You can filter on a merchant code, so if you are a partner and you have right to that merchants you can retrieve the clearing information for your merchant.
- [Clearings:Get](https://developer.pay.nl/reference/clearing_clearing_get.md): This API returns the clearing summary information for a specific clearing. If you want to retrieve also the clearing lines, please use the Clearing:Lines endpoint. You need to have access to the merchant if you request a clearing.
- [Clearing:Info](https://developer.pay.nl/reference/clearing_info_get.md): This API returns detailed clearing information for a specific clearing. You need to have access to the merchant if you request a clearing.
- [Clearing:Lines](https://developer.pay.nl/reference/clearing_clearing_lines_get.md): A Pay. clearing contains multiple clearing lines. This API returns all clearing lines for a specified period. If you are a partner and you have rights to your merchants you can retrieve the clearing lines also for your merchants
- [Clearing:AllLines](https://developer.pay.nl/reference/get_clearinglines.md): A Pay. clearing contains multiple clearing lines. This API returns all clearing lines for a specified period. If you are a partner and you have rights to your merchants you can retrieve the clearing lines also for your merchants
- [Clearings:Records](https://developer.pay.nl/reference/clearing_clearing_records_get.md): Retrieve the transactions that are in a clearing. You can filter on the clearing ID or the settlement code. Note that you need to have access to the merchant to retrieve the transactions if you request the transactions for a clearing ID or settlement code from one of your sub-merchants.
- [Clearing:Download](https://developer.pay.nl/reference/clearing_download_get.md): This API generates and returns a PDF of a specific clearing. The PDF contains both the clearing summary information the the clearing lines. You need to have access to the merchant if you request a PDF for a specific clearing.
- [Exchanges:Browse](https://developer.pay.nl/reference/browseexchanges.md): Get an overview of all your exchanges. If you do not supply a timerange you will receive the response -7 days until today.
- [Exchange:Info](https://developer.pay.nl/reference/getexchangeinfo.md): Get detailed information regarding a specific exchange call, including the request and response body
- [Exchange:Retry](https://developer.pay.nl/reference/post_exchanges-objectcode-retry.md): Retry processing of an specific exchange entry.
- [Exchanges:Summary](https://developer.pay.nl/reference/get_exchanges-summary.md): Aggregated statistics of your exchanges, average response times, and success/failure counts.
- [Idin:Browse](https://developer.pay.nl/reference/idin_idins_get.md): Retrieve all iDIN transaction. iDIN is a service of the dutch banks which you can use to identify your customers.
- [Invoices:Browse](https://developer.pay.nl/reference/invoice_invoices_get.md): This API returns a summary of the invoices. You can filter on a merchant code, so if you are a partner and you have right to that merchants you can retrieve the invoice information for your merchant.
- [Invoice:Get](https://developer.pay.nl/reference/invoice_invoice_get.md): This API returns the generic data for a specific invoice. You can filter on a merchant code, so if you are a partner and you have right to that merchants you can retrieve the invoice information for your merchant.
- [Invoice:Info](https://developer.pay.nl/reference/invoice_invoice_info_get.md): This API returns a detailed summary information for a specific clearing. If you want to retrieve also the clearing lines, please use the Clearing:Lines endpoint. You need to have access to the merchant if you request a clearing.
- [Invoice:Lines](https://developer.pay.nl/reference/invoice_invoice_lines_get.md): A Pay. invoice contains multiple invoice lines. This API returns all invoice lines for a specified invoice. If you are a partner and you have rights to your merchants you can retrieve the invoice lines also for your merchants
- [Invoice:AllLines](https://developer.pay.nl/reference/get_invoicelines.md): A Pay. invoice contains multiple invoice lines. This API returns all invoice lines for a specified period. If you are a partner and you have rights to your merchants you can retrieve the invoice lines also for your merchants
- [Invoice:Download](https://developer.pay.nl/reference/invoice_download_get_operation_id.md): This API allows you to download the PDF document of a specific invoice.
- [Refunds:Browse](https://developer.pay.nl/reference/get_refunds.md): List all refunds. You need to authenticate with an AT-code as username and a token as password.
- [Refund:Get](https://developer.pay.nl/reference/get_refunds-refundid.md): Get a specific refund. You need to authenticate with an AT-code as username and a token as password.
- [Settlement:Forecasts](https://developer.pay.nl/reference/settlement_forecasts_get.md): This API returns a forecast of the upcoming settlements. You can filter on a merchant code, so if you are a partner and you have right to that merchants you can retrieve the settlement forecast information for your merchant.
- [Settlement:Forecast:Info](https://developer.pay.nl/reference/settlement_forecast_info_get.md): This API returns detail information regarding the forecast of a settlement. You can filter on a merchant code, so if you are a partner and you have right to that merchants you can retrieve the settlement forecast information for your merchant. You can supply an identifier to indicate if you want to have the details for the received funds (in), for the send funds (out) or for the costs (costs).
- [Statistics:DirectDebit](https://developer.pay.nl/reference/get_statistics-directdebit.md): Shows the total amount of direct debit transactions over the last 13 months.
- [Statistics:Management](https://developer.pay.nl/reference/statistic_management_get.md): Get statistical information regarding your transactions. You can set several filters and you can group the the results in max 2 levels. Note always one group by is required. If you supply a merchantCode you need to have access to that merchant.
- [Statistics:Volume](https://developer.pay.nl/reference/statistic_volume_get.md): Get volume statistical information regarding your transactions. You can use the results to build a graphical representation regarding the volumes processed.
- [Token:Browse](https://developer.pay.nl/reference/get_tokenization-tokens.md): Get all vault tokens for the authenticated merchant
- [Token:Get](https://developer.pay.nl/reference/get_tokenization-tokens-tokencode.md): To receive details information about the token
- [Token:Info](https://developer.pay.nl/reference/get_tokenization-tokencode-info.md): To receive detailed information about a specific token
- [Token:Transactions](https://developer.pay.nl/reference/get_tokenization-tokencode-transactions.md): Get all transactions for a specific token
- [Tokens:Delete](https://developer.pay.nl/reference/delete_tokenization-tokens-code.md): Delete a specific tokenization token
- [Transaction:Browse](https://developer.pay.nl/reference/get_transactions.md): Retrieve the transactions for a merchant up to 10.000 transaction limited to 100 trx per page and maximum 100 pages.
- [Transaction:Find](https://developer.pay.nl/reference/get_transactions-find.md): Find a transaction based on the provided search criteria
- [Transactions:Instore](https://developer.pay.nl/reference/get_transactions-instore.md): Retrieve all instore transactions for a merchant
- [BillingLineTypes](https://developer.pay.nl/reference/invoice_billing_line_types_get.md): A Pay. invoice contains multiple billing lines which are grouped. This API returns all groups that we have available, including a description of the billing lines that can appear in that group
- [BillingUnitTypes](https://developer.pay.nl/reference/tariff_unit_tariff_units_get.md): Get all billing unit types that are available in our system.
- [Categories](https://developer.pay.nl/reference/category_categories_get.md): Get all categories that can be used to onboard new sales locations or check the Payment methods that are available for a specific category.
- [ClearingLineTypes](https://developer.pay.nl/reference/clearing_clearing_line_types_get.md): A Pay. clearing contains multiple clearing lines which are grouped. This API returns all groups that we have available, including a description of the clearing lines that can appear in that group
- [CompanyTypes](https://developer.pay.nl/reference/company_type_company_types_get.md): Get all company types that are in our system.
- [Countries](https://developer.pay.nl/reference/country_countries_get.md): Get all countries that are available in our system.
- [Currencies](https://developer.pay.nl/reference/currency_currencies_get.md): Get all currencies that are available in our system.
- [Integrations](https://developer.pay.nl/reference/integration_integrations_get.md): Get all integration that are in our system.
- [IpAddress](https://developer.pay.nl/reference/ip_address_ip_addresses_get.md): Get all IP addresses that are in use by Pay.
- [IsPay](https://developer.pay.nl/reference/ip_address_is_pay_ip_get.md): Return status 200 if the ip provided is an ip owned by Pay, otherwise it will return a 404.
- [Issuers](https://developer.pay.nl/reference/issuer_issuers_get.md): Get all issuers that are available in our system.
- [Languages](https://developer.pay.nl/reference/locale_languages_get.md): Get all languages that are available in our system.
- [Locales](https://developer.pay.nl/reference/locale_locales_get.md): Get all locales that are available in our system.
- [MCCs](https://developer.pay.nl/reference/mcc_mccs_get.md): Get all MCCs.
- [ProductTypes](https://developer.pay.nl/reference/product_type_product_types_get.md): Get all product types that are available in our system.
- [PaymentMethodGroups](https://developer.pay.nl/reference/payment_method_group_payment_method_groups_get.md): Get all payment method groups.
- [PaymentMethods](https://developer.pay.nl/reference/payment_method_payment_methods_get.md): Get all payment methods.
- [PaymentVerification](https://developer.pay.nl/reference/payment_verification_method_payment_verification_methods_get.md): Get all payment verification methods that are available in our system.
- [TerminalCardAcquirers](https://developer.pay.nl/reference/terminal_card_acquirer_terminal_card_acquirers_get.md): Get a list of acquirers/processors that can be used on a CTAP terminal
- [TerminalCardBrands](https://developer.pay.nl/reference/terminal_card_brand_terminal_card_brands_get.md): Get all terminal card brands that are available in our system
- [TerminalTypes](https://developer.pay.nl/reference/terminal_type_terminal_types_get.md): Get all terminal types that are available in our system
- [TerminalProducts](https://developer.pay.nl/reference/terminal_product_terminal_products_get.md): Get an overview of terminal products.
- [Verify Rules types](https://developer.pay.nl/reference/verify_rule_type_verify_rule_types_get.md): Get all Verify Rules types
## Recipes
- [Account funding transaction](https://developer.pay.nl/recipes/account-funding-transaction.md)
- [Add a clearing for a (sub)merchant](https://developer.pay.nl/recipes/add-a-clearing-for-a-submerchant.md)
- [Add a direct debit transaction on a flexible mandate](https://developer.pay.nl/recipes/add-a-direct-debit-transaction-on-a-flexible-mandate.md)
- [Add an invoice for your (sub)merchant](https://developer.pay.nl/recipes/add-an-invoice-for-your-submerchant.md)
- [AMEX - Create Order (1/2)](https://developer.pay.nl/recipes/amex-create-order-12.md)
- [AMEX - Overcapture (2/2)](https://developer.pay.nl/recipes/amex-overcapture.md)
- [C2C Paymentlinks](https://developer.pay.nl/recipes/c2c-paymentlinks.md)
- [Create a card based transaction by TOKEN](https://developer.pay.nl/recipes/create-a-card-based-transaction-by-token.md)
- [Create a payout (payment to IBAN number)](https://developer.pay.nl/recipes/create-a-payout-payment-to-iban-number.md)
- [Creating a giftcard transaction with preloaded cardnumber and pincode](https://developer.pay.nl/recipes/creating-a-giftcard-transaction-with-preloaded-cardnumber-and-pincode.md)
- [Creating a service which can be used for payment processing](https://developer.pay.nl/recipes/creating-a-service-which-can-be-used-for-payment-processing.md)
- [Digital Refund - Via the API](https://developer.pay.nl/recipes/digital-refund-via-the-api.md)
- [Exchange configuration on your service](https://developer.pay.nl/recipes/exchange-configuration-on-your-service.md)
- [iDeal Fast Checkout / Snel bestellen](https://developer.pay.nl/recipes/ideal-fast-checkout-snel-bestellen.md)
- [iDEAL for CPSP's (collecting)](https://developer.pay.nl/recipes/ideal-for-cpsps-collecting-1.md)
- [Initiate a paylink transaction](https://developer.pay.nl/recipes/initiate-a-paylink-transaction.md)
- [Initiate a POS refund transaction](https://developer.pay.nl/recipes/initiate-a-pos-refund-transaction.md)
- [Initiate a POS transaction](https://developer.pay.nl/recipes/initiate-a-pos-transaction.md)
- [Inperson payments](https://developer.pay.nl/recipes/inperson-payments.md)
- [Klarna BNPL with Extra Merchant Data ](https://developer.pay.nl/recipes/klarna-extra-merchant-data.md)
- [Load getConfig](https://developer.pay.nl/recipes/load-getconfig.md)
- [Mandate for a single direct debit transactions](https://developer.pay.nl/recipes/mandate-for-a-single-direct-debit-transactions.md)
- [Mandate for flexible direct debit transactions](https://developer.pay.nl/recipes/mandate-for-flexible-direct-debit-transactions.md)
- [Mandate for recurring direct debit transactions](https://developer.pay.nl/recipes/mandate-for-recurring-direct-debit-transactions.md)
- [MPOS integration](https://developer.pay.nl/recipes/mpos-integration.md)
- [Multiple clearingaccounts](https://developer.pay.nl/recipes/multiple-clearingaccounts.md)
- [Multiple trademarks](https://developer.pay.nl/recipes/multiple-trademarks.md)
- [Payment Based Checkout Exchange Payload](https://developer.pay.nl/recipes/payment-based-checkout-exchange-payload.md)
- [Persons/licenses associated to a merchant](https://developer.pay.nl/recipes/personslicenses-associated-to-a-merchant.md)
- [Providing documents](https://developer.pay.nl/recipes/providing-documents.md)
- [PSP's that offer non collection iDEAL (end2end)](https://developer.pay.nl/recipes/psps-that-offer-non-collection-ideal-end2end.md)
- [Retrieve available terminals](https://developer.pay.nl/recipes/retrieve-available-terminals.md)
- [Server2Server Card Payment With Tokenisation](https://developer.pay.nl/recipes/server2server-card-payment-with-tokenisation.md)
- [Signup a merchant in one session](https://developer.pay.nl/recipes/signup-a-merchant-in-one-session-1.md)
- [Split payments](https://developer.pay.nl/recipes/split-payments.md)
- [Split revenue using turnover groups](https://developer.pay.nl/recipes/split-revenue-using-turnover-groups.md)
- [Start a Transaction at the TGU](https://developer.pay.nl/recipes/start-a-transaction-at-the-tgu.md)
## Pages
- [Custom 2](https://developer.pay.nl/page/custom-2.md)
- [Plugins & integrations](https://developer.pay.nl/page/test-custom-page.md)
## Changelog
- [PAY.APP v3.0.14 - 11/08/2026](https://developer.pay.nl/changelog/payapp-v3014-10082026.md)
- [TGU: Release notes 30-07-2026](https://developer.pay.nl/changelog/tgu-release-notes-30-07-2026.md)
- [PAY.POS v1.3.4 - 20/07/2026](https://developer.pay.nl/changelog/paypos-v134.md)
- [GMS: Release notes 28-07-2026](https://developer.pay.nl/changelog/gms-release-notes-20-07-2026.md)
- [PAY.PARTS: Release notes 06-07-2026 (v1.30.0)](https://developer.pay.nl/changelog/payparts-release-notes-06-07-2026-v1290-1.md)
- [TGU: Release notes 14-07-2026](https://developer.pay.nl/changelog/tgu-release-notes-14-07-2026.md)
- [GMS: Release notes 09-07-2026](https://developer.pay.nl/changelog/gms-release-notes-09-07-2026.md)
- [PAY.PARTS: Release notes 06-07-2026 (v1.29.0)](https://developer.pay.nl/changelog/payparts-release-notes-06-07-2026-v1290.md)
- [PAY.PARTS: Release notes 25-06-2026 (v1.28.0)](https://developer.pay.nl/changelog/payparts-release-notes-25-06-2026-v1280.md)
- [PAY.POS v1.3.1 - 24/06/26](https://developer.pay.nl/changelog/paypos-v130-240626.md)