Download the PHP package monei/monei-php-sdk without Composer

MONEI PHP SDK

The MONEI PHP SDK provides convenient access to the MONEI API from applications written in server-side PHP.

For collecting customer and payment information in the browser, use monei.js.

Table of Contents

• MONEI PHP SDK
  • Table of Contents
  • Requirements
  • Installation
  • Basic Usage
  • API Keys
    • Types of API Keys
    • API Key Security
  • Test Mode
  • Basic Client Usage
  • Payment Operations
  • Creating a Payment
  • Retrieving a Payment
  • Refunding a Payment
  • Integration Methods
  • Using the Prebuilt Payment Page
    • Features
    • Integration Flow
  • Webhooks
  • Signature Verification
  • Handling Payment Callbacks
    • Important Notes About Webhooks
  • MONEI Connect for Partners
  • Account ID
    • Setting Account ID after initialization
  • Custom User-Agent
    • Examples with Proper User-Agent Format
  • Managing Multiple Merchant Accounts
  • Development
  • Building the SDK
  • Tests
  • Code Style
  • Documentation

Requirements

• PHP 7.4 or later

Installation

Install the package using Composer:

Then run composer install

Basic Usage

API Keys

The MONEI API uses API keys for authentication. You can obtain and manage your API keys in the MONEI Dashboard.

Types of API Keys

MONEI provides two types of API keys:

• Test API Keys: Use these for development and testing. Transactions made with test API keys are not processed by real payment providers.
• Live API Keys: Use these in production environments. Transactions made with live API keys are processed by real payment providers and will move actual money.

Each API key has a distinct prefix that indicates its environment:

• Test API keys start with pk_test_ (e.g., pk_test_12345abcdef)
• Live API keys start with pk_live_ (e.g., pk_live_12345abcdef)

By checking the prefix of an API key, you can quickly determine which environment you're working in. This is especially useful when you're managing multiple projects or environments.

API Key Security

Your API keys carry significant privileges, so be sure to keep them secure:

• Keep your API keys confidential and never share them in publicly accessible areas such as GitHub, client-side code, or in your frontend application.
• Use environment variables or a secure vault to store your API keys.
• Restrict API key access to only the IP addresses that need them.
• Regularly rotate your API keys, especially if you suspect they may have been compromised.

Test Mode

To test your integration with MONEI, you need to switch to test mode using the toggle in the header of your MONEI Dashboard. When in test mode:

1. Generate your test API key in MONEI Dashboard → Settings → API Access
2. Configure your payment methods in MONEI Dashboard → Settings → Payment Methods

Important: Account ID and API key generated in test mode are different from those in live (production) mode and can only be used for testing purposes.

When using test mode, you can simulate various payment scenarios using test card numbers, Bizum phone numbers, and PayPal accounts provided in the MONEI Testing documentation.

Basic Client Usage

Payment Operations

Creating a Payment

Create a payment with customer information:

Retrieving a Payment

Retrieve an existing payment by ID:

Refunding a Payment

Process a full or partial refund:

Integration Methods

Using the Prebuilt Payment Page

MONEI Hosted Payment Page is the simplest way to securely collect payments from your customers without building your own payment form.

Features

• Designed to remove friction — Real-time card validation with built-in error messaging
• Mobile-ready — Fully responsive design
• International — Supports 13 languages
• Multiple payment methods — Supports multiple payment methods including Cards, PayPal, Bizum, GooglePay, Apple Pay & Click to Pay
• Customization and branding — Customizable logo, buttons and background color
• 3D Secure — Supports 3D Secure - SCA verification process
• Fraud and compliance — Simplified PCI compliance and SCA-ready

You can customize the appearance in your MONEI Dashboard → Settings → Branding.

Integration Flow

1. Create a payment on your server

2. Redirect the customer to the payment page

After creating a payment, you'll receive a response with a nextAction.redirectUrl. Redirect your customer to this URL to show them the MONEI Hosted payment page.

3. Customer completes the payment

The customer enters their payment information and completes any required verification steps (like 3D Secure).

4. Customer is redirected back to your website

• If the customer completes the payment, they are redirected to the complete_url with a payment_id query parameter
• If the customer cancels, they are redirected to the fail_url

5. Receive asynchronous notification

MONEI sends an HTTP POST request to your callback_url with the payment result. This ensures you receive the payment status even if the customer closes their browser during the redirect.

For more information about the hosted payment page, visit the MONEI Hosted Payment Page documentation.

Webhooks

Webhooks can be configured in the MONEI Dashboard → Settings → Webhooks.

Signature Verification

When receiving webhooks from MONEI, you should verify the signature to ensure the request is authentic:

Handling Payment Callbacks

MONEI sends an HTTP POST request to your callback_url with the payment result. This ensures you receive the payment status even if the customer closes their browser during the redirect.

Example of handling the callback in a PHP script:

Important Notes About Webhooks

1. Always verify the signature to ensure the webhook is coming from MONEI
2. Use the raw request body for signature verification
3. Return a 2xx status code to acknowledge receipt of the webhook
4. Process webhooks asynchronously for time-consuming operations
5. Implement idempotency to handle duplicate webhook events

MONEI Connect for Partners

If you're a partner or platform integrating with MONEI, you can act on behalf of your merchants by providing their Account ID. This is part of MONEI Connect, which allows platforms to manage multiple merchant accounts.

Important: When using Account ID functionality, you must:

1. Use a partner API key (not a regular merchant API key)
2. Provide a custom User-Agent to identify your platform

For more information about MONEI Connect and becoming a partner, visit the MONEI Connect documentation.

Account ID

Setting Account ID after initialization

Custom User-Agent

When integrating as a MONEI Connect partner, your User-Agent should follow this format:

For example: MONEI/YourPlatform/1.0.0

This format helps MONEI identify your platform in API requests and is required when using the Partner API Key.

Examples with Proper User-Agent Format

Note: When using Account ID, you must set a custom User-Agent before making any API calls. The User-Agent is validated when making API requests.

Important: To use this feature, you need to be registered as a MONEI partner and use your partner API key. Please contact [email protected] to register as a partner.

Managing Multiple Merchant Accounts

Development

Building the SDK

The SDK is built using OpenAPI Generator. To build the SDK from the OpenAPI specification:

Tests

To run the unit tests:

Code Style

This project follows the PSR-12 coding standard. We use PHP CS Fixer to enforce the coding standards.

To check the code style:

To automatically fix code style issues:

Documentation

For the full documentation, check our Documentation portal.

For a comprehensive overview of all MONEI features and integration options, visit our main documentation portal. There you can explore guides for:

• Using a prebuilt payment page with MONEI Hosted payment page
• Building a custom checkout with MONEI UI components
• Integrating with multiple e-commerce platforms
• Connecting with business platforms and marketplaces