reseller
PATCH /v1/reseller/currencies
Choose the currencies, the default, and what you sell in.
Autenticazione
Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione reseller.manage; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.
L'ID della tua organizzazione va qui
Questo endpoint accetta org_id come parametro di query. Omettilo e la chiamata coprirà l'intero sottoalbero del tuo tenant; invialo per limitare la chiamata a una singola organizzazione.
L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X PATCH https://api.zinndigital.com/v1/reseller/currencies \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
`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`.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
org_id (query) | Uuid | No | 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… |
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
currencies | string[] | No | Replaces the list your clients may be quoted in. An empty array returns you to offering every currency we can charge. |
default_currency | string | No | Empty returns to the platform answer. Must be one you offer. |
sell_in_currency | string | No | Empty returns to the platform base currency. Deliberately not required to be one of `currencies`. |
switcher | boolean | No | Whether the currency control renders in your clients' panel. |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
currencies | ResellerCurrency[] | Sì | — |
offers_all | boolean | Sì | You have made no choice, so your clients get every currency. |
offered_count | integer | Sì | — |
total_count | integer | Sì | — |
default_currency | string | Sì | What a client is quoted in before they choose. Empty means the platform answer — their own inference, then USD. |
sell_in_currency | string | Sì | What **you** are priced and settled in, resolved — never empty, and never disclosed to your clients. |
switcher | boolean | Sì | Whether the currency control renders in your clients' panel at all. `false` quotes every client in `default_currency`. |
Errori che questo endpoint può restituire
401 · 403 · 404 · 422 · 429