درگاه‌ها

گزینه‌های پیکربندی

• merchantId — رشته، الزامی. شناسه پذیرنده زرین‌پال.
• sandbox — بولی، اختیاری. با true نشانی sandbox.zarinpal.com انتخاب می‌شود.
• logger — PaymentLogger، اختیاری. در کانفیگ پذیرفته می‌شود اما به مسیر درخواست متصل نیست.

نکات خاص

• توکن آتوریتی ۳۶ کاراکتر دارد. آتوریتی سندباکس با S و آتوریتی پروداکشن با A شروع می‌شود.
• متد وریفای بار اول کد 100 و در فراخوانی مجدد همان آتوریتی کد 101 برمی‌گرداند. UnoPay هر دو را موفق می‌داند، بنابراین کال‌بک تکراری بی‌خطر است.
• کال‌بک به‌صورت GET با پارامترهای Authority و Status ارسال می‌شود که Status برابر OK یا NOK است. UnoPay ابتدا Authority را از کوئری و سپس از بدنه می‌خواند.
• آداپتور در کال‌بک به amount عددی نیاز دارد. اگر درگاه مبلغ را به ریال ارسال کند ولی شما تومان فرستاده باشید، اعتبارسنجی پیش از فراخوانی شبکه با خطای VALIDATION_ERROR متوقف می‌شود.
• فیلد metadata از PaymentRequest به‌صورت یک آبجکت سطح‌بالا به زرین‌پال ارسال می‌شود. نسخه ۴ زرین‌پال فیلدهای ناشناخته را نادیده می‌گیرد، پس بی‌خطر است اما بر تسویه اثری ندارد.
• مقدار description از metadata.description خوانده می‌شود و در نبود آن به رشته ثابت "Payment" برمی‌گردد.

مشخصات کلیدی

• zarinpal-rest-api-v4.md
• Doc-English.pdf
• Doc-Persian.pdf

نحوه استفاده

import { UnoPay, ZarinpalAdapter } from 'unopay';

const unopay = new UnoPay({
  zarinpaladapter: new ZarinpalAdapter({
    merchantId: process.env.ZARINPAL_MERCHANT_ID!,
    sandbox: process.env.NODE_ENV !== 'production',
  }),
});

await unopay.createPayment('zarinpal', request);