README

The EDPay PHP SDK is a server-side client for the EDPay payment platform. It provides resources for payments, checkout, payment links, customers, invoices, subscriptions, and webhook signature verification.

Requirements

PHP 7.4 or later for the core SDK
PHP curl and json extensions
Composer
Laravel integration: an existing Laravel application (Laravel classes are provided by this repository; Laravel is not a core SDK dependency)

Install with Composer

From your application's root directory, install the SDK with Composer:

composer require edutecka/edpay-php-sdk

Composer installs the SDK and registers its autoloader. You can then use the EDPay\EDPayClient class in your PHP application.

Create a payment

Keep both API keys on your server. Use test keys for sandbox requests. The SDK sends requests to https://api-pay.edutecka.com by default; only override the base URL when EDPay provides a different host for your account.

<?php
require_once __DIR__ . '/vendor/autoload.php';

use EDPay\EDPayClient;

$client = new EDPayClient(
    getenv('EDPAY_PUBLIC_KEY'),
    getenv('EDPAY_PRIVATE_KEY'),
    'sandbox',
    getenv('EDPAY_API_URL') ?: EDPayClient::DEFAULT_BASE_URI
);

$payment = $client->payments()->create([
    'amount_minor' => 50000, // 500.00 MZN
    'currency' => 'MZN',
    'method' => getenv('EDPAY_METHOD'), // an identifier from GET /v1/public/payment-methods
    'reference' => 'ORDER-10492',
    'description' => 'Example order',
    'phone' => '+25884xxxxxxx',
], 'ORDER-10492'); // optional idempotency key

var_export($payment);

The SDK sends X-EDPay-Public-Key and X-EDPay-Private-Key headers and adds Idempotency-Key when the optional key is supplied. Do not expose the private key in browser or mobile-app code. Amounts are in minor units; for MZN, 50000 represents MZN 500.00. The method value is dynamic; use an identifier returned by GET /v1/public/payment-methods or supported by your account. Include phone only when required by the selected method.

Laravel integration

When the SDK is available to a Laravel application's Composer autoloader, Laravel package discovery registers the service provider and Edpay facade. Publish the configuration and, if needed, the optional migrations:

php artisan vendor:publish --tag=edpay-config
php artisan vendor:publish --tag=edpay-migrations
php artisan migrate

Set server-side values in the application environment (do not commit .env):

EDPAY_PUBLIC_KEY=pk_test_...
EDPAY_PRIVATE_KEY=sk_test_...
EDPAY_ENVIRONMENT=sandbox
EDPAY_WEBHOOK_SECRET=whsec_...

Configure the API keys for the environment you want to use. The API base URL defaults to https://api-pay.edutecka.com. A Laravel service can use the facade as follows:

use EDPay\Laravel\Facades\Edpay;

$payment = Edpay::checkout()->charge([
    'amount_minor' => 50000,
    'currency' => 'MZN',
    'method' => config('services.edpay.method'),
    'reference' => 'ORDER-10492',
]);

checkout()->charge() sends a request to POST /v1/payment-checkout. For other operations, the client exposes payments(), checkout(), paymentLinks(), customers(), invoices(), subscriptions(), and webhooks() resources.

Available operations

Payments: create, get, list, events
Checkout: charge, createSession, getSession
Payment links: create, get, list, deactivate
Customers: create, get, list
Invoices: create, get, list, finalize, void
Subscriptions: create, get, list, pause, resume
Webhooks: constructEvent

Resource methods return decoded PHP arrays. Use the returned payment ID to retrieve the payment or its events, and verify a webhook before processing its event.

Verify webhooks

Read the raw request body and the X-EDPay-Signature header, then verify the signature with the webhook secret before updating an order or account:

$event = $client->webhooks()->constructEvent(
    $rawRequestBody,
    $signatureHeader,
    getenv('EDPAY_WEBHOOK_SECRET')
);

The verifier uses HMAC-SHA256 and throws EDPay\Exceptions\SignatureVerificationException if verification fails or the payload is invalid. Register the webhook URL and required events in the EDPay dashboard.

Documentation

License

The Composer package metadata declares the MIT license.

Other official SDK repositories

Official e-commerce plugin repositories

These repositories are official integration previews. Check each repository's status and test it in a sandbox before using it with a live store.

edutecka / edpay-php-sdk

Package info

Security

Statistics