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

PATCH /v1/reseller/currencies