commerce

POST `/v1/refund-requests/{refundRequestId}/approve`

Approve a pending refund request (staff).

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

curl -X POST https://api.zinndigital.com/v1/refund-requests/{refundRequestId}/approve \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

Approves a pending (pro-rata / goodwill) refund request and issues the refund. Staff-only — requires the `billing.refund` permission held by a staff role, not by any customer role.

Parametry

Název	Typ	Požadováno	Co to je
`refundRequestId (path)`	`Uuid`	Ano	The refund request's id.

Tělo požadavku

Název	Typ	Požadováno	Co to je
`note`	`string`	Ne	—

Odpověď

Název	Typ	Požadováno	Co to je
`id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`order_id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`status`	`RefundRequestStatus`	Ano	A refund request's lifecycle state (docs/05 §4.13).
`policy_class`	`RefundPolicyClass`	Ano	How the refund policy classified a request (captured at request time).
`amount`	`MoneyAmount`	Ano	A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
`to_wallet`	`boolean`	Ano	Refund destination, frozen at request time — `false` (the default) reverses the original payment, `true` credits the account wallet. Any part of the order that was settled from…
`reason`	`string`	Ano	—
`decided_by`	`string`	Ano	—
`decision_note`	`string`	Ano	—
`decided_at`	`object`	Ano	—
`refund_reference`	`string`	Ano	Set once the refund has been issued (its idempotency key).
`created_at`	`string`	Ano	—
`updated_at`	`string`	Ano	—

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 409 · 422 · 429

POST /v1/refund-requests/{refundRequestId}/approve