forumpay/payment-gateway-php-client

Payment Gateway PHP Api Client

v1.5.1 2026-02-05 11:44 UTC

Requires

• php: >=7.4
• ext-curl: *
• ext-json: *
• psr/log: >=1.1.4

Requires (Dev)

• phpunit/phpunit: ^9.6.0
• symplify/easy-coding-standard: ^9.3.10

MIT

README

PHP Client for interacting with Payment Gateway Webhost API

Install

Run composer require forumpay/payment-gateway-php-client

Usage

Example usage for getting currency list.

use ForumPay\PaymentGateway\PHPClient\PaymentGatewayApi;

$paymentGatewayApi = new PaymentGatewayApi(
    $paymentGatewayUri,
    $apiUser,
    $apiSecret,
    $userAgentApplicationIdentifier
);

try {
    $getCurrencyListResponse = $paymentGatewayApi->getCurrencyList('EUR');
} catch (ApiExceptionInterface $exception) {
    //TODO: handle the exception
}

Where:

$paymentGatewayUri is Service URL as per API documentation

$apiUser and $apiSecret are credentials for Payment Gateway API Keys

$userAgentApplicationIdentifier represents the user agent application identifier for HTTP the client. Example: ('MyPaymentApp/1.0.0')

Available endpoints

• Ping
• GetRate
• GetRates
• StartPayment
• CheckPayment
• GetTransactions
• CancelPayment
• GetCurrencyList
• RequestKyc
• GetWalletApps

For corresponding methods refer to PaymentGatewayApiInterface in src/PaymentGatewayApiInterface.php