aleksandrzhiliaev / omnipay-okpay
Okpay gateway for Omnipay payment processing library
Installs: 1 159
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 1
Forks: 2
Open Issues: 0
Requires
- omnipay/common: ~2.0
Requires (Dev)
- omnipay/tests: ~2.0
This package is auto-updated.
Last update: 2024-12-10 12:29:51 UTC
README
Okpay gateway for Omnipay payment processing library.
Omnipay is a framework agnostic, multi-gateway payment processing library for PHP 5.3+. This package implements Okpay support for Omnipay.
Installation
Omnipay is installed via Composer. To install, simply add it
to your composer.json
file:
{ "require": { "aleksandrzhiliaev/omnipay-okpay": "*" } }
And run composer to update your dependencies:
$ curl -s http://getcomposer.org/installer | php
$ php composer.phar update
Basic Usage
The following gateways are provided by this package:
- Okpay
For general usage instructions, please see the main Omnipay repository. See also the Okpay Documentation
Example
- Purchase:
$gateway = Omnipay::create('Okpay'); $gateway->setAccount(''); $gateway->setAccountName(''); $gateway->setSecret(''); $response = $gateway->purchase([ 'amount' => '0.1', 'currency' => 'USD', 'transactionId' => time(), 'description' => 'Order # 123', ])->send(); if ($response->isSuccessful()) { // success } elseif ($response->isRedirect()) { # Generate form to do payment $hiddenFields = ''; foreach ($response->getRedirectData() as $key => $value) { $hiddenFields .= sprintf( '<input type="hidden" name="%1$s" value="%2$s" />', htmlentities($key, ENT_QUOTES, 'UTF-8', false), htmlentities($value, ENT_QUOTES, 'UTF-8', false) )."\n"; } $output = '<form action="%1$s" method="post"> %2$s <input type="submit" value="Purchase" /></form>'; $output = sprintf( $output, htmlentities($response->getRedirectUrl(), ENT_QUOTES, 'UTF-8', false), $hiddenFields ); echo $output; # End of generating form } else { echo $response->getMessage(); }
- Validate webhook
try { $response = $gateway->completePurchase()->send(); $success = $response->isSuccessful(); if ($success) { $transactionId = $response->getTransactionId(); $amount = $response->getAmount(); $currency = $response->getCurrency(); // success } } catch (\Exception $e) { // check $e->getMessage() }
- Do refund
try { $response = $gateway->refund( [ 'payeeAccount' => 'OK993835197', 'amount' => 0.1, 'description' => 'Testing okpay', 'currency' => 'USD', ] )->send(); if ($response->isSuccessful()) { // success } else { // check $response->getMessage(); } } catch (\Exception $e) { // check $e->getMessage(); }
Support
If you are having general issues with Omnipay, we suggest posting on Stack Overflow. Be sure to add the omnipay tag so it can be easily found.
If you want to keep up to date with release anouncements, discuss ideas for the project, or ask more detailed questions, there is also a mailing list which you can subscribe to.
If you believe you have found a bug, please report it using the GitHub issue tracker.