Saltar al contenido principal
POST
/
api
/
v4
/
integrations
/
sales
/
aggregator
/
orders
/
{order_uid}
/
refund
{
  "reason": "Duplicate charge",
  "vendor_uid": "vendor-uid-abc"
}
{
  "data": {
    "uid": "550e8400-e29b-41d4-a716-446655440000",
    "order_code": "ORD-2026-001234",
    "account_uid": "acc-uid-12345",
    "vendor_uid": "vendor-uid-abc",
    "store_uid": "store-uid-xyz",
    "status": "CANCELED",
    "payment_status": "REFUNDED",
    "order_lines": [],
    "totals": [],
    "payment_methods": [],
    "metadata": {},
    "created_at": "2026-03-30T12:00:00.000Z",
    "updated_at": "2026-03-30T12:05:00.000Z",
    "deleted_at": null
  },
  "status": 200,
  "method": "POST",
  "pathname": "/api/v4/integrations/sales/aggregator/orders/550e8400-e29b-41d4-a716-446655440000/refund",
  "duration": 120,
  "traceId": "abc123",
  "isArray": false
}
Cancela una orden creada previamente con Inyectar orden. Fire busca la orden por account y order_uid, actualiza la orden a CANCELED y devuelve la orden actualizada dentro del sobre estándar de la API. Si el procesador de pago guardado soporta reembolsos (por ejemplo, Deuna), Fire intenta el reembolso y deja payment_status en REFUNDED cuando es exitoso. Para otros procesadores, Fire cancela el estado de pago y deja payment_status en CANCELED.
Authorization
string
requerido
Token Bearer obtenido desde POST /login. Formato: Bearer <accessToken>.
x-api-key
string
requerido
Tu API key de Fire.
x-client-channel
string
requerido
Debe ser integration. Identifica la petición como proveniente de una integración externa.
account
string
requerido
Identificador de la cuenta usado para encontrar la orden.
Content-Type
string
predeterminado:"application/json"
Usa application/json para el cuerpo de la petición.
order_uid
string
requerido
UID de la orden que se va a cancelar.
reason
string
requerido
Motivo de la cancelación o solicitud de reembolso.
payment_method_uid
string
Opcional. UID del método de pago usado para resolver credenciales de reembolso cuando necesitas apuntar a un método específico.
vendor_uid
string
requerido
UID del vendor usado para resolver credenciales de pago.
email
string
Email del cliente enviado al procesador de pago cuando aplica.
customer_uid
string
UID del cliente registrado. Si está presente, Fire trata el payload de reembolso como autenticado.
anonymous_customer_uid
string
UID del cliente anónimo. Se usa como identificador de usuario de pago cuando no existe customer_uid.
store_uid
string
UID de la tienda usado para resolver credenciales de pago específicas de la tienda.
media
string
Medio de venta usado para resolver credenciales. Valores soportados: APP, WEB.
{
  "reason": "Duplicate charge",
  "vendor_uid": "vendor-uid-abc"
}
data
object
Orden actualizada. Los precios en order_lines, totals y payment_methods se devuelven como montos externos sin escalar.
status
number
Código HTTP dentro del sobre de la API.
traceId
string
Identificador de traza para soporte y diagnóstico.
{
  "data": {
    "uid": "550e8400-e29b-41d4-a716-446655440000",
    "order_code": "ORD-2026-001234",
    "account_uid": "acc-uid-12345",
    "vendor_uid": "vendor-uid-abc",
    "store_uid": "store-uid-xyz",
    "status": "CANCELED",
    "payment_status": "REFUNDED",
    "order_lines": [],
    "totals": [],
    "payment_methods": [],
    "metadata": {},
    "created_at": "2026-03-30T12:00:00.000Z",
    "updated_at": "2026-03-30T12:05:00.000Z",
    "deleted_at": null
  },
  "status": 200,
  "method": "POST",
  "pathname": "/api/v4/integrations/sales/aggregator/orders/550e8400-e29b-41d4-a716-446655440000/refund",
  "duration": 120,
  "traceId": "abc123",
  "isArray": false
}

Reglas de procesamiento

  • Cuando se envía, payment_method_uid ayuda a resolver credenciales, pero Fire evalúa los métodos de pago guardados en la orden.
  • Para reembolsos con Deuna, la orden debe incluir metadata.order_token; si no existe, Fire devuelve 400.
  • Después de guardar la orden actualizada, Fire devuelve precios transformados para consumo externo.
  • Fire notifica la cancelación downstream después de guardar la orden.