API de Leasyfan

v2.0.0

La API de Leasyfan te permite integrar el programa de fidelidad digital con tus propios sistemas: punto de venta, ecommerce, CRM o cualquier herramienta interna. Con ella puedes crear clientes y tarjetas, acumular sellos, puntos y visitas, canjear recompensas, enviar notificaciones y administrar automatizaciones.

URL Base

https://api.leasyfan.com

Formato

Todas las peticiones y respuestas usan application/json con codificación UTF-8.

Versión

Todos los endpoints están bajo el prefijo /api/v2.

Autenticación

Todas las peticiones deben incluir tu clave de API en el header X-API-Key. Puedes generar y consultar tu clave desde tu panel de Leasyfan, en la sección de Configuración. Mantén tu clave en secreto: cualquier persona con acceso a ella puede operar sobre tus datos.

Ejemplo con curl

curl -X GET "https://api.leasyfan.com/api/v2/cards" \
  -H "X-API-Key: TU_CLAVE_DE_API" \
  -H "Content-Type: application/json"

Paginación

Los endpoints que devuelven listas aceptan los parámetros de consulta page (número de página, inicia en 1) y itemsPerPage (elementos por página). La respuesta incluye un objeto meta con totalItems, itemsPerPage y currentPage para que puedas recorrer todos los resultados.

Formato de respuestas

Todas las respuestas comparten una misma envoltura: responseId (identificador único de la respuesta), createdAt (fecha y hora), code (código HTTP) y data (el recurso solicitado o el resultado de la acción). En las listas, data es un arreglo y se agrega el objeto meta de paginación.

Estructura general

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": { }
}

Tarjetas

Gestiona las tarjetas de fidelidad de tus clientes: crea, consulta, edita y elimina tarjetas, y ejecuta todas las acciones de acumulación y canje (sellos, puntos, visitas, recompensas, cupones y más). El parámetro id corresponde al número de serie de la tarjeta.

Tipos de tarjeta (notación)

Cada tipo de tarjeta tiene un ID numérico y un valor exacto en inglés dentro de la API. Los métodos de acumulación y canje aplican solo a ciertos tipos; en cada endpoint encontrarás la nota "Aplica a" con los tipos compatibles.

ID	Valor en la API	Tarjeta en Leasyfan
`0`	Stamp	Sellos
`1`	Cashback	Cashback
`2`	Multipass	Suscripción
`3`	Coupon	Cupón
`4`	Discount	Descuento
`5`	Gift	Tarjeta de Regalo
`6`	Membership	Membresía
`7`	Reward	Puntos

Agregar monto a la tarjeta

POST/api/v2/cards/{id}/add-transaction-amount

Aplica a: Tarjeta Cashback (ID 1).

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`amount`requerido	integer	> 0
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "amount": 0,
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Agregar punto a la tarjeta

POST/api/v2/cards/{id}/add-point

Aplica a: Tarjetas de Descuento, Cashback y Tarjeta de Regalo (IDs 4, 1, 5).

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`points`requerido	number (float)	> 0
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "points": 0,
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Agregar compra a la tarjeta

POST/api/v2/cards/{id}/add-purchase

Aplica a: Tarjeta de Sellos (ID 0) con mecánica de gasto y tarjeta de Puntos (ID 7) con mecánica de gasto.

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`amount`requerido	number (float)	> 0
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "amount": 0,
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Agregar recompensa a la tarjeta

POST/api/v2/cards/{id}/add-reward

Aplica a: Tarjeta de Sellos (ID 0).

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`rewards`requerido	integer	> 0
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "rewards": 0,
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Agregar puntaje a la tarjeta

POST/api/v2/cards/{id}/add-scores

Aplica a: Tarjetas de Puntos con mecánica de tipo Puntos y Suscripción (IDs 7, 2).

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`scores`requerido	integer	> 0
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "scores": 0,
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Agregar sello a la tarjeta

POST/api/v2/cards/{id}/add-stamp

Aplica a: Tarjeta de Sellos (ID 0).

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`stamps`requerido	integer	> 0
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "stamps": 0,
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Agregar visita a la tarjeta

POST/api/v2/cards/{id}/add-visit

Aplica a: Tarjeta de Suscripción (ID 2), Membresía sin límites (ID 6), Sellos (ID 0) con mecánica de visitas y Puntos (ID 7) con mecánica de visitas.

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`visits`requerido	integer	> 0
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "visits": 0,
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Canjear recompensa

POST/api/v2/cards/{id}/receive-reward

Aplica a: Tarjeta de Puntos (ID 7).

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`id`requeridonullable	integer	> 0
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "id": 0,
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Canjear cupón

POST/api/v2/cards/{id}/redeem-coupon

Aplica a: Tarjeta de Cupón (ID 3).

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Establecer fecha de vencimiento de la tarjeta

POST/api/v2/cards/{id}/set-expiration-date

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`expiresAt`nullable	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "expiresAt": "string"
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Establecer nivel y período de la tarjeta de membresía

POST/api/v2/cards/{id}/set-membership-tier

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`tierId`requeridonullable	integer
`period`requeridonullable	string	Valores: `day`, `week`, `month`, `year`

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "tierId": 0,
  "period": "day"
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Restar monto de la tarjeta

POST/api/v2/cards/{id}/subtract-transaction-amount

Aplica a: Tarjeta Cashback (ID 1).

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`amount`requerido	integer	> 0
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "amount": 0,
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Restar punto de la tarjeta

POST/api/v2/cards/{id}/subtract-point

Aplica a: Tarjetas de Descuento, Cashback y Tarjeta de Regalo (IDs 4, 1, 5).

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`points`requerido	number (float)	> 0
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "points": 0,
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Restar compra de la tarjeta

POST/api/v2/cards/{id}/subtract-purchase

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`amount`requerido	number (float)	> 0
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "amount": 0,
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Restar recompensa de la tarjeta

POST/api/v2/cards/{id}/subtract-reward

Aplica a: Tarjeta de Sellos (ID 0).

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`rewards`requerido	integer	> 0
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "rewards": 0,
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Restar puntaje de la tarjeta

POST/api/v2/cards/{id}/subtract-scores

Aplica a: Tarjetas de Puntos y Suscripción (IDs 7, 2).

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`scores`requerido	integer	> 0
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "scores": 0,
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Restar sello de la tarjeta

POST/api/v2/cards/{id}/subtract-stamp

Aplica a: Tarjeta de Sellos (ID 0).

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`stamps`requerido	integer	> 0
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "stamps": 0,
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Restar visita de la tarjeta

POST/api/v2/cards/{id}/subtract-visit

Aplica a: Tarjeta de Suscripción (ID 2) y Membresía con límites (ID 6).

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`visits`requerido	integer	> 0
`comment`nullable	string
`purchaseSum`nullable	number (float)

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "visits": 0,
  "comment": "string",
  "purchaseSum": 0
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Lista de tarjetas

GET/api/v2/cards

