README

An API client designed to interface with the Online Payment Platform REST API.

Requirements

To use the Open Payment Platform API client, the following things are required:

• An account on Online Payment Platform
• PHP >= 8.2

Installation

Installing the Online Payment Platform API client can be done by using composer

$ composer require gusdeboer/opp

Getting started

use Gusdeboer\OPP\OnlinePaymentPlatformApiClient;

public function index(): void
{
    // Setup client with your API key
    $client = new OnlinePaymentPlatformApiClient('apikey');
    
    // Retrieve a merchant
    $merchant = $client->merchants->retrieve('merchant_uid'); 
}

Need more? Check out the examples

Debugging

If you are setting up your project it's good practice to test your application in the Open Payment Platform Sandbox

use Gusdeboer\OPP\OnlinePaymentPlatformApiClient;

$client = new OnlinePaymentPlatformApiClient(
    'apikey',
    OnlinePaymentPlatformApiClient::ENVIRONMENT_SANDBOX
);

API Documentation

If you wish to learn more about the API, please visit the Online Payment Platform Docs. API Documentation is available in English.

Contribute

Please read the Contribute.md

Contributers

• Gus de Boer
• You?

TODO

• Endpoints
  • Merchant
    • Address
    • Bank Account
    • Contact
    • Profile
    • UBO
    • Compliance
    • Ticket
  • Files
  • Transactions
  • Mandates & Direct Debit
  • Charges
  • Withdrawals
  • Virtual IBAN
  • Issuer
  • Disputes
  • Mandates
• Group properties per endpoint call, docs
• Types fromString should not be needed, set from Country:Belgium should be enough
  • function blaat(string|Country $country) { instance of, go }