reseller

POST `/v1/reseller/client-wallets/top-ups/{topUpId}/refunds`

Send a deposit back to the card it came from.

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu reseller.manage; ključ bez nje se odbija s kodom 403, a ne 404.

Gdje dolazi ID vaše organizacije

Ova krajnja točka uzima org_id kao parametar upita. Izostavite ga i poziv obuhvaćett cijelo stablo vašeg najma; pošaljite ga kako biste suzili poziv na jednu organizaciju.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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 '{  }'

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

⛔ 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

Naziv	Vrsta	Obavezno	Što je to
`topUpId (path)`	`Uuid`	Da	—
`org_id (query)`	`Uuid`	Ne	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…

Tijelo zahtjeva

Naziv	Vrsta	Obavezno	Što je to
`amount_minor`	`integer`	Ne	Omit to refund everything still refundable on the deposit.
`reason`	`string`	Ne	—

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`quoted_minor`	`integer`	Ne	What the customer asked to add, and what the screen promised them.
`settled_minor`	`integer \| null`	Ne	What actually arrived. `null` = not known yet, never zero.
`fee_minor`	`integer \| null`	Ne	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`	Ne	What went into the balance — `settled_minor - fee_minor`.
`shortfall_minor`	`integer \| null`	Ne	`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>`	Ne	—
`is_auto`	`boolean`	Ne	Whether a standing instruction created this, rather than a person.
`action_url`	`string`	Ne	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`	Ne	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`	Ne	The gateway's refusal, in words the customer can act on.
`created_at`	`string`	Da	—
`captured_at`	`string \| null`	Ne	—

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422 · 429