‏API شبکهٔ پذیرنده › پذیرنده

فهرست پذیرنده‌ها

OpenAPI
GET/merchant-network-api/v1/merchants

پذیرنده‌های شبکهٔ شما را در هر وضعیتی برمی‌گرداند، جدیدترین اول. برای پیدا کردن پذیرنده با شناسهٔ سامانهٔ خودتان external_id را بفرستید.

GET /merchant-network-api/v1/merchants
curl "$RINGPAY_BASE_URL/merchant-network-api/v1/merchants?limit=20" \
  -H "Authorization: Bearer $RINGPAY_API_KEY"
Response 200
{
  "items": [
    {
      "merchant_id": "86Rf07xd4z",
      "external_id": "shop-1",
      "title": "فروشگاه نمونه",
      "logo_url": "https://shop.example.com/logo.png",
      "status": "activated",
      "kyc_status": "accepted",
      "joined_at": "2026-11-01T08:00:00Z"
    }
  ],
  "next_page": "/merchant-network-api/v1/merchants?limit=20&cursor=…"
}

پارامترها

  • qstring

    بخشی از نام پذیرنده، حداکثر ۱۰۰ نویسه. بزرگی و کوچکی حروف، «ی» و «ک» عربی و فارسی، رقم‌های فارسی و لاتین و نیم‌فاصله در برابر فاصله یکی گرفته می‌شوند.

  • external_idstring

    فقط پذیرنده‌ای با این شناسه در سامانهٔ شما؛ پس حداکثر یکی. با q هر دو باید بخوانند. حداکثر 128 نویسه.

  • limitinteger

    اندازهٔ صفحه. از 1 تا 50، پیش‌فرض 20.

  • cursorstring

    از next_page پاسخ قبلی بردارید؛ خودتان نسازید.

پاسخ

items فهرست پذیرنده‌هاست (موجودیت پذیرنده). next_page آدرس صفحهٔ بعد است و در صفحهٔ آخر null؛ همان آدرس را بخوانید تا null شود. جستجو ترتیب را عوض نمی‌کند.

خطاها

کدهای مشترک و رفتار هر کد در خطاها آمده.

  • invalid_request400

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

  • invalid_access_key401

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

  • access_denied403

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

  • internal_error500

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

صفحه‌ها

endpointها