reseller
POST /v1/reseller/client-wallets/top-ups/{topUpId}/refunds
Send a deposit back to the card it came from.
Authentication
Send an API key as a bearer token. The key must carry the reseller.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
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 '{ }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
⛔ **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`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
topUpId (path) | Uuid | Yes | — |
org_id (query) | Uuid | No | 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… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
amount_minor | integer | No | Omit to refund everything still refundable on the deposit. |
reason | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
quoted_minor | integer | No | What the customer asked to add, and what the screen promised them. |
settled_minor | integer | null | No | What actually arrived. **`null` = not known yet**, never zero. |
fee_minor | integer | null | No | 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 | No | What went into the balance — `settled_minor - fee_minor`. |
shortfall_minor | integer | null | No | `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> | No | — |
is_auto | boolean | No | Whether a standing instruction created this, rather than a person. |
action_url | string | No | 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 | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
amount_minor | integer | Yes | — |
currency | string | Yes | — |
status | string<pending, requires_action, captured, failed> | Yes | ⛔ 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 | Yes | — |
refundable_minor | integer | Yes | What is left to send back to the card. Zero unless it captured. |
gateway | string | No | 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 | No | The gateway's refusal, in words the customer can act on. |
created_at | string | Yes | — |
captured_at | string | null | No | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429