Descripción adicional

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`templateId`	query	integer	Filtrar por templateId Ejemplo: `123`
`customerId`	query	string (uuid)	Filtrar por customerId
`customerEmail`	query	string	Filtrar por email del cliente
`customerPhone`	query	string	Filtrar por teléfono del cliente
`page`	query	integer	Page number >= 1 · por defecto: `1`
`itemsPerPage`	query	integer	Items per page >= 1 · <= 1000 · por defecto: `30`

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`meta`	object
`totalItems`	integer
`itemsPerPage`	integer
`currentPage`	integer
`data`	array de object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "meta": {
    "totalItems": 250,
    "itemsPerPage": 30,
    "currentPage": 1
  },
  "data": [
    {
      "id": "string",
      "companyId": 0,
      "templateId": 0,
      "customerId": "string",
      "type": "string",
      "device": "string",
      "status": "string",
      "customFields": [
        {
          "id": 0,
          "name": "string",
          "type": "string",
          "order": 0,
          "value": "string",
          "required": true,
          "unique": true
        }
      ],
      "customer": {
        "id": "string",
        "phone": "string",
        "email": "string",
        "gender": 0,
        "dateOfBirth": "2026-01-15",
        "surname": "string",
        "firstName": "string",
        "externalUserId": "string",
        "createdAt": "2026-01-15T10:30:00Z",
        "updatedAt": "2026-01-15T10:30:00Z",
        "segments": [
          {
            "id": 0,
            "type": 0,
            "name": "string"
          }
        ]
      },
      "balance": {
        "currentNumberOfUses": 0,
        "numberStampsTotal": 0,
        "numberRewardsUnused": 0,
        "balance": 0,
        "discountPercentage": 0,
        "discountAmount": 0,
        "bonusBalance": 0,
        "stampsBeforeReward": 0
      },
      "customerSubscription": {
        "id": 0,
        "customerId": "string",
        "cardId": 0,
        "templateId": 0,
        "period": "string",
        "status": 0,
        "membershipTierId": 0,
        "providerId": 0,
        "externalId": "string",
        "balance": 0,
        "createdAt": 0,
        "updatedAt": 0,
        "expiredAt": 0
      },
      "membershipTier": {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "description": "string",
        "dailyParameters": {
          "price": 0,
          "limit": 0,
          "perFilialLimit": 0,
          "active": true,
          "recommended": true
        },
        "weeklyParameters": {
          "price": 0,
          "limit": 0,
          "perFilialLimit": 0,
          "active": true,
          "recommended": true
        },
        "monthlyParameters": {
          "price": 0,
          "limit": 0,
          "perFilialLimit": 0,
          "active": true,
          "recommended": true
        },
        "yearlyParameters": {
          "price": 0,
          "limit": 0,
          "perFilialLimit": 0,
          "active": true,
          "recommended": true
        },
        "benefits": [
          "string"
        ]
      },
      "availableRewardTiers": [
        {
          "id": 0,
          "templateId": 0,
          "name": "string",
          "type": 0,
          "threshold": 0,
          "value": 0,
          "valueLimit": 0,
          "periodValueLimit": 0,
          "usageLimit": 0,
          "limitPeriod": 0,
          "calendarPeriod": true,
          "imageUrl": "string"
        }
      ],
      "installLink": "string",
      "shareLink": "string",
      "qrLink": "string",
      "directInstallLink": {
        "universal": "string",
        "apple": "string",
        "google": "string",
        "pwa": "string"
      },
      "couponRedeemed": true,
      "utmSource": "string",
      "acquisitionParams": [],
      "firstVisitDiscount": "string",
      "countVisits": 0,
      "totalRewardsRedeemed": 0,
      "totalRewardsEarned": 0,
      "totalStampsEarnedByReferral": 0,
      "totalPointsEarnedByReferral": 0,
      "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
      "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
      "lastStampEarnedAt": "2026-01-15T10:30:00Z",
      "expiresAt": "2026-01-15T10:30:00Z",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z"
    }
  ]
}

Crear tarjeta para un cliente

POST/api/v2/cards

Requiere el header X-API-Key con tu clave de API.

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`templateId`requerido	integer	> 0
`customerId`requerido	string
`customFields`	array de object
`id`	integer
`value`	string

Respuestas

›201Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "templateId": 0,
  "customerId": "string",
  "customFields": [
    {
      "id": 0,
      "value": "string"
    }
  ]
}

Ejemplo de respuesta · 201

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 201,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Obtener tarjeta

GET/api/v2/cards/{id}

Obtiene la información de la tarjeta por su id (número de serie)

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Eliminar tarjeta

DELETE/api/v2/cards/{id}

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`	string

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string"
  }
}

Editar tarjeta

PATCH/api/v2/cards/{id}

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`customFields`	array de object
`id`	integer
`value`	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`type`requerido	string
`device`nullable	string
`status`nullable	string
`customFields`nullable	array de object
`id`nullable	integer
`name`nullable	string
`type`nullable	string
`order`nullable	integer
`value`nullable	string
`required`requerido	boolean
`unique`requerido	boolean
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`balance`requerido	object
`currentNumberOfUses`nullable	integer
`numberStampsTotal`nullable	integer
`numberRewardsUnused`nullable	integer
`balance`nullable	number (float)
`discountPercentage`nullable	number (float)
`discountAmount`nullable	integer
`bonusBalance`nullable	integer
`stampsBeforeReward`nullable	integer
`customerSubscription`nullable	object
`id`requerido	integer
`customerId`requerido	string
`cardId`requerido	integer
`templateId`requerido	integer
`period`requerido	string
`status`requerido	integer
`membershipTierId`nullable	integer
`providerId`nullable	integer
`externalId`nullable	string
`balance`nullable	integer
`createdAt`nullable	integer
`updatedAt`nullable	integer
`expiredAt`nullable	integer
`membershipTier`nullable	object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`description`nullable	string
`dailyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`weeklyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`monthlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`yearlyParameters`requerido	object
`price`requerido	number (float)
`limit`requerido	integer
`perFilialLimit`requerido	integer
`active`requerido	boolean
`recommended`requerido	boolean
`benefits`requerido	array de string
`availableRewardTiers`requerido	array de object
`id`requerido	integer
`templateId`requerido	integer
`name`nullable	string
`type`requerido	integer
`threshold`nullable	integer
`value`nullable	number (float)
`valueLimit`nullable	number (float)
`periodValueLimit`nullable	number (float)
`usageLimit`nullable	integer
`limitPeriod`requerido	integer
`calendarPeriod`requerido	boolean
`imageUrl`nullable	string
`installLink`requerido	string
`shareLink`requerido	string
`qrLink`requerido	string
`directInstallLink`requerido	object
`universal`requerido	string
`apple`requerido	string
`google`requerido	string
`pwa`requerido	string
`couponRedeemed`nullable	boolean
`utmSource`nullable	string
`acquisitionParams`nullable	array
`firstVisitDiscount`nullable	string
`countVisits`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsRedeemed`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalRewardsEarned`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalStampsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`totalPointsEarnedByReferral`nullable	integer	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardRedeemedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastRewardEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`lastStampEarnedAt`nullable	string (date-time)	Este campo siempre viene vacío cuando se solicita una lista de tarjetas.
`expiresAt`nullable	string (date-time)
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de petición

{
  "customFields": [
    {
      "id": 0,
      "value": "string"
    }
  ]
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "companyId": 0,
    "templateId": 0,
    "customerId": "string",
    "type": "string",
    "device": "string",
    "status": "string",
    "customFields": [
      {
        "id": 0,
        "name": "string",
        "type": "string",
        "order": 0,
        "value": "string",
        "required": true,
        "unique": true
      }
    ],
    "customer": {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    },
    "balance": {
      "currentNumberOfUses": 0,
      "numberStampsTotal": 0,
      "numberRewardsUnused": 0,
      "balance": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "bonusBalance": 0,
      "stampsBeforeReward": 0
    },
    "customerSubscription": {
      "id": 0,
      "customerId": "string",
      "cardId": 0,
      "templateId": 0,
      "period": "string",
      "status": 0,
      "membershipTierId": 0,
      "providerId": 0,
      "externalId": "string",
      "balance": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "expiredAt": 0
    },
    "membershipTier": {
      "id": 0,
      "templateId": 0,
      "name": "string",
      "description": "string",
      "dailyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "weeklyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "monthlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "yearlyParameters": {
        "price": 0,
        "limit": 0,
        "perFilialLimit": 0,
        "active": true,
        "recommended": true
      },
      "benefits": [
        "string"
      ]
    },
    "availableRewardTiers": [
      {
        "id": 0,
        "templateId": 0,
        "name": "string",
        "type": 0,
        "threshold": 0,
        "value": 0,
        "valueLimit": 0,
        "periodValueLimit": 0,
        "usageLimit": 0,
        "limitPeriod": 0,
        "calendarPeriod": true,
        "imageUrl": "string"
      }
    ],
    "installLink": "string",
    "shareLink": "string",
    "qrLink": "string",
    "directInstallLink": {
      "universal": "string",
      "apple": "string",
      "google": "string",
      "pwa": "string"
    },
    "couponRedeemed": true,
    "utmSource": "string",
    "acquisitionParams": [],
    "firstVisitDiscount": "string",
    "countVisits": 0,
    "totalRewardsRedeemed": 0,
    "totalRewardsEarned": 0,
    "totalStampsEarnedByReferral": 0,
    "totalPointsEarnedByReferral": 0,
    "lastRewardRedeemedAt": "2026-01-15T10:30:00Z",
    "lastRewardEarnedAt": "2026-01-15T10:30:00Z",
    "lastStampEarnedAt": "2026-01-15T10:30:00Z",
    "expiresAt": "2026-01-15T10:30:00Z",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
}

Canje de recompensas con costo (tarjetas de Sellos)

En el Scanner App, al canjear una recompensa puedes ingresar manualmente su costo. Ese monto se suma al LTV (valor de vida) del cliente.

Puedes lograr el mismo comportamiento a través de la API usando el método Restar recompensa de la tarjeta.

Campo	Descripción
`rewards`	Cantidad de recompensas a restar.
`comment`	Nota opcional para la transacción.
`purchaseSum`	Valor monetario de la recompensa canjeada (se incluye en el LTV).

Importante: la API no obtiene automáticamente el precio predefinido de la recompensa desde la configuración de la tarjeta. Debes indicar el valor manualmente en el campo purchaseSum.

