reseller
PATCH /v1/reseller/currencies
Choose the currencies, the default, and what you sell in.
認証
ベアラー トークンとして API キーを送信します。キーには reseller.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PATCH https://api.zinndigital.com/v1/reseller/currencies \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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