reseller
PATCH /v1/reseller/currencies
Choose the currencies, the default, and what you sell in.
Authentication
Send an API key as a bearer token. The key must carry the reseller.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X PATCH https://api.zinndigital.com/v1/reseller/currencies \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
`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`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
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… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
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. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
currencies | ResellerCurrency[] | Yes | — |
offers_all | boolean | Yes | You have made no choice, so your clients get every currency. |
offered_count | integer | Yes | — |
total_count | integer | Yes | — |
default_currency | string | Yes | What a client is quoted in before they choose. Empty means the platform answer — their own inference, then USD. |
sell_in_currency | string | Yes | What **you** are priced and settled in, resolved — never empty, and never disclosed to your clients. |
switcher | boolean | Yes | Whether the currency control renders in your clients' panel at all. `false` quotes every client in `default_currency`. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429