Por el momento, solo la API de Leasyfan permite enviar el valor de la recompensa de esta manera. Las integraciones de terceros (Zapier, Pabbly y similares) no pueden obtener el costo de las recompensas directamente; solo transmiten los datos que tú configures.

Ejemplo

{
  "rewards": 1,
  "comment": "Recompensa canjeada",
  "purchaseSum": 10.5
}

Clientes

Administra la base de clientes de tu negocio: crea, consulta, edita y elimina clientes. Cada cliente puede tener una o más tarjetas asociadas.

Lista de clientes

GET/api/v2/customers

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`phone`	query	string	Filtrar por teléfono
`email`	query	string	Filtrar por email
`page`	query	integer	Page number >= 1 · por defecto: `1`
`itemsPerPage`	query	integer	Items per page >= 1 · <= 1000 · por defecto: `30`

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`meta`	object
`totalItems`	integer
`itemsPerPage`	integer
`currentPage`	integer
`data`	array de object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "meta": {
    "totalItems": 250,
    "itemsPerPage": 30,
    "currentPage": 1
  },
  "data": [
    {
      "id": "string",
      "phone": "string",
      "email": "string",
      "gender": 0,
      "dateOfBirth": "2026-01-15",
      "surname": "string",
      "firstName": "string",
      "externalUserId": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z",
      "segments": [
        {
          "id": 0,
          "type": 0,
          "name": "string"
        }
      ]
    }
  ]
}

Crear cliente

POST/api/v2/customers

Requiere el header X-API-Key con tu clave de API.

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`firstName`requerido	string
`surname`nullable	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer	Valores: `0`, `1`, `2`
`dateOfBirth`nullable	string
`externalUserId`nullable	string

Respuestas

›201Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string

Ejemplo de petición

{
  "firstName": "string",
  "surname": "string",
  "phone": "string",
  "email": "string",
  "gender": 0,
  "dateOfBirth": "string",
  "externalUserId": "string"
}

Ejemplo de respuesta · 201

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 201,
  "data": {
    "id": "string",
    "phone": "string",
    "email": "string",
    "gender": 0,
    "dateOfBirth": "2026-01-15",
    "surname": "string",
    "firstName": "string",
    "externalUserId": "string",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z",
    "segments": [
      {
        "id": 0,
        "type": 0,
        "name": "string"
      }
    ]
  }
}

Obtener cliente

GET/api/v2/customers/{id}

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "phone": "string",
    "email": "string",
    "gender": 0,
    "dateOfBirth": "2026-01-15",
    "surname": "string",
    "firstName": "string",
    "externalUserId": "string",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z",
    "segments": [
      {
        "id": 0,
        "type": 0,
        "name": "string"
      }
    ]
  }
}

Eliminar cliente

DELETE/api/v2/customers/{id}

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`	string

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string"
  }
}

Editar cliente

PATCH/api/v2/customers/{id}

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`id`requerido	string
`firstName`nullable	string
`surname`nullable	string
`email`nullable	string
`gender`nullable	integer	Valores: `0`, `1`, `2`
`dateOfBirth`nullable	string
`externalUserId`nullable	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string

Ejemplo de petición

{
  "id": "string",
  "firstName": "string",
  "surname": "string",
  "email": "string",
  "gender": 0,
  "dateOfBirth": "string",
  "externalUserId": "string"
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "phone": "string",
    "email": "string",
    "gender": 0,
    "dateOfBirth": "2026-01-15",
    "surname": "string",
    "firstName": "string",
    "externalUserId": "string",
    "createdAt": "2026-01-15T10:30:00Z",
    "updatedAt": "2026-01-15T10:30:00Z",
    "segments": [
      {
        "id": 0,
        "type": 0,
        "name": "string"
      }
    ]
  }
}

Ubicaciones

Gestiona las ubicaciones (sucursales o puntos de venta) de tu negocio. Las ubicaciones se usan, por ejemplo, para las notificaciones por geolocalización.

Lista de ubicaciones

GET/api/v2/locations

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`page`	query	integer	Page number >= 1 · por defecto: `1`
`itemsPerPage`	query	integer	Items per page >= 1 · <= 1000 · por defecto: `30`

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`meta`	object
`totalItems`	integer
`itemsPerPage`	integer
`currentPage`	integer
`data`	array de object

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "meta": {
    "totalItems": 250,
    "itemsPerPage": 30,
    "currentPage": 1
  },
  "data": [
    {}
  ]
}

Crear ubicación

POST/api/v2/locations

Requiere el header X-API-Key con tu clave de API.

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`name`requeridonullable	string	longitud mínima 3 · longitud máxima 255
`address`requeridonullable	string	longitud mínima 3 · longitud máxima 255
`message`requeridonullable	string	longitud mínima 3 · longitud máxima 255
`latitude`requeridonullable	string
`longitude`requeridonullable	string
`display`	boolean	por defecto: `true`
`templateIds`	array de integer	por defecto: `[]`

Respuestas

›201Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object

Ejemplo de petición

{
  "name": "string",
  "address": "string",
  "message": "string",
  "latitude": "string",
  "longitude": "string",
  "display": true,
  "templateIds": [
    0
  ]
}

Ejemplo de respuesta · 201

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 201,
  "data": {}
}

Obtener ubicación

GET/api/v2/locations/{id}

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {}
}

Eliminar ubicación

DELETE/api/v2/locations/{id}

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`	integer

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": 0
  }
}

Actualizar ubicación

PATCH/api/v2/locations/{id}

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`name`nullable	string	longitud mínima 3 · longitud máxima 255
`address`nullable	string	longitud mínima 3 · longitud máxima 255
`message`nullable	string	longitud mínima 3 · longitud máxima 255
`latitude`nullable	string
`longitude`nullable	string
`display`nullable	boolean
`templateIds`nullable	array de integer

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object

Ejemplo de petición

{
  "name": "string",
  "address": "string",
  "message": "string",
  "latitude": "string",
  "longitude": "string",
  "display": true,
  "templateIds": [
    0
  ]
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {}
}

Operaciones

Consulta el historial de operaciones registradas sobre las tarjetas: acumulaciones, canjes, visitas y demás transacciones.

Lista de operaciones

GET/api/v2/operations

Descripción adicional

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`templateId`	query	integer	Filtrar por templateId Ejemplo: `123`
`customerId`	query	string (uuid)	Filtrar por customerId
`cardId`	query	string	Filtrar por cardId Ejemplo: `"430556-818-972"`
`startDate`	query	string (date)	Start date (format Y-m-d) por defecto: `null`
`endDate`	query	string (date)	End date (format Y-m-d) por defecto: `null`
`page`	query	integer	Page number >= 1 · por defecto: `1`
`itemsPerPage`	query	integer	Items per page >= 1 · <= 1000 · por defecto: `30`

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`meta`	object
`totalItems`	integer
`itemsPerPage`	integer
`currentPage`	integer
`data`	array de object
`id`requerido	integer
`companyId`requerido	integer
`templateId`requerido	integer
`customerId`requerido	string
`customer`requerido	object
`id`requerido	string
`phone`nullable	string
`email`nullable	string
`gender`nullable	integer
`dateOfBirth`	string (date)
`surname`nullable	string
`firstName`nullable	string
`externalUserId`nullable	string
`createdAt`nullable	string (date-time)
`updatedAt`nullable	string (date-time)
`segments`requerido	array de object
`id`requerido	integer
`type`requerido	integer
`name`requerido	string
`cardId`requerido	string
`cardDevice`nullable	string
`eventId`requerido	integer
`eventName`requerido	string
`managerId`nullable	integer
`locationId`nullable	integer
`amount`requerido	number (float)
`purchaseSum`requerido	number (float)
`balance`requerido	integer
`source`requerido	string
`comment`nullable	string
`createdAt`requerido	string (date-time)
`updatedAt`nullable	string (date-time)

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "meta": {
    "totalItems": 250,
    "itemsPerPage": 30,
    "currentPage": 1
  },
  "data": [
    {
      "id": 0,
      "companyId": 0,
      "templateId": 0,
      "customerId": "string",
      "customer": {
        "id": "string",
        "phone": "string",
        "email": "string",
        "gender": 0,
        "dateOfBirth": "2026-01-15",
        "surname": "string",
        "firstName": "string",
        "externalUserId": "string",
        "createdAt": "2026-01-15T10:30:00Z",
        "updatedAt": "2026-01-15T10:30:00Z",
        "segments": [
          {
            "id": 0,
            "type": 0,
            "name": "string"
          }
        ]
      },
      "cardId": "string",
      "cardDevice": "string",
      "eventId": 0,
      "eventName": "string",
      "managerId": 0,
      "locationId": 0,
      "amount": 0,
      "purchaseSum": 0,
      "balance": 0,
      "source": "string",
      "comment": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-15T10:30:00Z"
    }
  ]
}

