reseller

GET /v1/wallet

Your credit balance with your provider.

ټول reseller پای ټکي

ټول د پراختیا کونکي اسناد

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د billing.view اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

چیرته چې ستاسو د سازمان آی ډي ځي

دا پای ټکی د پوښتنې پیرامیتر په توګه org_id اخلي. دا پریږدئ او زنګ ستاسو د استوګنې ټولې څانګې پوښي؛ د یوې سازمان لپاره د زنګ محدودولو لپاره یې واستوئ.

ستاسو د سازمان آی ډي ستاسو په ډشبورډ کې د API کېلي پر سکرین، خپله د کېلي څنګ ته شتون لري. دا په هره هغه غوښتنه کې چې تاسو یې کوئ، ورته آی ډي وي.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

curl -X GET https://api.zinndigital.com/v1/wallet \
  -H "Authorization: Bearer zdk_live_…"

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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_idUuidهوUUIDv7 identifier — sortable by creation time (docs/02 §8).
currencystringهو
balance_minorintegerهوWhat you are owed — the float your provider is holding for you.
spendable_minorintegerهو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_idUuid | nullنهThe provider whose float this is.
entriesClientWalletEntry[]هو
other_floatsClientOtherFloat[]هو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…
providerstring<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.…
pursesWalletPurse[]نه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