reseller
PATCH /v1/reseller/currencies
Choose the currencies, the default, and what you sell in.
Автентифікація
Надішліть ключ API як маркер носія (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 у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі 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