Promociones

Crea y administra promociones vinculadas a tus plantillas de tarjeta, con campos personalizados y notificaciones push programadas al inicio y al final de cada promoción.

Lista de promociones

GET/api/v2/promotions

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`templateId`	query	integer	Filtrar por ID de plantilla
`active`	query	boolean	Filtrar por estado activo
`page`	query	integer	Page number >= 1 · por defecto: `1`
`itemsPerPage`	query	integer	Items per page >= 1 · <= 1000 · por defecto: `30`

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`meta`	object
`totalItems`	integer
`itemsPerPage`	integer
`currentPage`	integer
`data`	array de object
`customFields`	array de object	Arreglo de objetos de campos personalizados: { name: string, value: string, type: string }. type es uno de: string, title, startDate, endDate, remainingUsages.
`name`	string
`value`	string
`type`	string
`templates`	array de integer	IDs de las plantillas a las que está vinculada la promoción.
`pushes`	object	Configuración de push programados. Objeto con claves opcionales "start" y "end". Cada una: { enabled: bool, plannedDate: string (ISO 8601), text: string }.
`start`	object
`enabled`	boolean
`plannedDate`	string
`text`	string
`end`	object
`enabled`	boolean
`plannedDate`	string
`text`	string
`id`requerido	integer
`name`requerido	string
`background`nullable	string
`description`nullable	string
`startDate`nullable	string
`endDate`nullable	string
`active`requerido	boolean
`maxUsages`nullable	integer
`maxGlobalRedemptions`requerido	integer
`currentGlobalRedemptions`requerido	integer
`currentRevenue`nullable	string
`createdAt`requerido	string
`updatedAt`nullable	string

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "meta": {
    "totalItems": 250,
    "itemsPerPage": 30,
    "currentPage": 1
  },
  "data": [
    {
      "customFields": [
        {
          "name": "string",
          "value": "string",
          "type": "string"
        }
      ],
      "templates": [],
      "pushes": {
        "start": {
          "enabled": true,
          "plannedDate": "string",
          "text": "string"
        },
        "end": {
          "enabled": true,
          "plannedDate": "string",
          "text": "string"
        }
      },
      "id": 0,
      "name": "string",
      "background": "string",
      "description": "string",
      "startDate": "string",
      "endDate": "string",
      "active": true,
      "maxUsages": 0,
      "maxGlobalRedemptions": 0,
      "currentGlobalRedemptions": 0,
      "currentRevenue": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

Crear promoción

POST/api/v2/promotions

Requiere el header X-API-Key con tu clave de API.

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`customFields`	array de object	Opcional. Hasta 3 campos personalizados que se muestran en la tarjeta de la promoción. Cada elemento: name (requerido), value (opcional), type (opcional, uno de: string, title, startDate, endDate, remainingUsages). máximo 3 elementos
`name`	string	Etiqueta del campo
`value`	string	Valor estático (para type string/title) o dejar vacío para los tipos de llenado automático (startDate, endDate, remainingUsages)
`type`	string	Uno de: string, title, startDate, endDate, remainingUsages Valores: `string`, `title`, `startDate`, `endDate`, `remainingUsages`
`templates`	array de integer	Opcional. Arreglo de IDs de plantillas existentes a las que se vinculará la promoción. Usa un arreglo vacío si no aplica.
`pushes`	object	Opcional. Programa notificaciones push al inicio y/o al final de la promoción. Objeto con claves opcionales "start" y "end"; cada una tiene enabled (bool), plannedDate (fecha y hora ISO 8601 en que se enviará) y text (mensaje de la notificación).
`start`	object	Push cuando inicia la promoción
`enabled`	boolean
`plannedDate`	string	Fecha y hora en formato ISO 8601
`text`	string	Texto del mensaje push
`end`	object	Push cuando termina la promoción
`enabled`	boolean
`plannedDate`	string
`text`	string
`name`requeridonullable	string
`description`nullable	string
`startDate`requeridonullable	string
`endDate`requeridonullable	string
`active`nullable	boolean
`maxUsages`nullable	integer	>= 0
`maxGlobalRedemptions`nullable	integer	>= 0
`backgroundImageBase64`requeridonullable	string

Respuestas

›201Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`customFields`	array de object	Arreglo de objetos de campos personalizados: { name: string, value: string, type: string }. type es uno de: string, title, startDate, endDate, remainingUsages.
`name`	string
`value`	string
`type`	string
`templates`	array de integer	IDs de las plantillas a las que está vinculada la promoción.
`pushes`	object	Configuración de push programados. Objeto con claves opcionales "start" y "end". Cada una: { enabled: bool, plannedDate: string (ISO 8601), text: string }.
`start`	object
`enabled`	boolean
`plannedDate`	string
`text`	string
`end`	object
`enabled`	boolean
`plannedDate`	string
`text`	string
`id`requerido	integer
`name`requerido	string
`background`nullable	string
`description`nullable	string
`startDate`nullable	string
`endDate`nullable	string
`active`requerido	boolean
`maxUsages`nullable	integer
`maxGlobalRedemptions`requerido	integer
`currentGlobalRedemptions`requerido	integer
`currentRevenue`nullable	string
`createdAt`requerido	string
`updatedAt`nullable	string

Ejemplo de petición

{
  "customFields": [
    {
      "name": "Valid until",
      "value": "",
      "type": "endDate"
    },
    {
      "name": "Uses left",
      "value": "",
      "type": "remainingUsages"
    }
  ],
  "templates": [],
  "pushes": {
    "start": {
      "enabled": true,
      "plannedDate": "2025-03-01T10:00:00+00:00",
      "text": "Your promotion has started!"
    },
    "end": {
      "enabled": true,
      "plannedDate": "2025-03-31T23:59:59+00:00",
      "text": "Last day of the promotion!"
    }
  },
  "name": "string",
  "description": "string",
  "startDate": "string",
  "endDate": "string",
  "active": true,
  "maxUsages": 0,
  "maxGlobalRedemptions": 0,
  "backgroundImageBase64": "string"
}

Ejemplo de respuesta · 201

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 201,
  "data": {
    "customFields": [
      {
        "name": "string",
        "value": "string",
        "type": "string"
      }
    ],
    "templates": [],
    "pushes": {
      "start": {
        "enabled": true,
        "plannedDate": "string",
        "text": "string"
      },
      "end": {
        "enabled": true,
        "plannedDate": "string",
        "text": "string"
      }
    },
    "id": 0,
    "name": "string",
    "background": "string",
    "description": "string",
    "startDate": "string",
    "endDate": "string",
    "active": true,
    "maxUsages": 0,
    "maxGlobalRedemptions": 0,
    "currentGlobalRedemptions": 0,
    "currentRevenue": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

Obtener promoción por ID

GET/api/v2/promotions/{id}

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`customFields`	array de object	Arreglo de objetos de campos personalizados: { name: string, value: string, type: string }. type es uno de: string, title, startDate, endDate, remainingUsages.
`name`	string
`value`	string
`type`	string
`templates`	array de integer	IDs de las plantillas a las que está vinculada la promoción.
`pushes`	object	Configuración de push programados. Objeto con claves opcionales "start" y "end". Cada una: { enabled: bool, plannedDate: string (ISO 8601), text: string }.
`start`	object
`enabled`	boolean
`plannedDate`	string
`text`	string
`end`	object
`enabled`	boolean
`plannedDate`	string
`text`	string
`id`requerido	integer
`name`requerido	string
`background`nullable	string
`description`nullable	string
`startDate`nullable	string
`endDate`nullable	string
`active`requerido	boolean
`maxUsages`nullable	integer
`maxGlobalRedemptions`requerido	integer
`currentGlobalRedemptions`requerido	integer
`currentRevenue`nullable	string
`createdAt`requerido	string
`updatedAt`nullable	string

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "customFields": [
      {
        "name": "string",
        "value": "string",
        "type": "string"
      }
    ],
    "templates": [],
    "pushes": {
      "start": {
        "enabled": true,
        "plannedDate": "string",
        "text": "string"
      },
      "end": {
        "enabled": true,
        "plannedDate": "string",
        "text": "string"
      }
    },
    "id": 0,
    "name": "string",
    "background": "string",
    "description": "string",
    "startDate": "string",
    "endDate": "string",
    "active": true,
    "maxUsages": 0,
    "maxGlobalRedemptions": 0,
    "currentGlobalRedemptions": 0,
    "currentRevenue": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

Eliminar promoción

DELETE/api/v2/promotions/{id}

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`	integer

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": 0
  }
}

Editar promoción (actualización parcial)

PATCH/api/v2/promotions/{id}

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Todos los campos son opcionales. Solo se actualizan los campos enviados.

Campo	Tipo	Descripción
`customFields`	array de object	Hasta 3 campos personalizados en la tarjeta de la promoción. Cada elemento: name (requerido), value (opcional), type (opcional). Type es uno de: string, title, startDate, endDate, remainingUsages. máximo 3 elementos
`name`	string
`value`	string
`type`	string	Valores: `string`, `title`, `startDate`, `endDate`, `remainingUsages`
`templates`	array de integer	Opcional. Arreglo de IDs de plantillas existentes a las que se vinculará la promoción. Usa un arreglo vacío si no aplica.
`pushes`	object	Notificaciones push al inicio o fin de la promoción. Claves opcionales: start, end. Cada una: enabled (bool), plannedDate (ISO 8601), text (mensaje).
`start`	object
`enabled`	boolean
`plannedDate`	string
`text`	string
`end`	object
`enabled`	boolean
`plannedDate`	string
`text`	string
`name`nullable	string
`description`nullable	string
`startDate`nullable	string
`endDate`nullable	string
`active`nullable	boolean
`maxUsages`nullable	integer	>= 0
`maxGlobalRedemptions`nullable	integer	>= 0
`backgroundImageBase64`nullable	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`customFields`	array de object	Arreglo de objetos de campos personalizados: { name: string, value: string, type: string }. type es uno de: string, title, startDate, endDate, remainingUsages.
`name`	string
`value`	string
`type`	string
`templates`	array de integer	IDs de las plantillas a las que está vinculada la promoción.
`pushes`	object	Configuración de push programados. Objeto con claves opcionales "start" y "end". Cada una: { enabled: bool, plannedDate: string (ISO 8601), text: string }.
`start`	object
`enabled`	boolean
`plannedDate`	string
`text`	string
`end`	object
`enabled`	boolean
`plannedDate`	string
`text`	string
`id`requerido	integer
`name`requerido	string
`background`nullable	string
`description`nullable	string
`startDate`nullable	string
`endDate`nullable	string
`active`requerido	boolean
`maxUsages`nullable	integer
`maxGlobalRedemptions`requerido	integer
`currentGlobalRedemptions`requerido	integer
`currentRevenue`nullable	string
`createdAt`requerido	string
`updatedAt`nullable	string

Ejemplo de petición

{
  "customFields": [
    {
      "name": "string",
      "value": "string",
      "type": "string"
    }
  ],
  "templates": [],
  "pushes": {
    "start": {
      "enabled": true,
      "plannedDate": "string",
      "text": "string"
    },
    "end": {
      "enabled": true,
      "plannedDate": "string",
      "text": "string"
    }
  },
  "name": "string",
  "description": "string",
  "startDate": "string",
  "endDate": "string",
  "active": true,
  "maxUsages": 0,
  "maxGlobalRedemptions": 0,
  "backgroundImageBase64": "string"
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "customFields": [
      {
        "name": "string",
        "value": "string",
        "type": "string"
      }
    ],
    "templates": [],
    "pushes": {
      "start": {
        "enabled": true,
        "plannedDate": "string",
        "text": "string"
      },
      "end": {
        "enabled": true,
        "plannedDate": "string",
        "text": "string"
      }
    },
    "id": 0,
    "name": "string",
    "background": "string",
    "description": "string",
    "startDate": "string",
    "endDate": "string",
    "active": true,
    "maxUsages": 0,
    "maxGlobalRedemptions": 0,
    "currentGlobalRedemptions": 0,
    "currentRevenue": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

Notificaciones Push

Envía mensajes push a las tarjetas instaladas de tus clientes y consulta el historial de envíos.

Lista de mensajes push

GET/api/v2/pushes

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`templateId`	query	integer	Filtrar por templateId Ejemplo: `123`
`cardId`	query	string	Filtrar por cardId Ejemplo: `"430556-818-972"`
`startDate`	query	string (date)	Start date (format Y-m-d) por defecto: `null`
`endDate`	query	string (date)	End date (format Y-m-d) por defecto: `null`
`page`	query	integer	Page number >= 1 · por defecto: `1`
`itemsPerPage`	query	integer	Items per page >= 1 · <= 1000 · por defecto: `30`

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`meta`	object
`totalItems`	integer
`itemsPerPage`	integer
`currentPage`	integer
`data`	array de object
`id`requerido	string
`templateId`requerido	integer
`cardId`nullable	string
`message`requerido	string
`status`requerido	string
`type`requerido	string
`sentAmount`requerido	integer
`deliveredAmount`requerido	integer
`createdAt`requerido	string (date-time)
`scheduledAt`requerido	string (date-time)

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "meta": {
    "totalItems": 250,
    "itemsPerPage": 30,
    "currentPage": 1
  },
  "data": [
    {
      "id": "string",
      "templateId": 0,
      "cardId": "string",
      "message": "string",
      "status": "string",
      "type": "string",
      "sentAmount": 0,
      "deliveredAmount": 0,
      "createdAt": "2026-01-15T10:30:00Z",
      "scheduledAt": "2026-01-15T10:30:00Z"
    }
  ]
}

Enviar push

POST/api/v2/pushes

Requiere el header X-API-Key con tu clave de API.

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`message`requerido	string	por defecto: `""`
`templateId`requerido	integer	> 0
`cardId`nullable	string
`scheduledAt`nullable	string (date-time)

Respuestas

›201Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`templateId`requerido	integer
`cardId`nullable	string
`message`requerido	string
`status`requerido	string
`type`requerido	string
`sentAmount`requerido	integer
`deliveredAmount`requerido	integer
`createdAt`requerido	string (date-time)
`scheduledAt`requerido	string (date-time)

Ejemplo de petición

{
  "message": "string",
  "templateId": 0,
  "cardId": "string",
  "scheduledAt": "2026-01-15T10:30:00Z"
}

Ejemplo de respuesta · 201

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 201,
  "data": {
    "id": "string",
    "templateId": 0,
    "cardId": "string",
    "message": "string",
    "status": "string",
    "type": "string",
    "sentAmount": 0,
    "deliveredAmount": 0,
    "createdAt": "2026-01-15T10:30:00Z",
    "scheduledAt": "2026-01-15T10:30:00Z"
  }
}

Obtener push

GET/api/v2/pushes/{id}

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string
`templateId`requerido	integer
`cardId`nullable	string
`message`requerido	string
`status`requerido	string
`type`requerido	string
`sentAmount`requerido	integer
`deliveredAmount`requerido	integer
`createdAt`requerido	string (date-time)
`scheduledAt`requerido	string (date-time)

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string",
    "templateId": 0,
    "cardId": "string",
    "message": "string",
    "status": "string",
    "type": "string",
    "sentAmount": 0,
    "deliveredAmount": 0,
    "createdAt": "2026-01-15T10:30:00Z",
    "scheduledAt": "2026-01-15T10:30:00Z"
  }
}

SMS

Envía mensajes SMS a tus clientes.

Enviar SMS a un cliente

POST/api/v2/sms

Requiere el header X-API-Key con tu clave de API.

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`message`requerido	string	por defecto: `""`
`customerId`requerido	string

Respuestas

›201Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`requerido	string

Ejemplo de petición

{
  "message": "string",
  "customerId": "string"
}

Ejemplo de respuesta · 201

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 201,
  "data": {
    "id": "string"
  }
}

Estadísticas

Consulta estadísticas de ingresos de tu negocio y estadísticas por recompensa o por enlace UTM de una plantilla.

Estadísticas de ingresos

GET/api/v2/statistics/revenue

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`companyId`	query	integer	Filtrar por companyId Ejemplo: `123`
`templateId`	query	integer	Filtrar por templateId Ejemplo: `123`
`startDate`	query	string (date)	Start date (format Y-m-d) por defecto: `null`
`endDate`	query	string (date)	End date (format Y-m-d) por defecto: `null`

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`totalCost`requerido	number (float)
`revenueTotal`requerido	number (float)
`revenueByDay`requerido	array de object
`date`requerido	string
`value`requerido	number (float)
`roi`requerido	number (float)
`roiByDay`requerido	array de object
`date`requerido	string
`value`requerido	number (float)
`ltv`requerido	number (float)

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "totalCost": 0,
    "revenueTotal": 0,
    "revenueByDay": [
      {
        "date": "string",
        "value": 0
      }
    ],
    "roi": 0,
    "roiByDay": [
      {
        "date": "string",
        "value": 0
      }
    ],
    "ltv": 0
  }
}

