شروع کار › خطاها

خطاها

هر پاسخ ناموفق کد HTTP غیر 2xx و بدنهٔ JSON با یک شیء error دارد. تصمیم را روی کد HTTP و code بگیرید: code پایدار است و معنایش عوض نمی‌شود. message توضیحی انگلیسی برای لاگ و پشتیبانی است، ممکن است تغییر کند و نباید به مشتری نشان داده شود.

Response 409
{
  "error": {
    "code": "invoice_order_conflict",
    "message": "external_order_id already has an invoice with another amount or payer_mobile"
  }
}
Node.js
const res = await fetch(url, options);
if (!res.ok) {
  const { error } = await res.json();
  switch (error.code) {
    case "invoice_order_conflict":
      // same order, different amount: fix the order
      break;
    case "invalid_access_key":
      // rotate the key in the network panel
      break;
    default:
      log(res.status, error.code, error.message);
  }
}

بدنهٔ خطا

  • error.codestring

    شناسهٔ پایدار خطا، از جدول پایین. تصمیم را روی همین بگیرید.

  • error.messagestring

    توضیح انگلیسی برای لاگ؛ ثابت نیست و نباید به مشتری نشان داده شود.

کدهای خطا

همهٔ کدهای API درگاه و API شبکهٔ پذیرنده. صفحهٔ هر endpoint کدهای خودش را هم فهرست می‌کند.

  • invalid_request400

    بدنه یا پارامترها نامعتبرند؛ مثلاً مبلغ صفر، موبایل بدون قالب E.164، callback_url بدون https یا cursor ساختگی.

  • invalid_access_key401

    کلید فرستاده نشده، نامعتبر است، منقضی شده یا باطل شده.

  • access_denied403

    کلید دسترسی این API را ندارد (gateway_access برای درگاه، merchant_access برای پذیرنده‌ها)، یا درخواست از IPی بیرون از فهرست مجاز کلید آمده.

  • invoice_not_found404

    صورت‌حساب نیست، مال پذیرندهٔ شبکهٔ دیگری است یا صورت‌حساب حضوری است.

  • merchant_not_found404

    پذیرنده‌ای با این شناسه در شبکهٔ شما نیست.

  • invoice_not_consumable409

    صورت‌حساب paid نیست، یا ۳۰ دقیقهٔ تأیید مصرف گذشته.

  • invoice_order_conflict409

    همین external_order_id قبلاً با مبلغ یا موبایل دیگری ثبت شده.

  • merchant_not_payable409

    پذیرنده هنوز فعال نشده یا مسدود است و نمی‌تواند پرداخت بگیرد.

  • owner_mobile_mismatch409

    این external_id قبلاً با موبایل مالک دیگری ثبت شده.

  • merchant_id_mismatch422

    merchant_id و external_id به یک پذیرنده نمی‌رسند.

  • internal_error500

    خطای رینگ‌پی. کمی بعد همان درخواست را تکرار کنید.

صفحه‌ها

endpointها