Reembolsos
Reembolsos de pedidos: primero el cálculo, después el reembolso de ítems y envío; el dinero vuelve por los medios de pago, la mercadería vuelve al stock.
Reembolsos
Objetos
Refund
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
order_idintegerobligatorioID del pedido.
pos_shift_idinteger o nullobligatorioID del turno de caja (/v1/pos-shifts) que hizo la devolución; null — no se devolvió en una caja.
kindstringobligatorioreturn — devolución de mercadería; adjustment — corrección del importe sin mercadería; overpayment — devolución de un pago de más; tip — devolución de una propina.
- Valores:
returnadjustmentoverpaymenttip
statusstringobligatoriopending — espera al proveedor o un pago manual; completed — realizado; failed — fallido; reversed — revertido después de realizarse.
- Valores:
pendingcompletedfailedreversed
app_idinteger o nullobligatorioLa aplicación que hizo el reembolso (/v1/orders/{order}/refunds o la cancelación de un pedido), su id de /v1/me; null en un reembolso de la caja, el personal, el cliente o un proceso automático.
confirmablebooleanobligatorioEl reembolso espera la confirmación de que el dinero se devolvió fuera del sistema (POST /v1/refunds/{refund}/confirm).
currencystringobligatorioMoneda de los importes, código ISO 4217: la moneda de la tienda.
amountintegerobligatorioImporte del reembolso: ítems y envío.
shipping_amountintegerobligatorioParte de amount que reembolsa el envío.
tax_linesarray de object o nullobligatorioImpuesto de lo devuelto según la clasificación de los productos: la composición de la nota de crédito de la devolución, con los ítems devueltos salvo tarjetas de regalo y el envío; en una devolución de un importe sin ítems, la parte gravable por la clase impositiva predeterminada de la tienda. null cuando la tienda no tiene clases impositivas o no se devolvió nada gravable (una tarjeta de regalo).
Campos · 6
regimestringobligatorioQué impuesto: vat — impuesto al valor agregado (IVA); income — ganancias; turnover — Ingresos Brutos; municipal — tasas municipales; internal — impuestos internos; social — seguridad social; other — otro. El impuesto de una venta es vat: la clase impositiva del producto clasifica el IVA.
- Valores:
vatincometurnovermunicipalinternalsocialother
kindstringobligatoriotaxed — a la alícuota; exempt — exento por ley; untaxed — no gravado. Las líneas exempt y untaxed tienen rate_bps 0 y amount 0: el importe está en base.
- Valores:
taxedexemptuntaxed
rate_bpsintegerobligatorioAlícuota en puntos básicos: 2100 es 21 %.
baseintegerobligatorioBase imponible, sin el impuesto. Los precios incluyen impuestos: base + amount es lo que pagó el cliente por esta parte.
amountintegerobligatorioImporte del impuesto. El impuesto de una venta se calcula por alícuota para todo el pedido, la base redondeada a la unidad más cercana y el impuesto como resto; los ítems y el envío reciben partes de él, así sus líneas suman la línea del pedido.
jurisdictionstring o nullobligatorioProvincia o municipio para los impuestos que lo requieren (turnover, municipal); si no, null.
exchanged_to_order_idinteger o nullobligatorioEl pedido entregado a cambio (un cambio); null en un reembolso común.
itemsarray de objectobligatorioÍtems devueltos.
Campos · 4
order_item_idintegerobligatorioID del ítem del pedido (items en /v1/orders).
quantitystringobligatorioCantidad como cadena decimal en unit: unidades, o la medida completa de un ítem por peso o volumen.
unitstring o nullobligatorioUnidad de quantity: pcs, g o ml; null si la variante ya no conoce la unidad de su medida.
- Valores:
pcsgmlnull
amountintegerobligatorioImporte reembolsado por el ítem.
transactionsarray de objectobligatorioA dónde fue el dinero: movimientos por los pagos del pedido.
Campos · 7
idintegerobligatorioID del movimiento.
payment_idinteger o nullobligatorioPago del pedido por el que vuelve el dinero; null si no hay tal pago, como en un reembolso al saldo.
methodstringobligatorioMedio de pago del movimiento, los mismos valores que method de un pago.
- Valores:
cashmercadopagocryptobybittrc20balancemodopaywaymercadopago_qrmercadopago_pointmercadopago_transfergift_cardsubscriptiondepositexternalmanualoffseton_accountexchange_creditbonpuntoservice_package
targetstringobligatorioA dónde va el dinero: card — de vuelta a la tarjeta por el proveedor; cash — en efectivo; balance — al saldo del cliente; gift_card — a una tarjeta de regalo; account — a cuenta de la deuda del cliente; manual — devuelto a mano fuera del sistema; exchange — al pedido de un cambio; subscription — a una suscripción; deposit — a un depósito.
- Valores:
cardcashbalancegift_cardaccountmanualexchangesubscriptiondepositservice_package
amountintegerobligatorioImporte del movimiento.
statusstringobligatoriopending, completed, failed o reversed, como status del reembolso.
- Valores:
pendingcompletedfailedreversed
provider_refund_idstring o nullobligatorioID del reembolso en el proveedor de pagos, para conciliar con su resumen; null si no hay proveedor.
created_atstring (date-time)obligatorioCuándo se creó el registro.
updated_atstring (date-time)obligatorioCuándo cambió el registro por última vez.
RefundCalculation
order_idintegerobligatorioID del pedido.
currencystringobligatorioMoneda de los importes, código ISO 4217: la moneda de la tienda.
amountintegerobligatorioImporte que se reembolsará por los ítems y el envío elegidos.
shipping_amountintegerobligatorioParte de amount que reembolsa el envío.
itemsarray de objectobligatorioÍtems que se devolverán.
Campos · 4
order_item_idintegerobligatorioID del ítem del pedido (items en /v1/orders).
quantitystringobligatorioCantidad como cadena decimal en unit: unidades, o la medida completa de un ítem por peso o volumen.
unitstring o nullobligatorioUnidad de quantity: pcs, g o ml; null si la variante ya no conoce la unidad de su medida.
- Valores:
pcsgmlnull
amountintegerobligatorioImporte reembolsado por el ítem.
transactionsarray de objectobligatorioA dónde irá el dinero: partes por los pagos del pedido, tal como las hará el reembolso.
Campos · 4
payment_idinteger o nullobligatorioPago del pedido por el que vuelve el dinero; null si no hay tal pago, como en un reembolso al saldo.
methodstring o nullobligatorioMedio de pago de la parte; null en una parte sin pago.
- Valores:
cashmercadopagocryptobybittrc20balancemodopaywaymercadopago_qrmercadopago_pointmercadopago_transfergift_cardsubscriptiondepositexternalmanualoffseton_accountexchange_creditbonpuntoservice_packagenull
targetstringobligatorioA dónde va el dinero: card — de vuelta a la tarjeta por el proveedor; cash — en efectivo; balance — al saldo del cliente; gift_card — a una tarjeta de regalo; account — a cuenta de la deuda del cliente; manual — devuelto a mano fuera del sistema; exchange — al pedido de un cambio; subscription — a una suscripción; deposit — a un depósito.
- Valores:
cardcashbalancegift_cardaccountmanualexchangesubscriptiondepositservice_package
amountintegerobligatorioImporte del movimiento.
balance_availablebooleanobligatorioLa parte de un medio irreversible (transferencia, cripto, medio manual) puede ir al saldo del cliente: irreversible_to: balance en el reembolso. Hay tal parte en el cálculo, el cliente tiene cuenta y la tienda trabaja con saldos.
refundableobjectobligatorioLo que todavía se puede reembolsar del pedido: ítems con cantidad pendiente y el resto del envío. Un reembolso revertido no lo consume.
Campos · 2
itemsarray de objectobligatorioÍtems con cantidad pendiente de reembolso.
Campos · 3
order_item_idintegerobligatorioID del ítem del pedido (items en /v1/orders).
quantitystringobligatorioCantidad que todavía se puede devolver, como cadena decimal en unit.
unitstring o nullobligatorioUnidad de quantity: pcs, g o ml; null si la variante ya no conoce la unidad de su medida.
- Valores:
pcsgmlnull
shipping_amountintegerobligatorioEnvío que todavía se puede reembolsar.
Endpoints
Listar las devoluciones de pedidos cambiadas desde un momento dado: ítems y movimientos por pago
get/refunds
Scope: refunds:read
Parámetros
Query
limitintegerTamaño de página: hasta 250 registros; 50 por defecto.
- Mínimo:
- 1
- Máximo:
- 250
cursorstringCursor opaco: next_cursor de la página anterior, o sync_cursor de la última página guardado por la sincronización anterior. El listado va en orden de confirmación, así que el cursor de sincronización devuelve luego solo lo que cambió después de él.
- Largo máximo:
- 4096
updated_sincestring (date-time)Solo los registros cambiados después de este momento, ISO 8601 con zona horaria. Un filtro de la primera sincronización; después se sigue con el cursor.
- Patrón:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
include_deletedbooleantrue — devolver también los registros eliminados: los archivados con deleted_at y los borrados de la base como marcas de eliminación {id, deleted_at} en la continuación por el cursor de sincronización. Activalo para sincronizar.
order_idintegerSolo los registros de este pedido.
- Mínimo:
- 1
pos_shift_idintegerSolo los registros que recibió este turno de caja.
- Mínimo:
- 1
Respuestas
200Éxito
application/json
Registros de la página.
deletedarray de objectobligatorioRegistros borrados de la base desde el cursor, como marcas de eliminación: solo con include_deleted=true en la continuación por el cursor de sincronización.
Campos · 2
idintegerobligatorioID del registro borrado.
deleted_atstring (date-time)obligatorioCuándo se borró el registro.
next_cursorstring o nullobligatorioCursor de la página siguiente; null en la última.
has_morebooleanobligatoriotrue si hay una página siguiente.
sync_cursorstring o nullobligatorioEn la última página — el cursor desde el que continuar más tarde: con él llega solo lo que cambió después de esta página. null en las demás.
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
410El cursor de sincronización supera el plazo de conservación de eliminaciones o se emitió antes de restaurar la base de datos
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl "https://api.saleya.app/v1/refunds" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"order_id": 0,
"pos_shift_id": 0,
"kind": "return",
"status": "pending",
"app_id": 0,
"confirmable": true,
"currency": "string",
"amount": 0,
"shipping_amount": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"exchanged_to_order_id": 0,
"items": [
{
"order_item_id": 0,
"quantity": "string",
"unit": "pcs",
"amount": 0
}
],
"transactions": [
{
"id": 0,
"payment_id": 0,
"method": "cash",
"target": "card",
"amount": 0,
"status": "pending",
"provider_refund_id": "string"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
],
"deleted": [
{
"id": 0,
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"next_cursor": "string",
"has_more": true,
"sync_cursor": "string"
}Obtener una devolución de un pedido
get/refunds/{refund}
Scope: refunds:read
Parámetros
Ruta
refundintegerobligatorioID del reembolso.
Respuestas
200Éxito
application/json
Devuelve Refund
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl "https://api.saleya.app/v1/refunds/{refund}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"order_id": 0,
"pos_shift_id": 0,
"kind": "return",
"status": "pending",
"app_id": 0,
"confirmable": true,
"currency": "string",
"amount": 0,
"shipping_amount": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"exchanged_to_order_id": 0,
"items": [
{
"order_item_id": 0,
"quantity": "string",
"unit": "pcs",
"amount": 0
}
],
"transactions": [
{
"id": 0,
"payment_id": 0,
"method": "cash",
"target": "card",
"amount": 0,
"status": "pending",
"provider_refund_id": "string"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Calcular la devolución de un pedido y lo que queda por devolver, sin escribir nada
post/orders/{order}/refunds/calculate
Scope: refunds:write
Parámetros
Ruta
orderintegerobligatorioID del pedido.
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
Cuerpo de la solicitud application/json
itemsarray de objectobligatorioÍtems devueltos.
- Máximo de elementos:
- 200
- Sin repetidos
Campos · 2
order_item_idintegerobligatorioID del ítem del pedido (items en /v1/orders).
- Mínimo:
- 1
quantitystringobligatorioCantidad como cadena decimal en unit: unidades, o la medida completa de un ítem por peso o volumen.
- Largo máximo:
- 32
shipping_amountintegerParte de amount que reembolsa el envío.
- Mínimo:
- 0
- Máximo:
- 100000000000000
irreversible_tostringA dónde va la parte de un medio irreversible (transferencia, cripto, medio manual): manual — la tienda la devuelve a mano y la confirma (POST /v1/refunds/{refund}/confirm); balance — al saldo del cliente (balance_available del cálculo).
- Valores:
manualbalance
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
application/json
Devuelve RefundCalculation
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
refund_refusedEl pedido no se puede devolver - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X POST "https://api.saleya.app/v1/orders/{order}/refunds/calculate" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"items": [
{
"order_item_id": 1,
"quantity": "string"
}
],
"shipping_amount": 0,
"irreversible_to": "manual"
}{
"order_id": 0,
"currency": "string",
"amount": 0,
"shipping_amount": 0,
"items": [
{
"order_item_id": 0,
"quantity": "string",
"unit": "pcs",
"amount": 0
}
],
"transactions": [
{
"payment_id": 0,
"method": "cash",
"target": "card",
"amount": 0
}
],
"balance_available": true,
"refundable": {
"items": [
{
"order_item_id": 0,
"quantity": "string",
"unit": "pcs"
}
],
"shipping_amount": 0
}
}Devolver ítems y envío de un pedido: el dinero vuelve por los medios de pago, la mercadería al stock
post/orders/{order}/refunds
Scope: refunds:write
Parámetros
Ruta
orderintegerobligatorioID del pedido.
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
Cuerpo de la solicitud application/json
itemsarray de objectobligatorioÍtems devueltos.
- Máximo de elementos:
- 200
- Sin repetidos
Campos · 2
order_item_idintegerobligatorioID del ítem del pedido (items en /v1/orders).
- Mínimo:
- 1
quantitystringobligatorioCantidad como cadena decimal en unit: unidades, o la medida completa de un ítem por peso o volumen.
- Largo máximo:
- 32
shipping_amountintegerParte de amount que reembolsa el envío.
- Mínimo:
- 0
- Máximo:
- 100000000000000
irreversible_tostringA dónde va la parte de un medio irreversible (transferencia, cripto, medio manual): manual — la tienda la devuelve a mano y la confirma (POST /v1/refunds/{refund}/confirm); balance — al saldo del cliente (balance_available del cálculo).
- Valores:
manualbalance
expected_amountintegerobligatorioEl importe del cálculo (/v1/orders/{order}/refunds/calculate) que confirmás. Un descuento prorrateado, reembolsos anteriores o un cambio del pedido lo modifican después de leerlo; un reembolso por otro importe no se realiza.
- Mínimo:
- 0
- Máximo:
- 100000000000000
Respuestas
201Creado
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
application/json
Devuelve Refund
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
refund_refusedEl pedido no se puede devolver - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X POST "https://api.saleya.app/v1/orders/{order}/refunds" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"items": [
{
"order_item_id": 1,
"quantity": "string"
}
],
"shipping_amount": 0,
"irreversible_to": "manual",
"expected_amount": 0
}{
"id": 0,
"order_id": 0,
"pos_shift_id": 0,
"kind": "return",
"status": "pending",
"app_id": 0,
"confirmable": true,
"currency": "string",
"amount": 0,
"shipping_amount": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"exchanged_to_order_id": 0,
"items": [
{
"order_item_id": 0,
"quantity": "string",
"unit": "pcs",
"amount": 0
}
],
"transactions": [
{
"id": 0,
"payment_id": 0,
"method": "cash",
"target": "card",
"amount": 0,
"status": "pending",
"provider_refund_id": "string"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Confirmar que el dinero de la devolución se reintegró fuera del sistema
post/refunds/{refund}/confirm
Scope: refunds:write
Parámetros
Ruta
refundintegerobligatorioID del reembolso.
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
application/json
Devuelve Refund
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
refund_not_confirmableLa devolución no espera confirmar un reintegro - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X POST "https://api.saleya.app/v1/refunds/{refund}/confirm" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"order_id": 0,
"pos_shift_id": 0,
"kind": "return",
"status": "pending",
"app_id": 0,
"confirmable": true,
"currency": "string",
"amount": 0,
"shipping_amount": 0,
"tax_lines": [
{
"regime": "vat",
"kind": "taxed",
"rate_bps": 0,
"base": 0,
"amount": 0,
"jurisdiction": "string"
}
],
"exchanged_to_order_id": 0,
"items": [
{
"order_item_id": 0,
"quantity": "string",
"unit": "pcs",
"amount": 0
}
],
"transactions": [
{
"id": 0,
"payment_id": 0,
"method": "cash",
"target": "card",
"amount": 0,
"status": "pending",
"provider_refund_id": "string"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}