Estadísticas por recompensa de una plantilla

GET/api/v2/templates/{templateId}/statistics/rewards

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`startDate`	query	string (date)	Start date (format Y-m-d) por defecto: `null`
`endDate`	query	string (date)	End date (format Y-m-d) por defecto: `null`
`templateId`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	array de object

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": [
    {}
  ]
}

Estadísticas por UTM de una plantilla

GET/api/v2/templates/{templateId}/statistics/utm

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`startDate`	query	string (date)	Start date (format Y-m-d) por defecto: `null`
`endDate`	query	string (date)	End date (format Y-m-d) por defecto: `null`
`templateId`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	array de object

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": [
    {}
  ]
}

Automatizaciones

Crea y administra automatizaciones (workflows): flujos que se disparan con un evento (trigger), evalúan condiciones y ejecutan acciones como enviar mensajes, aplicar bonificaciones o esperar un tiempo determinado. Consulta los catálogos de disparadores, acciones y filtros disponibles, y revisa los registros de ejecución.

Activar automatización

POST/api/v2/workflows/{id}/activate

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`	string (uuid)
`name`	string
`status`	string	Uno de: draft, active, paused, needs_configuration, deleted
`definition`nullable	object
`startTransitionRefId`nullable	string
`event`nullable	object
`trigger`	string
`parameters`	object
`conditions`nullable	array de array de object
`filterName`	string
`operator`	string
`value`nullable	string
`startValue`nullable	string
`endValue`nullable	string
`transitions`	array de object
`refId`	string	Identificador estable dentro de la respuesta. Devuelve el refId enviado para transiciones guardadas vía la API v2; para definiciones creadas por otras vías (endpoints legacy v1) el almacenamiento guarda un id numérico y la salida emite un slug sintético "step-N". Los refs son estables dentro de una misma respuesta, pero no se garantiza que coincidan con slugs antiguos entre sistemas.
`action`	string
`parameters`	object	Objeto plano con los parámetros de la acción. Para action="delay", parameters.delayMinutes contiene el retraso configurado.
`conditions`nullable	array de array de object
`filterName`	string
`operator`	string
`value`nullable	string
`startValue`nullable	string
`endValue`nullable	string
`next`nullable	string
`trueNext`nullable	string
`falseNext`nullable	string

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "status": "string",
    "definition": {
      "startTransitionRefId": "string",
      "event": {
        "trigger": "string",
        "parameters": {},
        "conditions": [
          [
            {
              "filterName": "string",
              "operator": "string",
              "value": "string",
              "startValue": "string",
              "endValue": "string"
            }
          ]
        ]
      },
      "transitions": [
        {
          "refId": "string",
          "action": "string",
          "parameters": {},
          "conditions": [
            [
              {
                "filterName": "string",
                "operator": "string",
                "value": "string",
                "startValue": "string",
                "endValue": "string"
              }
            ]
          ],
          "next": "string",
          "trueNext": "string",
          "falseNext": "string"
        }
      ]
    }
  }
}

Lista de automatizaciones

GET/api/v2/workflows

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`status`	query	string	Filtrar por estado de la automatización Valores: `draft`, `active`, `paused`, `needs_configuration`, `deleted`
`page`	query	integer	Page number >= 1 · por defecto: `1`
`itemsPerPage`	query	integer	Items per page >= 1 · <= 1000 · por defecto: `30`

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`meta`	object
`totalItems`	integer
`itemsPerPage`	integer
`currentPage`	integer
`data`	array de object
`id`	string (uuid)
`name`	string
`status`	string	Uno de: draft, active, paused, needs_configuration, deleted
`definition`nullable	object
`startTransitionRefId`nullable	string
`event`nullable	object
`trigger`	string
`parameters`	object
`conditions`nullable	array de array de object
`filterName`	string
`operator`	string
`value`nullable	string
`startValue`nullable	string
`endValue`nullable	string
`transitions`	array de object
`refId`	string	Identificador estable dentro de la respuesta. Devuelve el refId enviado para transiciones guardadas vía la API v2; para definiciones creadas por otras vías (endpoints legacy v1) el almacenamiento guarda un id numérico y la salida emite un slug sintético "step-N". Los refs son estables dentro de una misma respuesta, pero no se garantiza que coincidan con slugs antiguos entre sistemas.
`action`	string
`parameters`	object	Objeto plano con los parámetros de la acción. Para action="delay", parameters.delayMinutes contiene el retraso configurado.
`conditions`nullable	array de array de object
`filterName`	string
`operator`	string
`value`nullable	string
`startValue`nullable	string
`endValue`nullable	string
`next`nullable	string
`trueNext`nullable	string
`falseNext`nullable	string

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "meta": {
    "totalItems": 250,
    "itemsPerPage": 30,
    "currentPage": 1
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "status": "string",
      "definition": {
        "startTransitionRefId": "string",
        "event": {
          "trigger": "string",
          "parameters": {},
          "conditions": [
            [
              {
                "filterName": "string",
                "operator": "string",
                "value": "string",
                "startValue": "string",
                "endValue": "string"
              }
            ]
          ]
        },
        "transitions": [
          {
            "refId": "string",
            "action": "string",
            "parameters": {},
            "conditions": [
              [
                {
                  "filterName": null,
                  "operator": null,
                  "value": null,
                  "startValue": null,
                  "endValue": null
                }
              ]
            ],
            "next": "string",
            "trueNext": "string",
            "falseNext": "string"
          }
        ]
      }
    }
  ]
}

Crear automatización

POST/api/v2/workflows

Requiere el header X-API-Key con tu clave de API.

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`name`requerido	string
`definition`nullable	object	Grafo declarativo completo de una automatización: qué evento la inicia, qué transiciones existen y cuál es el punto de entrada. Todas las referencias cruzadas entre transiciones se hacen por refId.
`startTransitionRefId`requerido	string	refId de la transición que se ejecuta primero.
`event`requerido	object	Definición del evento de la automatización: qué disparador la activa y (opcionalmente) qué condiciones deben cumplirse al inicio.
`trigger`requerido	string	Identificador del disparador. Consulta GET /api/v2/workflows/triggers para ver la lista completa y los parámetros requeridos. Valores: `customerCreated`, `customerDeleted`, `customerBirthday`, `cardInstalled`, `cardExpired`, `cardDeleted`, `cardIssued`, `cardScanned`, `couponRedeemed`, `feedbackCreated`, `stampsAmountReached`, `bonusesAmountReached`, `rewardsAmountReached`, `rewardsUsedAmountReached`, `becomeRfmSegment`, `inboundWebhook`, `expiringStamps`, `expiringBonuses`, `manual`, `scheduledTime`
`parameters`	object	Objeto plano con los parámetros del disparador (por ejemplo templateId, threshold, rfmSegmentName, expirationOffsetValue). Consulta GET /api/v2/workflows/triggers para conocer los parámetros requeridos de cada disparador.
`conditions`	array de array de object	Opcional. Condiciones adicionales que se evalúan sobre el cliente o la tarjeta justo después de que se activa el disparador. El arreglo exterior es un OR de grupos y cada grupo es un AND de bloques de filtro.
`filterName`requerido	string
`operator`requerido	string
`value`nullable	string	Valor para operadores como eq, neq, gt, gte, lt, lte, like, in.
`startValue`nullable	string	Inicio del rango para el operador between.
`endValue`nullable	string	Fin del rango para el operador between.
`transitions`	array de object
`refId`requerido	string
`action`requerido	string	Identificador de la acción. Consulta GET /api/v2/workflows/actions para ver la lista completa y los parámetros requeridos. Valores: `delay`, `condition`, `sendEmail`, `sendSms`, `sendPush`, `accrual`, `withdraw`, `sendHttpRequest`, `sendMetaAdsConversion`, `changeCardExpiration`
`parameters`	object	Objeto plano con los parámetros de la acción. Consulta GET /api/v2/workflows/actions para conocer los parámetros requeridos de cada acción. Para action="delay" envía parameters.delayMinutes (entero >= 1).
`conditions`nullable	array de array de object	Requerido cuando action="condition". El arreglo exterior es un OR de grupos y cada grupo es un AND de bloques de filtro.
`filterName`requerido	string
`operator`requerido	string
`value`nullable	string	Valor para operadores como eq, neq, gt, gte, lt, lte, like, in.
`startValue`nullable	string	Inicio del rango para el operador between.
`endValue`nullable	string	Fin del rango para el operador between.
`next`nullable	string	refId de la siguiente transición. Permitido para cualquier acción excepto "condition".
`trueNext`nullable	string	refId que se toma cuando la condición evalúa a true. Permitido solo cuando action="condition".
`falseNext`nullable	string	refId que se toma cuando la condición evalúa a false. Permitido solo cuando action="condition".
`activate`	boolean	por defecto: `false`

Respuestas

›201Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`	string (uuid)
`name`	string
`status`	string	Uno de: draft, active, paused, needs_configuration, deleted
`definition`nullable	object
`startTransitionRefId`nullable	string
`event`nullable	object
`trigger`	string
`parameters`	object
`conditions`nullable	array de array de object
`filterName`	string
`operator`	string
`value`nullable	string
`startValue`nullable	string
`endValue`nullable	string
`transitions`	array de object
`refId`	string	Identificador estable dentro de la respuesta. Devuelve el refId enviado para transiciones guardadas vía la API v2; para definiciones creadas por otras vías (endpoints legacy v1) el almacenamiento guarda un id numérico y la salida emite un slug sintético "step-N". Los refs son estables dentro de una misma respuesta, pero no se garantiza que coincidan con slugs antiguos entre sistemas.
`action`	string
`parameters`	object	Objeto plano con los parámetros de la acción. Para action="delay", parameters.delayMinutes contiene el retraso configurado.
`conditions`nullable	array de array de object
`filterName`	string
`operator`	string
`value`nullable	string
`startValue`nullable	string
`endValue`nullable	string
`next`nullable	string
`trueNext`nullable	string
`falseNext`nullable	string

