reseller
POST /v1/reseller/client-wallets/{walletId}/adjustments
Correct a client's balance.
認証
ベアラー トークンとして API キーを送信します。キーには reseller.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/reseller/client-wallets/{walletId}/adjustments \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "amount_minor": <integer>, "reason": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Signed — positive credits, negative takes back. ⛔ A negative adjustment that would put the client below zero is refused with 422 naming what is available: you may correct your own mistake, you may not push a customer into debt. `reason` is required and the client sees it on their statement. A wallet belonging to another reseller answers 404, never 403, so this is not an existence oracle. Requires `reseller.manage`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
walletId (path) | Uuid | はい | — |
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… |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
amount_minor | integer | はい | Signed minor units. ⛔ Cannot take the client below zero. |
reason | string | はい | Required, and the client sees it on their statement. An unexplained movement of somebody else's money is the first thing an audit asks about. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | はい | — |
balance_minor | integer | はい | What you are **owed** — the float your provider is holding for you. |
spendable_minor | integer | はい | What you can **spend today**. Lower than `balance_minor` when your provider's reseller programme is suspended: the deposit is still yours, but nobody is delivering service again… |
reseller_org_id | Uuid | null | いいえ | The provider whose float this is. |
entries | ClientWalletEntry[] | はい | — |
other_floats | ClientOtherFloat[] | はい | Balances a **previous** provider still holds for you. ⛔ Normally empty. A client who changed provider is still owed what the old one took; omitting it would make that money disa… |
provider | string<reseller, zinn> | いいえ | ⭐ **Who is holding this money.** One screen serves both, because *"credit you hold with your provider"* is one question whose answer depends on the customer, not on the feature.… |
purses | WalletPurse[] | いいえ | The owner's *"one ledger, named purses"* — a balance may be restricted to a kind of spending. ⛔ Empty for a reseller float, which has no purses. A purse whose authoritative stor… |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429