UnoPay

نقطه ورود. یک بار با درگاه‌هایی که پیکربندی کرده‌اید آن را می‌سازید؛ از آن پس کلید درگاه در هر فراخوانی در زمان کامپایل با همان نگاشت بررسی می‌شود.

export class UnoPay<TGateways extends Record<string, GatewayAdapter>> {
  constructor(adapters: TGateways, logger?: PaymentLogger);
}

فیلدها

متدها

• UnoPay.createPayment
• UnoPay.verifyCallback

نمونه کد

const unopay = new UnoPay(
  { zarinpal: new ZarinpalAdapter({ merchantId: process.env.ZARINPAL_MERCHANT_ID! }) },
  logger
);

از درگاه نام‌برده می‌خواهد پرداخت را آغاز کند و محل ارسال پرداخت‌کننده را برمی‌گرداند. قید K یک درگاه ناشناخته را به خطای کامپایل تبدیل می‌کند نه خطای زمان اجرا.

createPayment<K extends keyof TGateways>(
  provider: K,
  request: PaymentRequest
): Promise<PaymentResult>

پارامترها

خروجی

Promise<PaymentResult> — نشانی ریدایرکت، آتوریتی به‌عنوان transactionId و توکن درگاه.

خطاها

• PaymentError — کد ADAPTER_NOT_FOUND وقتی provider کلیدی از آبجکت adapters نباشد. همگام است؛ پرامیس بازگشتی رد می‌شود.
• PaymentError and subclasses — بدون تغییر دوباره پرتاب می‌شود وقتی خود آداپتور یک PaymentError تولید کند.
• GatewayProviderError — هر مقدار پرتاب‌شده دیگری را در خود می‌پیچد، بنابراین باگ درون آداپتور هم با کدی به شکل خطای پرداخت ظاهر می‌شود.

نمونه کد

const payment = await unopay.createPayment('zarinpal', {
  amount: 50000,
  currency: 'IRT',
  callbackUrl: 'https://yoursite.com/api/payment/callback',
  metadata: { description: 'Order #1024' },
});
return Response.redirect(payment.redirectUrl, 302);

پرداخت را نزد درگاه تایید می‌کند و پاسخ را یکسان‌سازی می‌کند. پرداخت‌کننده‌ای که پرداخت را رها کرده به‌صورت نتیجه false برمی‌گردد، نه استثنا.

verifyCallback<K extends keyof TGateways>(
  provider: K,
  request: CallbackRequest
): Promise<VerificationResult>

پارامترها

خروجی

Promise<VerificationResult> — isSuccessful به‌همراه ref_id درگاه، مبلغ بازتابیده و errorReason وقتی پرداخت تایید نشد.

خطاها

• PaymentError — کد ADAPTER_NOT_FOUND برای درگاه ناشناخته.
• GatewayProviderError — هر خطای غیر PaymentError را در خود می‌پیچد، از جمله خطای شبکه هنگام تماس با درگاه.
• PaymentValidationError — از ZarinpalAdapter وقتی Authority یا مبلغ عددی غایب باشد. بدون تغییر دوباره پرتاب می‌شود.

نمونه کد

const result = await unopay.verifyCallback('zarinpal', {
  method: req.method,
  query: req.query as Record<string, string>,
  body: req.body ?? {},
});

if (result.isSuccessful) {
  return res.send(`Paid. Ref ${result.transactionId}`);
}
return res.status(400).send(`Failed: ${result.errorReason}`);