reseller
POST /v1/reseller/client-wallets/top-ups/{topUpId}/refunds
Send a deposit back to the card it came from.
Ìfàṣẹ́pọ̀
Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda reseller.manage; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.
Ibùdó àmì ìdánimọ̀ ilé-iṣẹ́ rẹ sí
Oju-iwọle yii nlo org_id gẹgẹbi ayẹwo ibeere. Fi silẹ ni ita yoo si bo igi iyalo rẹ lapapọ; ranṣẹ si lati dín ibeere naa kù si ajọ kan.
Id àjọ rẹ wa lórí ojú-ìwákòòkò àwọn bọ́tìnnì API nínú daṣibọọdú rẹ, lẹ́gbẹ̀ẹ́ bọ́tìnnì náà gan-an. Ó jẹ́ ìd kan náà nínú gbogbo ìpè tí o bá ṣe.
Gbiyanju rẹ
Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.
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 '{ }'Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API
Àwọn kúlẹ̀kúlẹ̀
⛔ 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.
Àwọn ìpìlẹ̀
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
topUpId (path) | Uuid | Bẹẹni | — |
org_id (query) | Uuid | Bẹẹkọ | 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… |
Akoonu ibeere naa
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
amount_minor | integer | Bẹẹkọ | Omit to refund everything still refundable on the deposit. |
reason | string | Bẹẹkọ | — |
Idahun
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
quoted_minor | integer | Bẹẹkọ | What the customer asked to add, and what the screen promised them. |
settled_minor | integer | null | Bẹẹkọ | What actually arrived. null = not known yet, never zero. |
fee_minor | integer | null | Bẹẹkọ | 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 | Bẹẹkọ | What went into the balance — settled_minor - fee_minor. |
shortfall_minor | integer | null | Bẹẹkọ | 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> | Bẹẹkọ | — |
is_auto | boolean | Bẹẹkọ | Whether a standing instruction created this, rather than a person. |
action_url | string | Bẹẹkọ | 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 | Bẹẹni | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
amount_minor | integer | Bẹẹni | — |
currency | string | Bẹẹni | — |
status | string<pending, requires_action, captured, failed> | Bẹẹni | ⛔ 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 | Bẹẹni | — |
refundable_minor | integer | Bẹẹni | What is left to send back to the card. Zero unless it captured. |
gateway | string | Bẹẹkọ | The provider's driver — stripe, paypal, nowpayments. ⛔ Never a credential and never a merchant-account reference: which account your provider banks with is their commercial… |
error | string | Bẹẹkọ | The gateway's refusal, in words the customer can act on. |
created_at | string | Bẹẹni | — |
captured_at | string | null | Bẹẹkọ | — |
Awọn aṣiṣe ti ibudo ipari yii le da pada
401 · 403 · 404 · 422 · 429