commerce
POST /v1/orders/{orderId}/refund-request
Request a refund for an order.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso billing.payment.manage; una clave que no lo tenga se rechazará con un código 403, no 404.
Donde va el ID de tu organización
Este endpoint toma org_id como un campo en el cuerpo JSON.
El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.
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/orders/{orderId}/refund-request \
-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
Opens a refund request per the policy: within the 30-day money-back window the refund is issued immediately (status `auto_approved`); otherwise a pro-rata request is recorded `pending` for staff approval (docs/05 §4.13). The amount and approval path come from the server, never the client. Requires `billing.payment.manage`.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
orderId (path) | Uuid | Sí | The order's id. |
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
org_id | Uuid | No | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
reason | string | No | — |
to_wallet | boolean | No | Where the refund goes. Omit it and the money is returned to the original payment method — the money-back guarantee is money back, and store credit is an opt-in the customer has… |
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