reseller

PATCH `/v1/reseller/currencies`

Choose the currencies, the default, and what you sell in.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن reseller.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

حيث يتم إدخال معرف مؤسستك

تأخذ نقطة النهاية هذه org_id كمعلمة استعلام. اتركه فارغاً ليغطي الاستدعاء شجرة مستأجريك بالكامل، أو أرسله لتضييق نطاق الاستدعاء ليشمل منظمة واحدة.

معرف مؤسستك موجود على شاشة مفاتيح واجهة برمجة التطبيقات (API) في لوحة تحكمك، بجوار المفتاح نفسه. وهو نفس المعرف في كل طلب تجريه.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X PATCH https://api.zinndigital.com/v1/reseller/currencies \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

`currencies` replaces the list your clients may be quoted in; send an empty array to go back to offering every currency we can charge. `default_currency` is what a client is quoted in before they choose and must be one you offer. `sell_in_currency` is what you are settled in and is deliberately **not** required to be one of them — a reseller may be paid in one currency and sell in others. `switcher: false` hides the control from your clients. A currency no payment gateway can capture is refused rather than dropped, because a currency we can display and cannot charge is a checkout that fails at the last step. Requires `reseller.manage`.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`org_id (query)`	`Uuid`	لا	Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r…

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`currencies`	`string[]`	لا	Replaces the list your clients may be quoted in. An empty array returns you to offering every currency we can charge.
`default_currency`	`string`	لا	Empty returns to the platform answer. Must be one you offer.
`sell_in_currency`	`string`	لا	Empty returns to the platform base currency. Deliberately not required to be one of `currencies`.
`switcher`	`boolean`	لا	Whether the currency control renders in your clients' panel.

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`currencies`	`ResellerCurrency[]`	نعم	—
`offers_all`	`boolean`	نعم	You have made no choice, so your clients get every currency.
`offered_count`	`integer`	نعم	—
`total_count`	`integer`	نعم	—
`default_currency`	`string`	نعم	What a client is quoted in before they choose. Empty means the platform answer — their own inference, then USD.
`sell_in_currency`	`string`	نعم	What you are priced and settled in, resolved — never empty, and never disclosed to your clients.
`switcher`	`boolean`	نعم	Whether the currency control renders in your clients' panel at all. `false` quotes every client in `default_currency`.

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 422 · 429

PATCH /v1/reseller/currencies