reseller

PATCH /v1/reseller/currencies

Choose the currencies, the default, and what you sell in.

Alle reseller Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung reseller.manage verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X PATCH https://api.zinndigital.com/v1/reseller/currencies \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

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`.

Parameter

NameTypErforderlichWas es ist
org_id (query)UuidNeinWhich 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…

Anfragekörper

NameTypErforderlichWas es ist
currenciesstring[]NeinReplaces the list your clients may be quoted in. An empty array returns you to offering every currency we can charge.
default_currencystringNeinEmpty returns to the platform answer. Must be one you offer.
sell_in_currencystringNeinEmpty returns to the platform base currency. Deliberately not required to be one of `currencies`.
switcherbooleanNeinWhether the currency control renders in your clients' panel.

Antwort

NameTypErforderlichWas es ist
currenciesResellerCurrency[]Ja
offers_allbooleanJaYou have made no choice, so your clients get every currency.
offered_countintegerJa
total_countintegerJa
default_currencystringJaWhat a client is quoted in before they choose. Empty means the platform answer — their own inference, then USD.
sell_in_currencystringJaWhat **you** are priced and settled in, resolved — never empty, and never disclosed to your clients.
switcherbooleanJaWhether the currency control renders in your clients' panel at all. `false` quotes every client in `default_currency`.

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 422 · 429