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

به‌روزرسانی پذیرنده

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

فقط title، description، logo_url و link را عوض می‌کند. فیلدی که نفرستید همان می‌ماند و null مقدار description، logo_url یا link را پاک می‌کند. موبایل مالک عوض نمی‌شود.

پذیرنده را با merchant_id، external_id یا هر دو مشخص کنید؛ اگر هر دو را بفرستید باید به یک پذیرنده برسند، وگرنه 422 merchant_id_mismatch.

PATCH /merchant-network-api/v1/merchants
curl -X PATCH "$RINGPAY_BASE_URL/merchant-network-api/v1/merchants" \
  -H "Authorization: Bearer $RINGPAY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "shop-1",
    "title": "فروشگاه نمونهٔ مرکزی",
    "logo_url": null
  }'
Response 204
(no body)

پارامترها

  • merchant_idstringدست‌کم یکی

    شناسهٔ پذیرنده در رینگ‌پی.

  • external_idstringدست‌کم یکی

    شناسهٔ پذیرنده در سامانهٔ شما. حداکثر 128 نویسه.

  • titlestring

    نام تازه. null پذیرفته نمی‌شود.

  • descriptionstring

    توضیح تازه؛ null پاکش می‌کند.

  • logo_urlstring

    آدرس تازهٔ لوگو، مطلق http یا https؛ null پاکش می‌کند.

پاسخ

204 بدون بدنه.

خطاها

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

  • invalid_request400

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

  • invalid_access_key401

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

  • access_denied403

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

  • merchant_not_found404

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

  • merchant_id_mismatch422

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

  • internal_error500

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

صفحه‌ها

endpointها