reseller
PATCH /v1/reseller/currencies
Choose the currencies, the default, and what you sell in.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso reseller.manage; una clave que no lo tenga se rechazará con un código 403, no 404.
Donde va el ID de tu organización
Este endpoint acepta org_id como parámetro de consulta. Omítelo y la llamada abarcará todo tu subárbol de inquilinos; envíalo para acotar la llamada a una sola organización.
El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X PATCH https://api.zinndigital.com/v1/reseller/currencies \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
`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`.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
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… |
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
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. |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
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`. |
Errores que este endpoint puede devolver
401 · 403 · 404 · 422 · 429