commerce
POST /v1/refund-requests/{refundRequestId}/approve
Approve a pending refund request (staff).
Autenticación
Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X POST https://api.zinndigital.com/v1/refund-requests/{refundRequestId}/approve \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
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.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
refundRequestId (path) | Uuid | Sí | The refund request's id. |
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
note | string | No | — |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | Uuid | Sí | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Sí | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
order_id | Uuid | Sí | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | RefundRequestStatus | Sí | A refund request's lifecycle state (docs/05 §4.13). |
policy_class | RefundPolicyClass | Sí | How the refund policy classified a request (captured at request time). |
amount | MoneyAmount | Sí | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
to_wallet | boolean | Sí | 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 | Sí | — |
decided_by | string | Sí | — |
decision_note | string | Sí | — |
decided_at | object | Sí | — |
refund_reference | string | Sí | Set once the refund has been issued (its idempotency key). |
created_at | string | Sí | — |
updated_at | string | Sí | — |
Errores que este endpoint puede devolver
401 · 403 · 404 · 409 · 422 · 429