Saltar al contenido principal

Reordenar Sesiones en Paradas

Descripción

Define el orden de visualización de los solicitudes de pago activas (derivados de sesiones session_id) dentro de una o varias Paradas (stop_id) en una sola llamada.

Características:

  • No agrega ni quita sesiones; solo cambia el orden
  • Idempotente mediante Idempotency-Key (TTL: 24 horas)
  • Control de concurrencia opcional mediante order_version (recomendado)
  • Rate limit: 100 requests/minuto por comercio

Modos de operación:

  • append (default): reordena las sesiones listadas arriba y cualquier activa no listada queda al final manteniendo su orden relativo actual
  • strict: la lista debe representar exactamente el conjunto de activos; si falta alguna activa o sobra alguna no activa, se devuelve error por ítem

Notas importantes:

  • Separación de responsabilidades: usa reorder solo para ordenar. Para agregar/quitar/sustituir, utiliza el batch de operar solicitudes de pago
  • Idempotencia siempre: envía Idempotency-Key; misma clave + mismo payload ⇒ misma respuesta
  • Máximo 100 items por batch

Endpoint

PATCH 

/api/v1/ext/payment-stops/payment-sessions/reorder

Autenticación Requerida

Bearer / Token: BearerAuth

Requiere el uso de el token obtenido en /auth/login

Esquema: bearer (JWT)

Request

Ejemplos de Body (JSON)

Reordenamiento con modos mixtos

{
"continue_on_error": true,
"items": [
{
"stop_id": "stp_111",
"session_ids": [
"sess_B",
"sess_A",
"sess_C"
],
"mode": "append"
},
{
"stop_id": "stp_222",
"session_ids": [
"sess_X",
"sess_Y"
],
"mode": "strict"
}
]
}

Responses

Reordenamiento procesado exitosamente - todas las operaciones completadas