روش نصب

npm i zarinpal-pay

متد ها

create() // ایجاد تراکنش
verify() // تایید تراکنش
unverified() // ليست پرداخت هاي موفق اخیر

احراز هویت درگاه

import  ZarinpalPayment from  "zarinpal-pay";
const zarinpal = new ZarinpalPayment (Merchant, isTomam ,isSandbox);

پارمتر Merchant

• كد 36 كاراكتری اختصاصی برای احراز هویت درگاه

پارمتر isTomam (اختیاری)

• واحد پولی درگاه که صورت پیشفرض ریال می باشد.

  مقدار به صورت پیشفرض false می باشد و در صورت true واحد پولی درگاه تومان میشود.

پارمتر isSandbox (اختیاری)

• درگاه آزمایشی

  به صورت پیشفرض false می باشد در صورت true بودن درگاه به صورت آزمایشی می باشد.

  برای استفاده از درگاه آزمایشی باید برای قسمت Merchant کد 36 کارکتر دلخواه وارد نمایید

  ایجاد تراکنش

try{

	const createpay = await zarinpal.create({
	amount: 100000,
	callback_url: "http://localhost:8080/callback",
	mobile: "09339993377",
	email: "[email protected]",
	description: "توضیحات تراکنش",
	order_id: "3010",
	});

}catch (err) {
	console.log(err);
}

در صورت درست بودن تمام ورودی های متد پاسخ زیر برای شما به صورت جیسون به شما داده میشود و مقدار code باید 100 باشد

{
    "data":{
        "code": 100,
        "message": "Success",
        "authority": "A00000000000000000000000000217885159",
        "fee_type": "Merchant",
        "fee": 100,
        link:"https://zarinpal.com/pg/StartPay/A00000000000000000000000000217885159"
	},
	"errors": []
}

شما باید برای انجام مراحل پرداخت کاربر را به پراپرتی link در پاسخ ایجاد تراکنش ریدایرکت کنید

در صورت بروز خطا در ایجاد تراکنش پاسخی مشابه زیر به صورت جیسون دریافت می کنید

{
  code: -9,
  message: 'The input params invalid, validation error.',
  validations: [ { amount: 'The amount must be at least 1000.' } ]
}

لیست خطاها

| اجباری | نوع مقدار | توضیحات | ورودی | | ------ | --------- | ---------------------------------- | ------------ | | بله | عدد | مبلغ تراكنش | amount | | بله | رشته | صفحه بازگشت پس از انجام عمل پرداخت | callback_url | | خیر | رشته | شماره تماس خریدار | mobile | | خیر | رشته | ایمیل خریدار | email | | خیر | رشته | توضیحات مربوط به تراکنش | description | | خیر | رشته | شماره سفارش | order_id |

تایید تراکنش

در صفحه کال بک می توانید مرحله اعتبار سنجی تراکنش را با متد verify انجام دهید.

try{

  const verifypay = await zarinpal.verify({authority , amount});

}catch (err) {

	console.log(err);

}

بعد از پايان عمليات درسمت زرينپال، زرينپال وظيفه دارد كاربر را به سايت پذيرنده كه از طريق callback_url مشخص شده است بازگرداند.

این مرحله زمانی انجام میشه که کاربر از درگاه پرداخت بر میگرده. در این مرحله با توجه به نتیجه تراکنش و وضعیت اون ، ما کاربر رو به آدرس کالبک شما که در ارسال اطلاعات با پارامتر callback_url ارسال کرده بودید هدایت میکنیم.

نكته: توجه داشته باشيد كه يك Status به صورت QueryString به سايت پذيرنده ارسال ميگردد كه دو مقدار ثابت دارد ”OK“ و”NOK“ ؛ در صورتي كه اين مقدار برابر ”NOK“ بود به اين معنا بوده كه تراكنش نا موفق بوده و يا توسط كاربر لغو شده است؛ پس در صورتي verify استفاده شود كه با QueryString مقدار Status برابر با ”OK“ باشد.

http://www.yoursite.ir/Authority=A00000000000000000202690354&Status=OK

http://www.yoursite.ir/Authority=A00000000000000000202690354&Status=NOK

| اجباری | نوع | ورودی | | ------ | ---- | --------- | | بله | عدد | amount | | بله | رشته | authority |

در غير اينصورت پذيرنده موظف اسـت كـه بـا توجه به كد خطايي كه توسط متد verify دريافت ميكند كاربر را از خطاي رخ داده مطلع سازد.

در این مرحله اگر مقدار پارامتر code برابر 100 بود به معنای موفق بودن تراکنش است و با پارامتر ref_id شماره تراکنش را به کاربر نمایش میدهید

در صورتی که کاربر تراکنش را پرداخت کرده باشد پاسخ متد verify مشابه زیر است توجه کنید باید مقدار code عدد 100 باشد

{
    "data": {
        "code": 100,
        "message": "Verified",
        "card_hash": "1EBE3EBEBE35C7EC0F8D6EE4F2F859107A87822CA179BC9528767EA7B5489B69",
        "card_pan": "502229******5995",
        "ref_id": 201,
        "fee_type": "Merchant",
        "fee": 0
    },
    "errors": []
}

کد code 101 به معنای آن است که تراکنش موفق بوده و یکبار قبلا وریفای شده است و این بار دوم هست

متد unverified

ممكن است شما نياز داشته باشيد كه متوجه شويد چه پرداخت هاي توسط وب سرويس شما به درستي انجام شده اما متد verify روي آنها اعمال نشده ، به عبارت ديگر اين متد ليست پرداخت هاي موفقي كه شما آنها را تصديق نكرده ايد را به شما نمايش مي دهد.

نمونه اطلاعات بازگشتی :

{
    "data": {
        "code": "100",
        "message": "Success",
        "authorities": [
            {
                "authority": "A00000000000000000000000000207288780",
                "amount": 50500,
                "callback_url": "https://golroz.com/vpay",
                "referer": "https://golroz.com/test-form/",
                "date": "2020-07-01 17:33:25"
            },
            {
                "authority": "A00000000000000000000000000207296503",
                "amount": 50500,
                "callback_url": "https://golroz.com/vpay",
                "referer": "https://golroz.com/test-form/",
                "date": "2020-07-01 18:58:32"
            },
            {
                "authority": "A00000000000000000000000000206873220",
                "amount": 11100,
                "callback_url": "zarin_link",
                "referer": "/",
                "date": "2020-06-27 10:22:02"
            }
        ]
    }
}