Saltar al contenido principal
Migo Docs

Partners

API RESTRINGIDA

Requiere autorización de partner / operador. Consulta CMS → Inicio.

Un Partner es un tenant de Migo — típicamente un banco, fintech o empresa que opera un programa de tarjetas.

Listar partners​

curl "https://api.ali.app/cms/rest/app/partners?page=1&limit=50&searchText=&sortBy=createdAt&sortOrder=desc" \
  -H "Authorization: Bearer <token>" \
  -H "x-user-token: Bearer <cms-user-token>"

Devuelve solo los partners a los que está asignado el usuario CMS autenticado.

Respuesta (data es un arreglo plano):

{
  "success": true,
  "message": "All partners registered found successfully",
  "data": [
    {
      "id": "partner-id-123",
      "name": "Banco Nacional",
      "merchant": "partner-merchant"
    }
  ]
}

Obtener un partner​

curl https://api.ali.app/cms/rest/app/partners/{partnerId} \
  -H "Authorization: Bearer <token>" \
  -H "x-user-token: Bearer <cms-user-token>"

El detalle del partner devuelve únicamente el branding:

{
  "success": true,
  "message": "Partner partner-id found successfully",
  "data": {
    "backgroundColor": "#FFFFFF",
    "imageUrl": "https://example.com/logo.png"
  }
}

Asignar un usuario CMS a un partner​

La asignación de partner se realiza al momento de crear el usuario (el arreglo partners de POST /app/partners/users) o posteriormente mediante PATCH /app/partners/users/{cmsUserId} con addPartners / removePartners. No existe un endpoint POST /app/partners/{partnerId}/users.

curl -X PATCH "https://api.ali.app/cms/rest/app/partners/users/{cmsUserId}" \
  -H "Authorization: Bearer <token>" \
  -H "x-user-token: Bearer <cms-user-token>" \
  -H "Content-Type: application/json" \
  -d '{ "addPartners": ["partner-123"], "removePartners": [] }'

Consulta Usuarios CMS → Crear un usuario CMS para el flujo al momento de la creación.

Listar usuarios CMS de un partner​

curl "https://api.ali.app/cms/rest/app/partners/{partnerId}/users" \
  -H "Authorization: Bearer <token>" \
  -H "x-user-token: Bearer <cms-user-token>"

Usuario individual en un partner​

curl "https://api.ali.app/cms/rest/app/partners/{partnerId}/users/{cmsUserId}" \
  -H "Authorization: Bearer <token>" \
  -H "x-user-token: Bearer <cms-user-token>"

Actualizar el estado de un usuario en un partner​

Un campo otp requerido debe acompañar el cambio de estado. Los valores de estado permitidos son active, blocked, inactive.

curl -X PATCH "https://api.ali.app/cms/rest/app/partners/{partnerId}/users/{cmsUserId}/status" \
  -H "Authorization: Bearer <token>" \
  -H "x-user-token: Bearer <cms-user-token>" \
  -H "Content-Type: application/json" \
  -d '{ "status": "blocked", "otp": "123456" }'

Actualización masiva del estado de usuarios CMS​

Actualiza el estado de varios usuarios CMS a la vez. El estado es un parámetro de ruta (active, blocked o inactive); el cuerpo transporta la lista de IDs numéricos de usuario y un otp requerido.

curl -X PATCH "https://api.ali.app/cms/rest/app/partners/{partnerId}/users/status/{status}" \
  -H "Authorization: Bearer <token>" \
  -H "x-user-token: Bearer <cms-user-token>" \
  -H "Content-Type: application/json" \
  -d '{ "users": [1, 2, 3], "otp": "123456" }'

Relacionado​