Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Omnipay: ZarinPal

ZarinPal driver for the Omnipay PHP payment processing library

Packagist Version PHP from Packagist Packagist Downloads Tests Status Coverage Status License Twitter: nekofar

Omnipay is a framework agnostic, multi-gateway payment processing library for PHP. This package implements ZarinPal support for Omnipay.


Omnipay is installed via Composer. To install, simply require league/omnipay and nekofar/omnipay-zarinpal with Composer:

composer require league/omnipay nekofar/omnipay-zarinpal

Basic Usage

The following gateways are provided by this package:

  • ZarinPal

For general usage instructions, please see the main Omnipay repository.



The result will be a redirect to the gateway or bank.

use Omnipay\Omnipay;

$gateway = Omnipay::create('ZarinPal');

// Send purchase request
$response = $gateway->purchase([
    'amount' => 100,
    'description' => 'Some description'

// Process response
if ($response->isRedirect()) {
    // Redirect to offsite payment gateway
} else {
    // Payment failed: display message to customer
    echo $response->getMessage();

On return, the usual completePurchase will provide the result of the transaction attempt.

The final result includes the following methods to inspect additional details:

// Send purchase complete request
$response = $gateway->completePurchase([
    'amount' => 100,
    'authority' => $_REQUEST['Authority'], 

// Process response
if ($response->isSuccessful()) {
    // Payment was successful
} else {
    // Payment failed: display message to customer
    echo $response->getMessage();


composer test


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, or better yet, fork the library and submit a pull request.