PHPackages                             jeffreyvanhees/laravel-online-payment-platform - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. jeffreyvanhees/laravel-online-payment-platform

ActiveLibrary[API Development](/categories/api)

jeffreyvanhees/laravel-online-payment-platform
==============================================

Laravel connector for Online Payment Platform API using SaloonPHP

v0.0.26(5mo ago)0387↓100%MITPHPPHP ^8.2CI passing

Since Jul 26Pushed 5mo agoCompare

[ Source](https://github.com/jeffreyvanhees/laravel-online-payment-platform)[ Packagist](https://packagist.org/packages/jeffreyvanhees/laravel-online-payment-platform)[ RSS](/packages/jeffreyvanhees-laravel-online-payment-platform/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (1)Versions (27)Used By (0)

Laravel Online Payment Platform SDK
===================================

[](#laravel-online-payment-platform-sdk)

[![Latest Version on Packagist](https://camo.githubusercontent.com/06c3223bd2792fb8ad507d52abaaa3759ea5996b1d752608883125d2ebcb51ec/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6a65666672657976616e686565732f6c61726176656c2d6f6e6c696e652d7061796d656e742d706c6174666f726d2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/jeffreyvanhees/laravel-online-payment-platform)[![Tests](https://camo.githubusercontent.com/b46faf1e1ad59348b88122ab175eb59fd045eb0851c99e587be82e0fbd9fd511/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f6a65666672657976616e686565732f6c61726176656c2d6f6e6c696e652d7061796d656e742d706c6174666f726d2f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/jeffreyvanhees/laravel-online-payment-platform/actions/workflows/run-tests.yml)[![Coverage](https://camo.githubusercontent.com/842ddbca1b746a3b428fd76b80777d8441ccc39885b80642a000817d0e40f49c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f436f7665726167652d38352e322532352d627269676874677265656e3f7374796c653d666c61742d737175617265)](https://github.com/jeffreyvanhees/laravel-online-payment-platform/actions/workflows/coverage.yml)[![Total Downloads](https://camo.githubusercontent.com/9f30bcf020d411eee2ac898b8632d4ac6c0b63a1669830737b75e0543444c015/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6a65666672657976616e686565732f6c61726176656c2d6f6e6c696e652d7061796d656e742d706c6174666f726d2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/jeffreyvanhees/laravel-online-payment-platform)

A modern Laravel package for integrating with the [Online Payment Platform](https://onlinepaymentplatform.com) API. Built with [SaloonPHP](https://docs.saloon.dev) and [Spatie Laravel Data](https://spatie.be/docs/laravel-data) for an excellent developer experience.

Warning

This package is not affiliated with, endorsed by, or officially connected to Online Payment Platform B.V. It is an independent, community-driven implementation for integrating with their API. Also, this package is not intended for production use yet. It is still in development and may contain breaking changes.

✨ Features
----------

[](#-features)

- 🚀 **Laravel 11 & 12 Support** - Full support for the latest Laravel versions
- 🛡️ **Type Safety** - Fully typed DTOs using Spatie Laravel Data
- 🏗️ **Service Container** - Native Laravel service container integration
- 🎭 **Facade Support** - Clean, expressive API using Laravel facades
- 🔧 **SaloonPHP Foundation** - Built on the robust SaloonPHP HTTP client
- 🧪 **Comprehensive Testing** - HTTP recording/replay for reliable tests
- 📚 **Intuitive API** - Fluent interface: `OnlinePaymentPlatform::merchants()->ubos()->create()`
- 🔄 **Environment Support** - Seamless sandbox/production switching
- ⚡ **Exception Handling** - Detailed custom exceptions for all error scenarios
- 🔄 **Pagination Support** - Built-in pagination with SaloonPHP

📋 Requirements
--------------

[](#-requirements)

- PHP 8.2 or higher
- Laravel 11.0 or 12.0

🚀 Installation
--------------

[](#-installation)

Install the package via Composer:

```
composer require jeffreyvanhees/laravel-online-payment-platform
```

Publish the configuration file:

```
php artisan vendor:publish --tag=opp-config
```

Configure your API credentials and URLs in your `.env` file:

```
# API Configuration
OPP_API_KEY=your_production_api_key_here
OPP_SANDBOX_API_KEY=your_sandbox_api_key_here
OPP_SANDBOX=true

# URL Configuration (optional - set default URLs for webhooks/notifications)
OPP_NOTIFY_URL=https://yourapp.com/webhooks/opp
OPP_RETURN_URL=https://yourapp.com/payment/return

# Webhook Configuration (optional)
OPP_NOTIFY_SECRET=your_webhook_secret
```

📚 API Documentation
-------------------

[](#-api-documentation)

### 📋 API Endpoints Index

[](#-api-endpoints-index)

- **[Merchants](#merchants)** - Create consumer/business merchants, manage contacts, addresses, UBOs, and profiles
- **[Transactions](#transactions)** - Create payments, retrieve status, update transaction details
- **[Refunds](#refunds)** - Process transaction refunds and list refund history
- **[Global Settlements](#global-settlements)** - Platform-wide settlement reporting and detailed rows
- **[Charges](#charges)** - Balance transfers between merchants and fee management
- **[Mandates](#mandates)** - SEPA Direct Debit mandates and recurring transactions
- **[Withdrawals](#withdrawals)** - Merchant payouts to bank accounts
- **[Disputes](#disputes)** - Handle transaction disputes and chargebacks
- **[Files](#files)** - Upload and manage documents for verification/evidence
- **[Partners](#partners)** - Partner configuration and settings management
- **[Pagination](#pagination)** - Handle paginated API responses

---

🎯 Usage
-------

[](#-usage)

The package provides multiple ways to interact with the Online Payment Platform API:

### Using the Facade (Recommended)

[](#using-the-facade-recommended)

The facade provides the cleanest and most Laravel-like API:

```