README

PHP SDK

Provides easy integration with Pay’s powerful payment platform, enabling online and instore payments with a wide range of local and international payment methods, including iDEAL, Bancontact, Apple Pay, PayPal, Klarna, credit cards, SEPA payments, and more.

This PHP SDK makes it easy to integrate the powerful Pay. API into your integration to start transactions, retrieve payment statuses and process refunds directly from your website or platform.

Have a look at our offer:

Country specific payment methods

Online card payments

Buy Now Pay Later

Giftcards and vouchers

Instore payments

Requirements

To use this PHP SDK, you’ll need:

• A Pay. account (register here).
• You can immediately use the API in sandbox mode.
• API credentials which you will find in your Dashboard.
• PHP 8.1–8.4
• JSON extension
• CURL extension

Once your account is set up, you can immediately start using the API in sandbox mode and enable payment methods for live transactions when ready.

Installation

Using Composer

The recommended way to install the Pay. PHP SDK is via Composer:

    composer require paynl/php-sdk

More info about installation here.

Usage

Creating a transaction

use PayNL\Sdk\Model\Request\OrderCreateRequest;

$payOrder = (new OrderCreateRequest())
    ->setServiceId($serviceId) // Your SL-code: SL-####-####
    ->setAmount(1.95) // Currency default in EURO.
    ->setReturnUrl('https://yourdomain/yourfinishpage.php')
    ->start();

echo $payOrder->getPaymentUrl();

The response contains the order ID and redirect URL needed to forward the customer to the selected payment method.

See also this minimum create order example

Documentation

For complete and up-to-date documentation, please explore our Developer Portal. Documentation is available in English.

• API endpoints and parameters
• Creating and managing transactions
• Payment methods and statuses
• Refunds and partial refunds
• Webhooks (exchange URLs
• Testing and debugging

Detailed SDK usage examples can be found in this repository and in the official Developer Portal.

Examples & Recipes

The Pay. PHP SDK includes practical examples for common use cases, such as:

• Starting a payment
• Handling exchange URLs (webhooks)
• Retrieving transaction details
• Processing refunds
• Working with recurring and deferred payment methods (where applicable)

Upgrading

If you are upgrading from the old SDK, please follow the SDK Migration Guide.

Contributing

Contributions are welcome. Feel free to submit issues or pull requests to help improve the Pay. PHP SDK.

Support

Website: Pay.nl

Documentation: Developer.pay

E-mail: support@pay.nl