認証
ベアラー トークンとして API キーを送信します。キーには billing.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/wallet \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The float your provider holds for you, and your statement of account. ⛔ This is your provider's money, not Zinn®'s: a top-up settles into their payment account and the balance is a debt they owe you. Two balances are returned and they can differ — balance_minor is what you are owed, spendable_minor is what you can spend today. They come apart when your provider's reseller programme is suspended: the deposit is still yours, but nothing is being delivered against it. ⭐ Answers for both providers. If your account is not managed by a reseller, this returns the credit you hold with Zinn® instead, and provider says which — a reseller float can be sent back to the card it came from, Zinn® credit never can. This used to be a 404, which the dashboard rendered as "This account does not use credit"; that was true only because there was no way to buy any. Requires billing.view.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
currency (query) | string | いいえ | ISO-4217 code. A wallet is per-currency — a EUR float does not pay a USD invoice — so an unknown code is a 422 rather than a silent fallback. |
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… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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 against… |
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… |
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 store… |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429