Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation billing.payment.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/wallet/top-ups \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "amount_minor": <integer>, "currency": <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
Charged on **your provider's own** payment account when you are a reseller's client, and on Zinn®'s when you buy directly. The credit is written when the payment **captures**: a crypto invoice awaiting confirmation (`pending`) or a card awaiting 3-D Secure (`requires_action`) returns 201 with that status and **no** balance change, because the money has not arrived. 422 when your provider has not finished connecting a payment account — the charge is refused rather than settled somewhere else. ⚖️ **Credit bought from Zinn® is never refundable, including on account closure, and never expires** (owner ruling 2026-08-22). Call `GET /v1/wallet/top-ups/estimate` first and show the customer what they will actually receive — on a crypto rail that can be less than the amount quoted, because we credit what settles rather than what was asked for. Requires `billing.payment.manage`.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
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 | Minor units. The ceiling is a fat-finger guard, not a business rule — your provider's own gateway applies the real limits. |
currency | string | Oui | — |
idempotency_key | string | Non | Your own replay key. Optional; when absent the server mints one, so a double-submit is at worst a second deliberate-looking top-up rather than a silent double charge. |
gateway | string | Non | Which rail to take the money on — `stripe`, `paypal` or `nowpayments`. ⛔ Only meaningful when you buy directly from Zinn®: a reseller's client is always charged on their provide… |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
quoted_minor | integer | Non | What the customer asked to add, and what the screen promised them. |
settled_minor | integer | null | Non | What actually arrived. **`null` = not known yet**, never zero. |
fee_minor | integer | null | Non | What the provider kept out of the settlement. **`null` = not known**, never zero — recording an unknown as `0` would credit the customer the shortfall. |
credited_minor | integer | Non | What went into the balance — `settled_minor - fee_minor`. |
shortfall_minor | integer | null | Non | `quoted_minor - credited_minor`. `null` until the top-up settles. Derived rather than stored: it is a difference between two recorded facts, and a stored copy is a second source… |
purpose | string<general, ai> | Non | — |
is_auto | boolean | Non | Whether a standing instruction created this, rather than a person. |
action_url | string | Non | Where the customer must go to finish paying — a crypto pay-link or an SCA challenge. Losing it strands a pending top-up with no way to complete it. |
id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
amount_minor | integer | Oui | — |
currency | string | Oui | — |
status | string<pending, requires_action, captured, failed> | Oui | ⛔ Credit is written on `captured` only. `pending` (a crypto invoice confirming) and `requires_action` (3-D Secure) both mean the money has not arrived yet. |
refunded_minor | integer | Oui | — |
refundable_minor | integer | Oui | What is left to send back to the card. Zero unless it captured. |
gateway | string | Non | The provider's driver — `stripe`, `paypal`, `nowpayments`. ⛔ Never a credential and never a merchant-account reference: which account your provider banks with is their commercia… |
error | string | Non | The gateway's refusal, in words the customer can act on. |
created_at | string | Oui | — |
captured_at | string | null | Non | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429