reseller
POST /v1/reseller/client-wallets/{walletId}/adjustments
Correct a client's balance.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation reseller.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Où insérer l'ID de votre organisation
Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
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> }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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`.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
walletId (path) | Uuid | Oui | — |
org_id (query) | Uuid | Non | 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… |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
amount_minor | integer | Oui | Signed minor units. ⛔ Cannot take the client below zero. |
reason | string | Oui | 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. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
org_id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | Oui | — |
balance_minor | integer | Oui | What you are **owed** — the float your provider is holding for you. |
spendable_minor | integer | Oui | 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 | Non | The provider whose float this is. |
entries | ClientWalletEntry[] | Oui | — |
other_floats | ClientOtherFloat[] | Oui | 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> | Non | ⭐ **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[] | Non | 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… |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429