npm:cordova-plugin-zarinpal

README

ZarinPal Cordova Plugin

ZarinPal is the first pioneer payer in Iran. This plugin makes it easy to integrate your Cordova based (e.g. Ionic, PhoneGap, PhoneGap Build, Intel XDK or Sencha Touch) app with ZarinPal.

Installation and Setup

1. Initialize

In deviceready event use window.ZarinPal.initialize(MerchantId, IsSandbox, Result) code. Sample:

window.ZarinPal.initialize(
  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  true,
  function(result) {
    console.log("Initialize success");
  }
);

2. Start Payment

To start payment use window.ZarinPal.startPayment(AutoShowPaymentPage, Amount, Description, Email, Phone, Result) code. Sample auto show payment page:

window.ZarinPal.startPayment(
  true,
  2000,
  'Test Payment',
  'rezagah.milad@gmail.com',
  '',
  function(result) {
    //Success (true/false): result.Success
    //RefId: result.RefID
    console.log(result);
  }
)

Sample manual show payment page:

window.ZarinPal.startPayment(
  false,
  2000,
  'Test Payment',
  'rezagah.milad@gmail.com',
  '',
  function(result) {
    //Status: result.Status
    //Authority: result.Authority
    if (result.Status === 100) {
      window.ZarinPal.showPayment(
        null,
        function(error) {
          console.log(error);
        }
      );
    }
  }
)

3. Verification Payment

Add window.ZarinPal.verificationPayment(Success, Error) code in resume event. to fire resume event add document.addEventListener("resume", Function, false) in your deviceready event. Sample:

document.addEventListener("deviceready", function () {
  document.addEventListener("resume", onResume, false);
}, false);
      
function onResume() {
  console.log('onResume');
}

Manual Show Payment Page

To manually show payment page use window.ZarinPal.showPayment(Success, Error) code.

Sample

You can see cordova sample from index.html.

Construct 2 Plugin

You can download Construct 2 plugin from Vinoos.ir.

Demo Project

To make things easier, we have published demo projects for Cordova WebView and Cocoon Canvas+

Usage no npm install needed!