reseller
POST /v1/reseller/client-wallets/top-ups/{topUpId}/refunds
Send a deposit back to the card it came from.
Autentificare
Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea reseller.manage; o cheie care nu o are va fi respinsă cu 403, nu 404.
Unde merge ID-ul organizației tale
Acest punct final acceptă org_id ca parametru de interogare. Omiteți-l și apelul va acoperi întregul subarbore al chiriașului dvs.; trimiteți-l pentru a restrânge apelul la o singură organizație.
ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X POST https://api.zinndigital.com/v1/reseller/client-wallets/top-ups/{topUpId}/refunds \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
⛔ **Back the way it came.** There is deliberately no "refund to wallet" option: a top-up already *is* wallet credit, so crediting it again would be a no-op wearing the name of a remedy, and wallet credit is an opt-in under consumer law rather than something silence can agree to. The balance is debited first and the gateway refund taken second; if the client has already spent the deposit the refund is refused with 422, and if the gateway declines it the balance is put back. Requires `reseller.manage`.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
topUpId (path) | Uuid | Da | — |
org_id (query) | Uuid | Nu | 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… |
Corp cerere
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
amount_minor | integer | Nu | Omit to refund everything still refundable on the deposit. |
reason | string | Nu | — |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
quoted_minor | integer | Nu | What the customer asked to add, and what the screen promised them. |
settled_minor | integer | null | Nu | What actually arrived. **`null` = not known yet**, never zero. |
fee_minor | integer | null | Nu | 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 | Nu | What went into the balance — `settled_minor - fee_minor`. |
shortfall_minor | integer | null | Nu | `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> | Nu | — |
is_auto | boolean | Nu | Whether a standing instruction created this, rather than a person. |
action_url | string | Nu | 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 | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
amount_minor | integer | Da | — |
currency | string | Da | — |
status | string<pending, requires_action, captured, failed> | Da | ⛔ 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 | Da | — |
refundable_minor | integer | Da | What is left to send back to the card. Zero unless it captured. |
gateway | string | Nu | 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 | Nu | The gateway's refusal, in words the customer can act on. |
created_at | string | Da | — |
captured_at | string | null | Nu | — |
Erori pe care le poate returna acest punct final
401 · 403 · 404 · 422 · 429