See the Developer
API docs.
You can install the package via composer:
composer require arifpay/arifpay
The package needs to be configured with your account's API key, which is available in the Arifpay Dashboard. Require it with the key's value. After install the package. you can use as follow.
⚠️ Since V2Arifpay->create()
is deprecated andArifpay->checkout->create()
should be used.
use Arifpay\Phpsdk\Arifpay;
...
$arifpay = new Arifpay('your-api-key');
After importing the arifpay
package, use the checkout property of the Arifpay instance to create or fetch checkout sessions
.
require_once 'vendor/autoload.php';
use Arifpay\Phpsdk\Arifpay;
use Arifpay\Phpsdk\Helper\ArifpaySupport;
use Arifpay\Phpsdk\Lib\ArifpayBeneficary;
use Arifpay\Phpsdk\Lib\ArifpayCheckoutItem;
use Arifpay\Phpsdk\Lib\ArifpayCheckoutRequest;
use Arifpay\Phpsdk\Lib\ArifpayOptions;
$arifpay = new Arifpay('your-api-key');
$expired = "2023-01-13T17:09:42.411";
$data = new ArifpayCheckoutRequest(
cancel_url: 'https://api.arifpay.com',
error_url: 'https://api.arifpay.com',
notify_url: 'https://gateway.arifpay.net/test/callback',
expireDate: $expired,
nonce: floor(rand() * 10000) . "",
beneficiaries: [
ArifpayBeneficary::fromJson([
"accountNumber" => '01320811436100',
"bank" => 'AWINETAA',
"amount" => 10.0,
]),
],
paymentMethods: ["CARD"],
success_url: 'https://gateway.arifpay.net',
items: [
ArifpayCheckoutItem::fromJson([
"name" => 'Bannana',
"price" => 10.0,
"quantity" => 1,
]),
],
);
$session = $arifpay->checkout->create($data, new ArifpayOptions(sandbox: true));
echo $session->session_id;
To track the progress of a checkout session you can use the fetch method as shown below:
$arifpay = new Arifpay('API KEY...');
// A sessionId will be returned when creating a session.
$session = $arifpay->checkout->fetch('checkOutSessionID', new ArifpayOptions(true));
The following object represents a session
{
public int $id,
public ArifpayTransaction $transcation,
public float $totalAmount,
public bool $test,
public string $uuid,
public string $created_at,
public string $update_at
}
If the merchant want to cancel a checkout session. it's now possible as shown below.
$arifpay = new Arifpay('API KEY...');
// A sessionId will be returned when creating a session.
$session = $arifpay->checkout->cancel('checkOutSessionID', new ArifpayOptions(true));
The ArifpayCheckoutSession
class is returned.
learn more about DirectPay here
$session = $arifpay->checkout->create($data, new ArifpayOptions(true));
return $arifpay->directPay->telebirr->pay($session->session_id);
$session = $arifpay->checkout->create($data, new ArifpayOptions(true));
return $arifpay->directPay->awash_wallet->pay($session->session_id);
$session = $arifpay->checkout->create($data, new ArifpayOptions(true));
return $arifpay->directPay->awash->pay($session->session_id);
Released Date: v1.1.1
Oct 03, 2022
- Initial Release
The MIT License (MIT). Please see License File for more information.