Ejemplo de petición

{
  "name": "string",
  "definition": {
    "startTransitionRefId": "welcome-sms",
    "event": {
      "trigger": "customerCreated",
      "parameters": {
        "templateId": 123
      },
      "conditions": [
        [
          {
            "filterName": "CardStatus",
            "operator": "eq",
            "value": "active",
            "startValue": "2024-01-01",
            "endValue": "2024-12-31"
          }
        ]
      ]
    },
    "transitions": [
      {
        "refId": "welcome-sms",
        "action": "delay",
        "parameters": {},
        "conditions": [
          [
            {
              "filterName": "CardStatus",
              "operator": "eq",
              "value": "active",
              "startValue": "2024-01-01",
              "endValue": "2024-12-31"
            }
          ]
        ],
        "next": "string",
        "trueNext": "string",
        "falseNext": "string"
      }
    ]
  },
  "activate": true
}

Ejemplo de respuesta · 201

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 201,
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "status": "string",
    "definition": {
      "startTransitionRefId": "string",
      "event": {
        "trigger": "string",
        "parameters": {},
        "conditions": [
          [
            {
              "filterName": "string",
              "operator": "string",
              "value": "string",
              "startValue": "string",
              "endValue": "string"
            }
          ]
        ]
      },
      "transitions": [
        {
          "refId": "string",
          "action": "string",
          "parameters": {},
          "conditions": [
            [
              {
                "filterName": "string",
                "operator": "string",
                "value": "string",
                "startValue": "string",
                "endValue": "string"
              }
            ]
          ],
          "next": "string",
          "trueNext": "string",
          "falseNext": "string"
        }
      ]
    }
  }
}

