Reembolsar un pedido
API operation: Open the endpoint in Scalar
Usa POST /orders/{order_id}/refund para reembolsar el pago de un pedido. La operación pública actual es Order.refund.
Los reembolsos pueden enviarse a cash_wallet o a source; el enrutamiento de la fuente puede devolver fondos a una wallet o a una pasarela de pago compatible. Con version=v2, se requiere un administrador o el administrador del negocio propietario. Los valores admitidos de mode son total, amount e items; transfer_to acepta cash_wallet, credit_point_wallet o source.
Las comprobaciones de acceso varían entre los flujos heredado y v2; no supongas que cualquier usuario autenticado puede emitir reembolsos. Los reembolsos requieren eventos de pago, saldo reembolsable y un cliente. La solicitud y los errores pueden variar según la fuente de pago y la versión.
Referencia de OpenAPI
Operación: POST /orders/{order_id}/refund
Parámetros de ruta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
order_id | integer | Sí | — |
Parámetros de encabezado
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
User-Agent | string | No | — |
X-Forwarded-For | string | No | — |
X-Internal-Product-X | string | No | — |
Campos del cuerpo de la solicitud
| Nombre | Tipo | Obligatorio |
|---|---|---|
amount | number | Sí |
description | string | No |
items | any | No |
mode | string | No |
order_payment_event_id | integer | No |
transfer_to | string | Sí |
version | string | No |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta exitosa. El contenido de result varía según la operación y se devuelve como JSON. |
| 400 | Respuesta de error (error=true). Los errores de validación y de negocio comparten este código. |
| 401 | Envelope de error: sesión ausente, inválida, o nivel de usuario fuera de los permitidos. Respuesta de error para el código declarado por la operación. Consulta result para ver los detalles disponibles. Envelope de error: el proyecto no existe o no tiene una suscripción activa. |
| 404 | Respuesta vacía: la versión de API solicitada no está admitida. |
| 429 | Envelope de error: se excedió un límite de consumo del proyecto (o el sujeto está baneado). Lleva Retry-After y X-RateLimit-Limit/Remaining/Reset/Scope/Key. |
| 500 | Respuesta de error: falló la búsqueda o inicialización del proyecto. |
| 503 | Envelope de error: la aplicación está temporalmente en mantenimiento. Envelope de error: el proyecto está temporalmente en mantenimiento, o los límites de consumo no se pudieron evaluar y el límite aplicable está configurado con on_error = closed (cabecera Retry-After: 1). |