reseller
POST /v1/reseller/client-wallets/top-ups/{topUpId}/refunds
Send a deposit back to the card it came from.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie reseller.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Miejsce na identyfikator organizacji
Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
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 '{ }'Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
⛔ 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.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
topUpId (path) | Uuid | Tak | — |
org_id (query) | Uuid | Nie | 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… |
Treść żądania
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
amount_minor | integer | Nie | Omit to refund everything still refundable on the deposit. |
reason | string | Nie | — |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
quoted_minor | integer | Nie | What the customer asked to add, and what the screen promised them. |
settled_minor | integer | null | Nie | What actually arrived. null = not known yet, never zero. |
fee_minor | integer | null | Nie | 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 | Nie | What went into the balance — settled_minor - fee_minor. |
shortfall_minor | integer | null | Nie | 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> | Nie | — |
is_auto | boolean | Nie | Whether a standing instruction created this, rather than a person. |
action_url | string | Nie | 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 | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
amount_minor | integer | Tak | — |
currency | string | Tak | — |
status | string<pending, requires_action, captured, failed> | Tak | ⛔ 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 | Tak | — |
refundable_minor | integer | Tak | What is left to send back to the card. Zero unless it captured. |
gateway | string | Nie | 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 | Nie | The gateway's refusal, in words the customer can act on. |
created_at | string | Tak | — |
captured_at | string | null | Nie | — |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 422 · 429