reseller

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

Send a deposit back to the card it came from.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão reseller.manage; uma chave sem ela é recusada com 403, e não 404.

Onde vai o ID da sua organização

Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

⛔ **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`.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`topUpId (path)`	`Uuid`	Sim	—
`org_id (query)`	`Uuid`	Não	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…

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`amount_minor`	`integer`	Não	Omit to refund everything still refundable on the deposit.
`reason`	`string`	Não	—

Resposta

Nome	Tipo	Obrigatório	O que é
`quoted_minor`	`integer`	Não	What the customer asked to add, and what the screen promised them.
`settled_minor`	`integer \| null`	Não	What actually arrived. `null` = not known yet, never zero.
`fee_minor`	`integer \| null`	Não	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`	Não	What went into the balance — `settled_minor - fee_minor`.
`shortfall_minor`	`integer \| null`	Não	`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>`	Não	—
`is_auto`	`boolean`	Não	Whether a standing instruction created this, rather than a person.
`action_url`	`string`	Não	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`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`amount_minor`	`integer`	Sim	—
`currency`	`string`	Sim	—
`status`	`string<pending, requires_action, captured, failed>`	Sim	⛔ 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`	Sim	—
`refundable_minor`	`integer`	Sim	What is left to send back to the card. Zero unless it captured.
`gateway`	`string`	Não	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`	Não	The gateway's refusal, in words the customer can act on.
`created_at`	`string`	Sim	—
`captured_at`	`string \| null`	Não	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429