Obtener automatización

GET/api/v2/workflows/{id}

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`	string (uuid)
`name`	string
`status`	string	Uno de: draft, active, paused, needs_configuration, deleted
`definition`nullable	object
`startTransitionRefId`nullable	string
`event`nullable	object
`trigger`	string
`parameters`	object
`conditions`nullable	array de array de object
`filterName`	string
`operator`	string
`value`nullable	string
`startValue`nullable	string
`endValue`nullable	string
`transitions`	array de object
`refId`	string	Identificador estable dentro de la respuesta. Devuelve el refId enviado para transiciones guardadas vía la API v2; para definiciones creadas por otras vías (endpoints legacy v1) el almacenamiento guarda un id numérico y la salida emite un slug sintético "step-N". Los refs son estables dentro de una misma respuesta, pero no se garantiza que coincidan con slugs antiguos entre sistemas.
`action`	string
`parameters`	object	Objeto plano con los parámetros de la acción. Para action="delay", parameters.delayMinutes contiene el retraso configurado.
`conditions`nullable	array de array de object
`filterName`	string
`operator`	string
`value`nullable	string
`startValue`nullable	string
`endValue`nullable	string
`next`nullable	string
`trueNext`nullable	string
`falseNext`nullable	string

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "status": "string",
    "definition": {
      "startTransitionRefId": "string",
      "event": {
        "trigger": "string",
        "parameters": {},
        "conditions": [
          [
            {
              "filterName": "string",
              "operator": "string",
              "value": "string",
              "startValue": "string",
              "endValue": "string"
            }
          ]
        ]
      },
      "transitions": [
        {
          "refId": "string",
          "action": "string",
          "parameters": {},
          "conditions": [
            [
              {
                "filterName": "string",
                "operator": "string",
                "value": "string",
                "startValue": "string",
                "endValue": "string"
              }
            ]
          ],
          "next": "string",
          "trueNext": "string",
          "falseNext": "string"
        }
      ]
    }
  }
}

Actualizar automatización

PUT/api/v2/workflows/{id}

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Cuerpo de la petición application/json

Campo	Tipo	Descripción
`name`nullable	string
`definition`nullable	object	Grafo declarativo completo de una automatización: qué evento la inicia, qué transiciones existen y cuál es el punto de entrada. Todas las referencias cruzadas entre transiciones se hacen por refId.
`startTransitionRefId`requerido	string	refId de la transición que se ejecuta primero.
`event`requerido	object	Definición del evento de la automatización: qué disparador la activa y (opcionalmente) qué condiciones deben cumplirse al inicio.
`trigger`requerido	string	Identificador del disparador. Consulta GET /api/v2/workflows/triggers para ver la lista completa y los parámetros requeridos. Valores: `customerCreated`, `customerDeleted`, `customerBirthday`, `cardInstalled`, `cardExpired`, `cardDeleted`, `cardIssued`, `cardScanned`, `couponRedeemed`, `feedbackCreated`, `stampsAmountReached`, `bonusesAmountReached`, `rewardsAmountReached`, `rewardsUsedAmountReached`, `becomeRfmSegment`, `inboundWebhook`, `expiringStamps`, `expiringBonuses`, `manual`, `scheduledTime`
`parameters`	object	Objeto plano con los parámetros del disparador (por ejemplo templateId, threshold, rfmSegmentName, expirationOffsetValue). Consulta GET /api/v2/workflows/triggers para conocer los parámetros requeridos de cada disparador.
`conditions`	array de array de object	Opcional. Condiciones adicionales que se evalúan sobre el cliente o la tarjeta justo después de que se activa el disparador. El arreglo exterior es un OR de grupos y cada grupo es un AND de bloques de filtro.
`filterName`requerido	string
`operator`requerido	string
`value`nullable	string	Valor para operadores como eq, neq, gt, gte, lt, lte, like, in.
`startValue`nullable	string	Inicio del rango para el operador between.
`endValue`nullable	string	Fin del rango para el operador between.
`transitions`	array de object
`refId`requerido	string
`action`requerido	string	Identificador de la acción. Consulta GET /api/v2/workflows/actions para ver la lista completa y los parámetros requeridos. Valores: `delay`, `condition`, `sendEmail`, `sendSms`, `sendPush`, `accrual`, `withdraw`, `sendHttpRequest`, `sendMetaAdsConversion`, `changeCardExpiration`
`parameters`	object	Objeto plano con los parámetros de la acción. Consulta GET /api/v2/workflows/actions para conocer los parámetros requeridos de cada acción. Para action="delay" envía parameters.delayMinutes (entero >= 1).
`conditions`nullable	array de array de object	Requerido cuando action="condition". El arreglo exterior es un OR de grupos y cada grupo es un AND de bloques de filtro.
`filterName`requerido	string
`operator`requerido	string
`value`nullable	string	Valor para operadores como eq, neq, gt, gte, lt, lte, like, in.
`startValue`nullable	string	Inicio del rango para el operador between.
`endValue`nullable	string	Fin del rango para el operador between.
`next`nullable	string	refId de la siguiente transición. Permitido para cualquier acción excepto "condition".
`trueNext`nullable	string	refId que se toma cuando la condición evalúa a true. Permitido solo cuando action="condition".
`falseNext`nullable	string	refId que se toma cuando la condición evalúa a false. Permitido solo cuando action="condition".
`activate`	boolean	por defecto: `false`

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`	string (uuid)
`name`	string
`status`	string	Uno de: draft, active, paused, needs_configuration, deleted
`definition`nullable	object
`startTransitionRefId`nullable	string
`event`nullable	object
`trigger`	string
`parameters`	object
`conditions`nullable	array de array de object
`filterName`	string
`operator`	string
`value`nullable	string
`startValue`nullable	string
`endValue`nullable	string
`transitions`	array de object
`refId`	string	Identificador estable dentro de la respuesta. Devuelve el refId enviado para transiciones guardadas vía la API v2; para definiciones creadas por otras vías (endpoints legacy v1) el almacenamiento guarda un id numérico y la salida emite un slug sintético "step-N". Los refs son estables dentro de una misma respuesta, pero no se garantiza que coincidan con slugs antiguos entre sistemas.
`action`	string
`parameters`	object	Objeto plano con los parámetros de la acción. Para action="delay", parameters.delayMinutes contiene el retraso configurado.
`conditions`nullable	array de array de object
`filterName`	string
`operator`	string
`value`nullable	string
`startValue`nullable	string
`endValue`nullable	string
`next`nullable	string
`trueNext`nullable	string
`falseNext`nullable	string

