reseller
GET /v1/wallet
Your credit balance with your provider.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění billing.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/wallet \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
currency (query) | string | Ne | 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 | Ne | 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… |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
org_id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | Ano | — |
balance_minor | integer | Ano | What you are owed — the float your provider is holding for you. |
spendable_minor | integer | Ano | 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 | Ne | The provider whose float this is. |
entries | ClientWalletEntry[] | Ano | — |
other_floats | ClientOtherFloat[] | Ano | 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> | Ne | ⭐ 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[] | Ne | 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… |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 422 · 429