reseller
POST /v1/reseller/client-wallets/top-ups/{topUpId}/refunds
Send a deposit back to the card it came from.
Uthibitishaji
Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya reseller.manage; ufunguo usio nayo unakataliwa kwa 403, si 404.
Mahali ambapo kitambulisho cha shirika lako huwekwa
Kigezo hiki kinachukua org_id kama kigezo cha utafutaji. Iache wazi na simu itashughulikia tawi lako lote la wapangaji; itume ili kupunguza simu iwe ya shirika moja tu.
Kitambulisho cha shirika lako kipo kwenye skrini ya funguo za API katika dashibodi yako, kando ya ufunguo wenyewe. Ni kitambulisho kile kile katika kila ombi unalofanya.
Jaribu
Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.
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 '{ }'Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API
Maelezo
⛔ **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`.
Vigezo
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
topUpId (path) | Uuid | Ndiyo | — |
org_id (query) | Uuid | Hapana | 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… |
Mwili wa ombi
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
amount_minor | integer | Hapana | Omit to refund everything still refundable on the deposit. |
reason | string | Hapana | — |
Majibu
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
quoted_minor | integer | Hapana | What the customer asked to add, and what the screen promised them. |
settled_minor | integer | null | Hapana | What actually arrived. **`null` = not known yet**, never zero. |
fee_minor | integer | null | Hapana | 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 | Hapana | What went into the balance — `settled_minor - fee_minor`. |
shortfall_minor | integer | null | Hapana | `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> | Hapana | — |
is_auto | boolean | Hapana | Whether a standing instruction created this, rather than a person. |
action_url | string | Hapana | 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 | Ndiyo | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
amount_minor | integer | Ndiyo | — |
currency | string | Ndiyo | — |
status | string<pending, requires_action, captured, failed> | Ndiyo | ⛔ 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 | Ndiyo | — |
refundable_minor | integer | Ndiyo | What is left to send back to the card. Zero unless it captured. |
gateway | string | Hapana | 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 | Hapana | The gateway's refusal, in words the customer can act on. |
created_at | string | Ndiyo | — |
captured_at | string | null | Hapana | — |
Hitilafu ambazo mwisho huu unaweza kurudisha
401 · 403 · 404 · 422 · 429