Ejemplo de petición

{
  "name": "string",
  "definition": {
    "startTransitionRefId": "welcome-sms",
    "event": {
      "trigger": "customerCreated",
      "parameters": {
        "templateId": 123
      },
      "conditions": [
        [
          {
            "filterName": "CardStatus",
            "operator": "eq",
            "value": "active",
            "startValue": "2024-01-01",
            "endValue": "2024-12-31"
          }
        ]
      ]
    },
    "transitions": [
      {
        "refId": "welcome-sms",
        "action": "delay",
        "parameters": {},
        "conditions": [
          [
            {
              "filterName": "CardStatus",
              "operator": "eq",
              "value": "active",
              "startValue": "2024-01-01",
              "endValue": "2024-12-31"
            }
          ]
        ],
        "next": "string",
        "trueNext": "string",
        "falseNext": "string"
      }
    ]
  },
  "activate": true
}

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "status": "string",
    "definition": {
      "startTransitionRefId": "string",
      "event": {
        "trigger": "string",
        "parameters": {},
        "conditions": [
          [
            {
              "filterName": "string",
              "operator": "string",
              "value": "string",
              "startValue": "string",
              "endValue": "string"
            }
          ]
        ]
      },
      "transitions": [
        {
          "refId": "string",
          "action": "string",
          "parameters": {},
          "conditions": [
            [
              {
                "filterName": "string",
                "operator": "string",
                "value": "string",
                "startValue": "string",
                "endValue": "string"
              }
            ]
          ],
          "next": "string",
          "trueNext": "string",
          "falseNext": "string"
        }
      ]
    }
  }
}

Eliminar automatización

DELETE/api/v2/workflows/{id}

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`	string

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "string"
  }
}

Lista de acciones de automatización con sus esquemas de parámetros

GET/api/v2/workflows/actions

Requiere el header X-API-Key con tu clave de API.

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	array de object
`id`	string
`displayName`	string
`description`	string
`branching`	string	Uno de: linear, condition. Las acciones "condition" se bifurcan vía trueNext/falseNext; todas las demás usan next.
`parameters`	array de object
`name`	string
`type`	string	Uno de: string, integer, number, boolean
`required`	boolean
`allowedValues`nullable	array de string
`min`nullable	integer
`max`nullable	integer
`reference`nullable	string	Pista sobre qué otro recurso debe referenciar el valor (por ejemplo "userTemplate").
`requiredExternalService`nullable	string	Slug del servicio externo que debe estar conectado para que esta acción funcione, o null.

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": [
    {
      "id": "string",
      "displayName": "string",
      "description": "string",
      "branching": "string",
      "parameters": [
        {
          "name": "string",
          "type": "string",
          "required": true,
          "allowedValues": [
            "string"
          ],
          "min": 0,
          "max": 0,
          "reference": "string"
        }
      ],
      "requiredExternalService": "string"
    }
  ]
}

Lista de filtros de segmentación disponibles para usar dentro de event.conditions o de una acción de tipo condition.

GET/api/v2/workflows/filters

Requiere el header X-API-Key con tu clave de API.

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	array de object
`name`	string
`valueType`nullable	string	Uno de: string, number
`allowedOperators`	array de string
`possibleValues`	array de string
`description`nullable	string

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": [
    {
      "name": "string",
      "valueType": "string",
      "allowedOperators": [
        "string"
      ],
      "possibleValues": [
        "string"
      ],
      "description": "string"
    }
  ]
}

Lista de registros de ejecución de una automatización

GET/api/v2/workflows/{workflowId}/logs

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`status`	query	string	Filtrar por estado del registro Valores: `succeeded`, `failed`
`workflowInstanceId`	query	string (uuid)	Filtrar por una sola instancia (ejecución) de la automatización
`page`	query	integer	Page number >= 1 · por defecto: `1`
`itemsPerPage`	query	integer	Items per page >= 1 · <= 1000 · por defecto: `30`
`workflowId`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`meta`	object
`totalItems`	integer
`itemsPerPage`	integer
`currentPage`	integer
`data`	array de object
`id`	string (uuid)
`workflowId`	string (uuid)
`workflowInstanceId`	string (uuid)
`workflowTransitionId`	string (uuid)
`action`	string	Acción de la transición ejecutada
`status`	string	Uno de: succeeded, failed
`errorMessage`nullable	string
`customerId`	string (uuid)
`createdAt`	string (date-time)

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "meta": {
    "totalItems": 250,
    "itemsPerPage": 30,
    "currentPage": 1
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "workflowInstanceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "workflowTransitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": "string",
      "status": "string",
      "errorMessage": "string",
      "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2026-01-15T10:30:00Z"
    }
  ]
}

Lista de disparadores disponibles con sus esquemas de parámetros

GET/api/v2/workflows/triggers

Requiere el header X-API-Key con tu clave de API.

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	array de object
`id`	string
`displayName`	string
`description`	string
`type`	string	Uno de: event, webhook
`parameters`	array de object
`name`	string
`type`	string	Uno de: string, integer, number, boolean
`required`	boolean
`allowedValues`nullable	array de string
`min`nullable	integer
`max`nullable	integer
`reference`nullable	string	Pista sobre qué otro recurso debe referenciar el valor (por ejemplo "userTemplate").

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": [
    {
      "id": "string",
      "displayName": "string",
      "description": "string",
      "type": "string",
      "parameters": [
        {
          "name": "string",
          "type": "string",
          "required": true,
          "allowedValues": [
            "string"
          ],
          "min": 0,
          "max": 0,
          "reference": "string"
        }
      ]
    }
  ]
}

Pausar automatización

POST/api/v2/workflows/{id}/pause

Requiere el header X-API-Key con tu clave de API.

Parámetros

Parámetro	Ubicación	Tipo	Descripción
`id`requerido	ruta	string

Respuestas

›200Respuesta exitosa

Esquema de respuesta application/json

Campo	Tipo	Descripción
`responseId`	string (uuid)
`createdAt`	string (date-time)
`code`	integer
`data`	object
`id`	string (uuid)
`name`	string
`status`	string	Uno de: draft, active, paused, needs_configuration, deleted
`definition`nullable	object
`startTransitionRefId`nullable	string
`event`nullable	object
`trigger`	string
`parameters`	object
`conditions`nullable	array de array de object
`filterName`	string
`operator`	string
`value`nullable	string
`startValue`nullable	string
`endValue`nullable	string
`transitions`	array de object
`refId`	string	Identificador estable dentro de la respuesta. Devuelve el refId enviado para transiciones guardadas vía la API v2; para definiciones creadas por otras vías (endpoints legacy v1) el almacenamiento guarda un id numérico y la salida emite un slug sintético "step-N". Los refs son estables dentro de una misma respuesta, pero no se garantiza que coincidan con slugs antiguos entre sistemas.
`action`	string
`parameters`	object	Objeto plano con los parámetros de la acción. Para action="delay", parameters.delayMinutes contiene el retraso configurado.
`conditions`nullable	array de array de object
`filterName`	string
`operator`	string
`value`nullable	string
`startValue`nullable	string
`endValue`nullable	string
`next`nullable	string
`trueNext`nullable	string
`falseNext`nullable	string

Ejemplo de respuesta · 200

{
  "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T10:30:00Z",
  "code": 200,
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "status": "string",
    "definition": {
      "startTransitionRefId": "string",
      "event": {
        "trigger": "string",
        "parameters": {},
        "conditions": [
          [
            {
              "filterName": "string",
              "operator": "string",
              "value": "string",
              "startValue": "string",
              "endValue": "string"
            }
          ]
        ]
      },
      "transitions": [
        {
          "refId": "string",
          "action": "string",
          "parameters": {},
          "conditions": [
            [
              {
                "filterName": "string",
                "operator": "string",
                "value": "string",
                "startValue": "string",
                "endValue": "string"
              }
            ]
          ],
          "next": "string",
          "trueNext": "string",
          "falseNext": "string"
        }
      ]
    }
  }
}