forumpay / payment-gateway-php-client
Payment Gateway PHP Api Client
Installs: 1 996
Dependents: 2
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Requires (Dev)
- phpunit/phpunit: ^9.6.0
- symplify/easy-coding-standard: ^9.3.10
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
- StartPayment
- CheckPayment
- GetTransactions
- CancelPayment
- GetCurrencyList
- RequestKyc
For corresponding methods refer to PaymentGatewayApiInterface
in src/PaymentGatewayApiInterface.php