API شبکهٔ پذیرنده › پذیرنده
بهروزرسانی پذیرنده
/merchant-network-api/v1/merchantsفقط title، description، logo_url و link را عوض میکند. فیلدی که نفرستید همان میماند و null مقدار description، logo_url یا link را پاک میکند. موبایل مالک عوض نمیشود.
پذیرنده را با merchant_id، external_id یا هر دو مشخص کنید؛ اگر هر دو را بفرستید باید به یک پذیرنده برسند، وگرنه 422 merchant_id_mismatch.
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
}'(no body)پارامترها
merchant_idstringدستکم یکیشناسهٔ پذیرنده در رینگپی.
external_idstringدستکم یکیشناسهٔ پذیرنده در سامانهٔ شما. حداکثر 128 نویسه.
titlestringنام تازه.
nullپذیرفته نمیشود.descriptionstringتوضیح تازه؛
nullپاکش میکند.linkstringلینک تازه، آدرس مطلق http یا https؛
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_mismatch422merchant_idوexternal_idبه یک پذیرنده نمیرسند.internal_error500خطای رینگپی. کمی بعد همان درخواست را تکرار کنید.