La interfaz para programación de la aplicación (API) T1pagos está diseñada para integrar fácilmente la funcionalidad de pagos en cualquier sitio web. Está basada en arquitectura REST que utiliza el protocolo HTTP para proveer una interfaz uniforme, agnóstica a lenguajes de programación, orientado a recursos y con códigos de respuesta estandarizados.
Todas las respuestas del API están en formato JSON y utiliza los códigos de respuesta del protocolo HTTP en los encabezados.
El sistema utiliza dos ambientes: uno de sandbox y otro de producción, cada uno con diferentes llaves de acceso para evitar que peticiones destinadas a un ambiente se procesen en otro.
Ambiente sandbox
Ambiente productivo
Crear nueva tarjeta
nombre required | string [ 3 .. 60 ] characters Nombre como aparece en la tarjeta |
pan required | string <number> [ 14 .. 19 ] characters Número de tarjeta |
cvv2 required | string <number> [ 3 .. 4 ] characters Código de seguridad de la tarjeta cvv2, cvc |
expiracion_mes required | integer [ 1 .. 12 ] Mes de expiración |
expiracion_anio required | integer [ 2 .. 4 ] characters [ 0 .. 9999 ] Año de expiración |
object (Direccion) | |
cliente_id | string Id de cliente en plataforma T1pagos |
default | boolean Determina si la tarjeta es la utilizada por dafault para el cliente asignado |
cargo_unico | boolean Determina si la tarjeta sólo se puede utilizar para un único cargo |
{- "nombre": "string",
- "pan": "4111111111111111",
- "cvv2": "123",
- "expiracion_mes": 1,
- "expiracion_anio": 9999,
- "direccion": {
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "cliente_id": "string",
- "default": true,
- "cargo_unico": true
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "tarjeta": {
- "token": "string",
- "pan": "411111******1111",
- "terminacion": 0,
- "nombre": "string",
- "expiracion_mes": 1,
- "expiracion_anio": 0,
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "iin": 0,
- "marca": "visa",
- "cliente_id": "string",
- "default": true,
- "cargo_unico": true,
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z"
}
}
}
Ambiente sandbox
Ambiente productivo
registros_por_pagina | integer [ 5 .. 100 ] Default: 25 Máximo de registros a regresar |
pagina | integer Número de página |
ordenar_por | string Enum: "actualizacion" "cliente_id" "creacion" "iin" "marca" "nombre" "pan" "terminacion" "token" Valor que será usado como referencia en la búsqueda |
orden | string Enum: "asc" "desc" Podrá ser de orden Ascendente (asc) o Descendente (desc) |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "tarjetas": {
- "data": [
- {
- "token": "string",
- "pan": "411111******1111",
- "terminacion": 0,
- "nombre": "string",
- "expiracion_mes": 1,
- "expiracion_anio": 0,
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "iin": 0,
- "marca": "visa",
- "cliente_id": "string",
- "default": true,
- "cargo_unico": true,
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z"
}
], - "desde": 0,
- "hasta": 0,
- "registros_por_pagina": 10,
- "pagina_actual": 1,
- "ultima_pagina": 1,
- "total_pagina": 0,
- "total": 0
}
}
}
Ambiente sandbox
Ambiente productivo
token required | string Identificador de tarjeta |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "tarjeta": {
- "token": "string",
- "pan": "411111******1111",
- "terminacion": 0,
- "nombre": "string",
- "expiracion_mes": 1,
- "expiracion_anio": 0,
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "iin": 0,
- "marca": "visa",
- "cliente_id": "string",
- "default": true,
- "cargo_unico": true,
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z"
}
}
}
Ambiente sandbox
Ambiente productivo
token required | string Identificador de tarjeta |
Actualizar Tarjeta
nombre | string [ 3 .. 60 ] characters Nombre como aparece en la tarjeta |
expiracion_mes | integer [ 1 .. 12 ] characters Mes de expiración |
expiracion_anio | integer Año de expiración |
cvv2 | string <number> [ 3 .. 4 ] characters Código de seguridad de la tarjeta cvv2, cvc |
object (Direccion) | |
cliente_id | string Id de cliente en plataforma T1pagos |
default | boolean Determina si la tarjeta es la utilizada por dafault para el cliente asignado |
{- "nombre": "string",
- "expiracion_mes": 0,
- "expiracion_anio": 0,
- "cvv2": "123",
- "direccion": {
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "cliente_id": "string",
- "default": true
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "tarjeta": {
- "token": "string",
- "pan": "411111******1111",
- "terminacion": 0,
- "nombre": "string",
- "expiracion_mes": 1,
- "expiracion_anio": 0,
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "iin": 0,
- "marca": "visa",
- "cliente_id": "string",
- "default": true,
- "cargo_unico": true,
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z"
}
}
}
Ambiente sandbox
Ambiente productivo
token required | string Identificador de tarjeta |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "tarjeta": {
- "token": "b5507016-7da2-4777-a161-1e8042a6a377",
- "borrada": "2019-08-24T14:15:22Z"
}
}
}
Ambiente sandbox
Ambiente productivo
Crear nuevo cargo
monto required | number [ 1 .. 999999999999999 ] Monto de la transacción |
pais | string = 3 characters Default: "MEX" Identificador de país de tres caracteres |
moneda | string = 3 characters Default: "MXN" Identificador de moneda de tres caracteres de acuerdo al estándar ISO 4217 |
descripcion | string [ 0 .. 250 ] characters Descripción breve de la transacción |
capturar | boolean Default: true Permite hacer sólo la autorización de un cargo sin capturar |
incluir_riesgo | boolean Permite obtener una respuesta extendida del análisis de riesgo |
metodo_pago | string Default: "tarjeta" Enum: "tarjeta" "credito" "transferencia" Define el tipo de pago que será usado en la transacción, en cargos con tarjeta bancaria deberá ser ('tarjeta'), cargos con transferencia bancaria deberá ser ('transferencia') cargos con crédito claro shop deberá ser ('credito') |
object Objeto tarjeta, requerido si metodo_pago = tarjeta | |
object Objeto credito, requerido si metodo_pago = credito | |
object Objeto transferencia, requerido si metodo_pago = transferencia | |
object (Pedido) Objeto Pedido | |
object | |
object (PlanPagos) Objeto Plan de Pagos |
{- "monto": "100.00",
- "pais": "MEX",
- "moneda": "MXN",
- "descripcion": "string",
- "capturar": true,
- "incluir_riesgo": true,
- "metodo_pago": "tarjeta",
- "tarjeta": {
- "token": "string"
}, - "credito": {
- "formato": "claroshop",
- "sucursal": 0
}, - "transferencia": {
- "formato": "string",
- "concepto": "string",
- "fecha_inicio": "2019-08-24T14:15:22Z",
- "fecha_fin": "2019-08-24T14:15:22Z"
}, - "pedido": {
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "direccion_envio": {
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90,
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string"
}, - "peso": 0,
- "articulos": [
- {
- "id_pedido": "string",
- "nombre_producto": "string",
- "descripcion_producto": "string",
- "sku": "string",
- "ean_upc": "string",
- "tipo_producto": "digital",
- "cantidad": 0,
- "precio_unitario": 0,
- "precio_total": 0,
- "otros": "string",
- "es_digital": true
}
], - "total_articulos": 0,
- "fecha_creacion": "2019-08-24T14:15:22Z",
- "fecha_entrega": "2019-08-24T14:15:22Z",
- "empresa_envio": "noventamin",
- "numero_guia": "string",
- "es_regalo": true,
- "monto_articulos": 0,
- "monto_envio": 0,
- "total_monto": 0,
- "device_fingerprint": "string",
- "ip_cliente": "192.168.0.1",
- "datos_comercio": {
- "1": "test string",
- "2": "another string"
}
}, - "cliente": {
- "id": "string",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "direccion": {
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}
}, - "PlanPagos": {
- "plan": "msi",
- "parcialidades": 6,
- "diferido": 0,
- "redime_puntos": false
}
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "cargo": {
- "id": "string",
- "monto": 0,
- "autorizacion_id": "string",
- "tipo": "cargo",
- "capturado": false,
- "conciliado": false,
- "monto_capturado": 0,
- "monto_reembolsado": 0,
- "fecha_conciliacion": "2019-08-24T14:15:22Z",
- "fecha": "2019-08-24T14:15:22Z",
- "orden_id": "string",
- "cliente_id": "string",
- "estatus": "completada",
- "codigo": "string",
- "descripcion": "string",
- "riesgo": {
- "score": 0,
- "decision": "aceptar",
- "procesador": "string"
}, - "tarjeta": {
- "token": "string",
- "pan": "411111******1111",
- "terminacion": 0,
- "nombre": "string",
- "expiracion_mes": 1,
- "expiracion_anio": 0,
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "iin": 0,
- "marca": "visa",
- "cliente_id": "string",
- "default": true,
- "cargo_unico": true,
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z"
}, - "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo"
}, - "prueba": true
}
}
}
Ambiente sandbox
Ambiente productivo
cargo_id required | string Identificador de operación |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "cargo": {
- "id": "string",
- "monto": 0,
- "autorizacion_id": "string",
- "tipo": "cargo",
- "capturado": false,
- "conciliado": false,
- "monto_capturado": 0,
- "monto_reembolsado": 0,
- "fecha_conciliacion": "2019-08-24T14:15:22Z",
- "fecha": "2019-08-24T14:15:22Z",
- "orden_id": "string",
- "cliente_id": "string",
- "estatus": "completada",
- "codigo": "string",
- "descripcion": "string",
- "tarjeta": {
- "token": "string",
- "pan": "411111******1111",
- "terminacion": 0,
- "nombre": "string",
- "expiracion_mes": 1,
- "expiracion_anio": 0,
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "iin": 0,
- "marca": "visa",
- "cliente_id": "string",
- "default": true,
- "cargo_unico": true,
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z"
}, - "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo"
}, - "prueba": true
}
}
}
Ambiente sandbox
Ambiente productivo
cargo_id required | string Identificador de transacción de cargo |
Cancelar un cargo
monto required | number >= 0 Monto de la transacción |
orden_id | string Identificador de orden del comercio |
cliente_id | string Identificador de cliente del comercio |
{- "monto": 0,
- "orden_id": "string",
- "cliente_id": "string"
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "cancelacion": {
- "id": "string",
- "monto": 0,
- "cargo": "string",
- "autorizacion_id": "string",
- "tipo": "cancelacion",
- "orden_id": "string",
- "cliente_id": "string",
- "estatus": "string"
}
}
}
Ambiente sandbox
Ambiente productivo
cargo_id required | string Identificador de transacción de cargo |
Reembolsar una transacción
monto required | number >= 0 Monto de la transacción |
orden_id | string Identificador de orden del comercio |
cliente_id | string Identificador de cliente del comercio |
{- "monto": 0,
- "orden_id": "string",
- "cliente_id": "string"
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "reembolso": {
- "id": "string",
- "monto": 0,
- "cargo_id": "string",
- "autorizacion_id": "string",
- "tipo": "reembolso",
- "orden_id": "string",
- "cliente_id": "string",
- "estatus": "string"
}
}
}
Ambiente sandbox
Ambiente productivo
cargo_id required | string Identificador de transacción de cargo |
Capturar una transacción
monto required | number >= 1 Monto de la transacción |
{- "monto": 1
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "captura": {
- "id": "string",
- "monto": 0,
- "cargo_id": "string",
- "autorizacion_id": "string",
- "tipo": "captura",
- "orden_id": "string",
- "estatus": "string"
}
}
}
Ambiente sandbox
Ambiente productivo
Crear nuevo cliente
id_externo required | string Identificador de cliente en plataforma del comercio, NO es recomendable usar un email como identificador único ya que un cliente podrá cambiar su correo, en caso de que un cliente actualice su correo, podrá editarse el correo electrónico del cliente. El id_externo no podrá editarse una vez creado el cliente. |
nombre | string Nombre o nombres del cliente |
apellido_paterno | string Apellido paterno del cliente |
apellido_materno | string Apellido materno del cliente |
sexo | string Sexo del cliente (masculino/femenino) |
email required | string <email> email del cliente |
object (Telefono) | |
nacimiento | string <date-time> Fecha de nacimiento |
object (Direccion) | |
creacion_externa | string <date-time> Fecha y hora de creación del usuario en el comercio |
device_fingerprint | string Id de dispositivo de cliente |
{- "id_externo": "string",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "string",
- "email": "user@example.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "creacion_externa": "2019-08-24T14:15:22Z",
- "device_fingerprint": "string"
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo"
}
}
}
Ambiente sandbox
Ambiente productivo
registros_por_pagina | integer [ 5 .. 100 ] Default: 25 Máximo de registros a regresar |
pagina | integer Número de página |
ordenar_por | string Enum: "actualizacion" "apellido_materno" "apellido_paterno" "creacion" "email" "estado" "id" "nacimiento" "nombre" "sexo" Valor que será usado como referencia en la búsqueda, podrá ser "creacion" o "email" |
orden | string Enum: "asc" "desc" Podrá ser de orden Ascendente (asc) o Descendente (desc) |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "clientes": {
- "data": [
- {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo"
}
], - "desde": 0,
- "hasta": 0,
- "registros_por_pagina": 10,
- "pagina_actual": 1,
- "ultima_pagina": 1,
- "total_pagina": 0,
- "total": 0
}
}
}
Ambiente sandbox
Ambiente productivo
id_externo required | string Id de cliente en comercio |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo",
- "suscripciones": [
- {
- "id": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "plan_id": "string",
- "cliente_id": "string",
- "metodo_pago": "tarjeta",
- "metodo_pago_token": "string",
- "estado": "prueba",
- "monto": 129.99,
- "inicio": "2019-08-24",
- "fin": "2019-08-24",
- "prueba_inicio": "2019-08-24",
- "prueba_fin": "2019-08-24",
- "periodo_fecha_inicio": "2019-08-24",
- "periodo_fecha_fin": "2019-08-24",
- "fecha_proximo_cargo": "2019-08-24",
- "plan": {
- "id": "string",
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": 0,
- "monto_maximo": 0,
- "moneda": "MXN",
- "pais": "MEX",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}, - "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo"
}
}
]
}
}
}
Ambiente sandbox
Ambiente productivo
cliente_id required | string Identificador de Cliente |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo",
- "suscripciones": [
- {
- "id": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "plan_id": "string",
- "cliente_id": "string",
- "metodo_pago": "tarjeta",
- "metodo_pago_token": "string",
- "estado": "prueba",
- "monto": 129.99,
- "inicio": "2019-08-24",
- "fin": "2019-08-24",
- "prueba_inicio": "2019-08-24",
- "prueba_fin": "2019-08-24",
- "periodo_fecha_inicio": "2019-08-24",
- "periodo_fecha_fin": "2019-08-24",
- "fecha_proximo_cargo": "2019-08-24",
- "plan": {
- "id": "string",
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": 0,
- "monto_maximo": 0,
- "moneda": "MXN",
- "pais": "MEX",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}, - "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo"
}
}
]
}
}
}
Ambiente sandbox
Ambiente productivo
cliente_id required | string Identificador de Cliente |
Actualizar Cliente
nombre | string Nombre o nombres del cliente |
apellido_paterno | string Apellido paterno del cliente |
apellido_materno | string Apellido materno del cliente |
sexo | string Enum: "masculino" "femenino" Sexo del cliente |
string <email> Correo electrónico del cliente | |
object (Telefono) | |
nacimiento | string <date-time> Fecha de nacimiento |
object (Direccion) | |
device_fingerprint | string Id de dispositivo de cliente |
estado | string Enum: "activo" "inactivo" "suspendido" Estado del Cliente |
{- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "device_fingerprint": "string",
- "estado": "activo"
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo"
}
}
}
Ambiente sandbox
Ambiente productivo
cliente_id required | string Identificador de Cliente |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "cliente": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "eliminacion": "2019-08-24T14:15:22Z"
}
}
}
Ambiente sandbox
Ambiente productivo
cliente_id required | string Identificador de Cliente |
registros_por_pagina | integer [ 5 .. 100 ] Default: 25 Máximo de registros a regresar |
pagina | integer Número de página |
ordenar_por | string Enum: "creacion" "estado" "plan_id" "inicio_suscripcion" Valor que será usado como referencia en la búsqueda, podrá ser: creacion, nombre, estado, puede_suscribir |
orden | string Enum: "asc" "desc" Podrá ser de orden Ascendente (asc) o Descendente (desc) |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "suscripciones": {
- "data": [
- {
- "id": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "plan_id": "string",
- "cliente_id": "string",
- "metodo_pago": "tarjeta",
- "metodo_pago_token": "string",
- "estado": "prueba",
- "monto": 129.99,
- "inicio": "2019-08-24",
- "fin": "2019-08-24",
- "prueba_inicio": "2019-08-24",
- "prueba_fin": "2019-08-24",
- "periodo_fecha_inicio": "2019-08-24",
- "periodo_fecha_fin": "2019-08-24",
- "fecha_proximo_cargo": "2019-08-24",
- "plan": {
- "id": "string",
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": 0,
- "monto_maximo": 0,
- "moneda": "MXN",
- "pais": "MEX",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}, - "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo"
}
}
], - "desde": 0,
- "hasta": 0,
- "registros_por_pagina": 25,
- "pagina_actual": 1,
- "ultima_pagina": 1,
- "total_pagina": 0,
- "total": 0
}
}
}
Ambiente sandbox
Ambiente productivo
cliente_id required | string Identificador de Cliente |
registros_por_pagina | integer [ 5 .. 100 ] Default: 25 Máximo de registros a regresar |
pagina | integer Número de página |
ordenar_por | string Enum: "creacion" "marca" "cliente_id" Valor que será usado como referencia en la búsqueda, podrá ser: creacion, nombre, estado, puede_suscribir |
orden | string Enum: "asc" "desc" Podrá ser de orden Ascendente (asc) o Descendente (desc) |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "tarjetas": {
- "data": [
- {
- "token": "string",
- "pan": "411111******1111",
- "terminacion": 0,
- "nombre": "string",
- "expiracion_mes": 1,
- "expiracion_anio": 0,
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "iin": 0,
- "marca": "visa",
- "cliente_id": "string",
- "default": true,
- "cargo_unico": true,
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z"
}
], - "desde": 0,
- "hasta": 0,
- "registros_por_pagina": 10,
- "pagina_actual": 1,
- "ultima_pagina": 1,
- "total_pagina": 0,
- "total": 0
}
}
}
Ambiente sandbox
Ambiente productivo
email required | string <email> Correo electrónico |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo"
}
}
}
Ambiente sandbox
Ambiente productivo
Crear Plan
nombre | string Nombre de Plan |
id_externo required | string Identificador único de Plan en plataforma del comercio |
monto required | number ( 0 .. 1000000000000000 ) Monto que será cobrado en la suscripción |
monto_variable | boolean Default: false Determina si podrán crearse suscripciones con montos variables |
monto_minimo | number Default: "0.00" Monto máximo para suscripcioones con monto variable |
monto_maximo | number <float> Default: "0.00" Monto mínimo para suscripcioones con monto variable |
pais | string = 3 characters Default: "MEX" Identificador de país de tres caracteres |
moneda required | string = 3 characters Identificador de moneda de tres caracteres de acuerdo al estándar ISO 4217 |
frecuencia required | integer >= 1 Determina cuantas veces debe repetirse el tipo de periodo para que se realice el siguiente cobro |
tipo_periodo required | string Enum: "dia" "semana" "mes" "anio" Puede ser "dia", "semana", "mes", o "anio" |
max_reintentos | integer [ 0 .. 10 ] Default: 3 Máximo de reintentos (uno por día) que serán realizados antes de cancelar una suscripción, en el caso por defecto se realizarán 3 reintentos, será posible realizar un máximo de 10 reintentos |
prueba_frecuencia | integer >= 1 Determina cuantas veces debe repetirse el tipo de periodo para que se designe el día de primer cobro (al término del periodo de prueba) |
prueba_tipo_periodo | string Enum: "dia" "semana" "mes" "anio" Puede ser "dia", "semana", "mes", o "anio" |
puede_duplicar | boolean Default: false Determina si podrán crearse múltiples suscripciones a un mismo plan por un mismo cliente |
max_suscripcion_usuario | integer Default: 1 Determina el número máximo de suscripciones, por usuario, a un mismo plan cuándo la bandera |
{- "nombre": "string",
- "id_externo": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": "0.00",
- "monto_maximo": "0.00",
- "pais": "MEX",
- "moneda": "MXN",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 3,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "plan": {
- "id": "string",
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": 0,
- "monto_maximo": 0,
- "moneda": "MXN",
- "pais": "MEX",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}
}
}
Ambiente sandbox
Ambiente productivo
registros_por_pagina | integer Máximo de registros a regresar |
pagina | integer Número de página |
ordenar_por | string Enum: "actualizacion" "creacion" "estado" "frecuencia" "id" "monto" "nombre" "puede_suscribir" "tipo_periodo" Valor que será usado como referencia en la búsqueda |
orden | string Enum: "asc" "desc" Podrá ser de orden Ascendente (asc) o Descendente (desc) |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "planes": {
- "data": [
- {
- "id": "string",
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": 0,
- "monto_maximo": 0,
- "moneda": "MXN",
- "pais": "MEX",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}
], - "desde": 0,
- "hasta": 0,
- "registros_por_pagina": 25,
- "pagina_actual": 1,
- "ultima_pagina": 1,
- "total_pagina": 0,
- "total": 0
}
}
}
Ambiente sandbox
Ambiente productivo
plan_id required | string Identificador de Plan |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "plan": {
- "id": "string",
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": 0,
- "monto_maximo": 0,
- "moneda": "MXN",
- "pais": "MEX",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}
}
}
Ambiente sandbox
Ambiente productivo
plan_id required | string Identificador de Plan |
Actualizar Plan
nombre | string Nombre de Plan |
monto | number Monto que será cobrado en la suscripción |
monto_variable | boolean Default: false Determina si podrán crearse suscripciones con montos variables |
monto_minimo | number Default: "0.00" Monto máximo para suscripcioones con monto variable |
monto_maximo | number <float> Default: "0.00" Monto mínimo para suscripcioones con monto variable |
frecuencia | integer >= 1 Determina cuantas veces debe repetirse el tipo de periodo para que se realice el siguiente cobro |
tipo_periodo | string Enum: "dia" "semana" "mes" "anio" Puede ser "dia", "semana", "mes", o "anio" |
max_reintentos | integer [ 0 .. 10 ] Máximo de reintentos (uno por día) que serán realizados antes de cancelar una suscripción, en el caso por defecto se realizarán 3 reintentos, será posible realizar un máximo de 10 reintentos |
estado | string Enum: "activo" "inactivo" Estado del plan ('activo' / 'inactivo') |
puede_suscribir | boolean Determina si podrán crearse nuevas suscripciones en un plan |
prueba_frecuencia | integer >= 1 Determina cuantas veces debe repetirse el tipo de periodo para que se designe el día de primer cobro (al término del periodo de prueba) |
prueba_tipo_periodo | string Enum: "dia" "semana" "mes" "anio" Puede ser "dia", "semana", "mes", o "anio" |
puede_duplicar | boolean Default: false Determina si podrán crearse múltiples suscripciones a un mismo plan por un mismo cliente |
max_suscripcion_usuario | integer Default: 1 Determina el número máximo de suscripciones, por usuario, a un mismo plan cuándo la bandera |
{- "nombre": "string",
- "monto": 0,
- "monto_variable": false,
- "monto_minimo": "0.00",
- "monto_maximo": "0.00",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "plan": {
- "id": "string",
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": 0,
- "monto_maximo": 0,
- "moneda": "MXN",
- "pais": "MEX",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}
}
}
Ambiente sandbox
Ambiente productivo
plan_id required | string Identificador de plan |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "plan": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "eliminacion": "2019-08-24T14:15:22Z"
}
}
}
Ambiente sandbox
Ambiente productivo
id_externo required | string Identificador único de Plan en plataforma del comercio |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "plan": {
- "id": "string",
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": 0,
- "monto_maximo": 0,
- "moneda": "MXN",
- "pais": "MEX",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}
}
}
Ambiente sandbox
Ambiente productivo
plan_id required | string Identificador de Plan |
registros_por_pagina | integer [ 5 .. 100 ] Default: 25 Máximo de registros a regresar |
pagina | integer Número de página |
ordenar_por | string Enum: "creacion" "cliente_id" Valor que será usado como referencia en la búsqueda, podrá ser: creacion, nombre, estado, puede_suscribir |
orden | string Enum: "asc" "desc" Podrá ser de orden Ascendente (asc) o Descendente (desc) |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "suscripciones": {
- "data": [
- {
- "id": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "plan_id": "string",
- "cliente_id": "string",
- "metodo_pago": "tarjeta",
- "metodo_pago_token": "string",
- "estado": "prueba",
- "monto": 129.99,
- "inicio": "2019-08-24",
- "fin": "2019-08-24",
- "prueba_inicio": "2019-08-24",
- "prueba_fin": "2019-08-24",
- "periodo_fecha_inicio": "2019-08-24",
- "periodo_fecha_fin": "2019-08-24",
- "fecha_proximo_cargo": "2019-08-24",
- "plan": {
- "id": "string",
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": 0,
- "monto_maximo": 0,
- "moneda": "MXN",
- "pais": "MEX",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}, - "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo"
}
}
], - "desde": 0,
- "hasta": 0,
- "registros_por_pagina": 25,
- "pagina_actual": 1,
- "ultima_pagina": 1,
- "total_pagina": 0,
- "total": 0
}
}
}
Ambiente sandbox
Ambiente productivo
plan_id required | string Identificador de Plan |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "suscripciones": [
- {
- "suscripcion_id": "string",
- "cliente_id": "string",
- "estado": "string",
- "actualizado": "2019-08-24T14:15:22Z"
}
]
}
}
Ambiente sandbox
Ambiente productivo
plan_id required | string Identificador de Plan |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "plan": {
- "id": "string",
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": 0,
- "monto_maximo": 0,
- "moneda": "MXN",
- "pais": "MEX",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}
}
}
Ambiente sandbox
Ambiente productivo
Crear Suscripción
plan_id required | string Id del plan al que será suscrito el usuario |
cliente_id required | string Id de cliente (Objeto Cliente->id) en plataforma T1pagos que será suscrito |
monto | number Monto que será cobrado en la suscripción, en caso de que la suscripción sea a un plan con monto variable |
metodo_pago required | string Value: "tarjeta" Define el tipo de pago que será usado en la suscripción, en cargos con tarjeta bancaria deberá ser ('tarjeta') |
metodo_pago_token required | string Token de método de pago seleccionado, en el caso de tarjeta se esperaría que el valor de "token_tarjeta" sea verificado antes de activar la suscripción |
inicio | string <date-time> Fecha de registro de suscripción en el Comercio, indica una fecha pasada que servirá como ancla, a partir de esa fecha (pasada) se realizará el cálculo de las siguientes fechas de renovación |
{- "plan_id": "string",
- "cliente_id": "string",
- "monto": 129.99,
- "metodo_pago": "tarjeta",
- "metodo_pago_token": "string",
- "inicio": "2019-08-24T14:15:22Z"
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "suscripcion": {
- "id": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "plan_id": "string",
- "cliente_id": "string",
- "metodo_pago": "tarjeta",
- "metodo_pago_token": "string",
- "estado": "prueba",
- "monto": 129.99,
- "inicio": "2019-08-24",
- "fin": "2019-08-24",
- "prueba_inicio": "2019-08-24",
- "prueba_fin": "2019-08-24",
- "periodo_fecha_inicio": "2019-08-24",
- "periodo_fecha_fin": "2019-08-24",
- "fecha_proximo_cargo": "2019-08-24",
- "plan": {
- "id": "string",
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": 0,
- "monto_maximo": 0,
- "moneda": "MXN",
- "pais": "MEX",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}, - "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo"
}
}
}
}
Ambiente sandbox
Ambiente productivo
registros_por_pagina | integer Máximo de registros a regresar |
pagina | integer Para realizar búsquedas filtrando por un rango de fechas |
ordenar_por | string Enum: "actualizacion" "cliente_id" "creacion" "estado" "fecha_proximo_cargo" "fin" "inicio" "metodo_pago" "metodo_pago_token" "periodo_fecha_fin" "periodo_fecha_inicio" "plan_id" "prueba_fin" "prueba_inicio" Valor que será usado como referencia en la búsqueda |
orden | string Enum: "asc" "desc" Podrá ser de orden Ascendente (asc) o Descendente (desc) |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "suscripciones": {
- "data": [
- {
- "id": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "plan_id": "string",
- "cliente_id": "string",
- "metodo_pago": "tarjeta",
- "metodo_pago_token": "string",
- "estado": "prueba",
- "monto": 129.99,
- "inicio": "2019-08-24",
- "fin": "2019-08-24",
- "prueba_inicio": "2019-08-24",
- "prueba_fin": "2019-08-24",
- "periodo_fecha_inicio": "2019-08-24",
- "periodo_fecha_fin": "2019-08-24",
- "fecha_proximo_cargo": "2019-08-24",
- "plan": {
- "id": "string",
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": 0,
- "monto_maximo": 0,
- "moneda": "MXN",
- "pais": "MEX",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}, - "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo"
}
}
], - "desde": 0,
- "hasta": 0,
- "registros_por_pagina": 25,
- "pagina_actual": 1,
- "ultima_pagina": 1,
- "total_pagina": 0,
- "total": 0
}
}
}
Ambiente sandbox
Ambiente productivo
suscripcion_id required | string Identificador de Suscripcion |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "suscripcion": {
- "id": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "plan_id": "string",
- "cliente_id": "string",
- "metodo_pago": "tarjeta",
- "metodo_pago_token": "string",
- "estado": "prueba",
- "monto": 129.99,
- "inicio": "2019-08-24",
- "fin": "2019-08-24",
- "prueba_inicio": "2019-08-24",
- "prueba_fin": "2019-08-24",
- "periodo_fecha_inicio": "2019-08-24",
- "periodo_fecha_fin": "2019-08-24",
- "fecha_proximo_cargo": "2019-08-24",
- "plan": {
- "id": "string",
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": 0,
- "monto_maximo": 0,
- "moneda": "MXN",
- "pais": "MEX",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}, - "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo"
}
}
}
}
Ambiente sandbox
Ambiente productivo
suscripcion_id required | string Identificador de Suscripcion |
Actualizar Suscripcion
metodo_pago | string Value: "tarjeta" Define el tipo de pago que será usado en la suscripción, en cargos con tarjeta bancaria deberá ser ('tarjeta') |
metodo_pago_token | string Token de método de pago seleccionado, en el caso de tarjeta se esperaría que el valor de "token_tarjeta" sea verificado antes de activar la suscripción |
estado | string Enum: "prueba" "activa" "pendiente" "suspendida" "cancelada" Estado de la suscripción (prueba, activa, pendiente, suspendida, cancelada) de acuerdo al catálogo de estados de una suscripción" |
{- "metodo_pago": "tarjeta",
- "metodo_pago_token": "string",
- "estado": "prueba"
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "suscripcion": {
- "id": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "plan_id": "string",
- "cliente_id": "string",
- "metodo_pago": "tarjeta",
- "metodo_pago_token": "string",
- "estado": "prueba",
- "monto": 129.99,
- "inicio": "2019-08-24",
- "fin": "2019-08-24",
- "prueba_inicio": "2019-08-24",
- "prueba_fin": "2019-08-24",
- "periodo_fecha_inicio": "2019-08-24",
- "periodo_fecha_fin": "2019-08-24",
- "fecha_proximo_cargo": "2019-08-24",
- "plan": {
- "id": "string",
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": 0,
- "monto_maximo": 0,
- "moneda": "MXN",
- "pais": "MEX",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}, - "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo"
}
}
}
}
Ambiente sandbox
Ambiente productivo
suscripcion_id required | string Identificador de Suscripcion |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "suscripcion": {
- "id": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "plan_id": "string",
- "cliente_id": "string",
- "metodo_pago": "tarjeta",
- "metodo_pago_token": "string",
- "estado": "prueba",
- "monto": 129.99,
- "inicio": "2019-08-24",
- "fin": "2019-08-24",
- "prueba_inicio": "2019-08-24",
- "prueba_fin": "2019-08-24",
- "periodo_fecha_inicio": "2019-08-24",
- "periodo_fecha_fin": "2019-08-24",
- "fecha_proximo_cargo": "2019-08-24",
- "plan": {
- "id": "string",
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "monto": 129.99,
- "monto_variable": false,
- "monto_minimo": 0,
- "monto_maximo": 0,
- "moneda": "MXN",
- "pais": "MEX",
- "frecuencia": 1,
- "tipo_periodo": "dia",
- "max_reintentos": 10,
- "estado": "activo",
- "puede_suscribir": true,
- "prueba_frecuencia": 1,
- "prueba_tipo_periodo": "dia",
- "puede_duplicar": false,
- "max_suscripcion_usuario": 1
}, - "cliente": {
- "id": "176f76a82670428898001dd5f031a57e",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "sexo": "masculino",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "nacimiento": "2019-08-24T14:15:22Z",
- "direccion": {
- "creacion": "2019-08-24T14:15:22Z",
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}, - "estado": "activo"
}
}
}
}
Ambiente sandbox
Ambiente productivo
registros_por_pagina | integer [ 5 .. 100 ] Máximo de registros a regresar |
pagina | integer Número de página |
ordenar_por | string Enum: "creacion" "id" Valor que será usado como referencia en la búsqueda |
orden | string Enum: "asc" "desc" Podrá ser de orden Ascendente (asc) o Descendente (desc) |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "eventos": {
- "data": [
- {
- "id": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "prueba": true,
- "estatus": "pendiente",
- "fecha_entrega": "2019-08-24T14:15:22Z",
- "codigo_http": 0,
- "mensaje_http": "string",
- "total_intentos": 0,
- "tipo_evento": "string",
- "data": { }
}
], - "desde": 0,
- "hasta": 0,
- "registros_por_pagina": 25,
- "pagina_actual": 1,
- "ultima_pagina": 1,
- "total_pagina": 0,
- "total": 0
}
}
}
Ambiente sandbox
Ambiente productivo
registros_por_pagina | integer [ 5 .. 500 ] Default: 25 Máximo de registros a regresar |
pagina | integer Número de página |
orden | string Default: "asc" Enum: "asc" "desc" Podrá ser de orden Ascendente (asc) o Descendente (desc |
estatus_conciliacion | string Enum: "false" "true" Estado de conciliación |
dia_conciliacion | string <date> Example: dia_conciliacion=2020-02-02 Día que operación fue conciliada |
fecha_inicio | string <date-time> Example: fecha_inicio=2020-04-01 12:00:00 Rango de fin de consulta, en formato YYYY-MM-DD HH:MM:SS, máximo 30 días |
fecha_fin | string <date-time> Example: fecha_fin=2020-04-02 12:00:00 Rango de fin de consulta, en formato YYYY-MM-DD HH:MM:SS, máximo 30 días |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "transacciones": {
- "data": [
- {
- "monto": "21.00",
- "cargo_id": "string",
- "conciliado": true,
- "procesador": "string",
- "afiliacion": "string",
- "autorizacion_id": "1234567",
- "fecha_conciliacion": "2020-02-02",
- "fecha_creacion": "2019-08-24T14:15:22Z",
- "order_id": "pedido_123456",
- "tipo_operacion": "string"
}
], - "desde": 0,
- "hasta": 0,
- "registros_por_pagina": 10,
- "pagina_actual": 1,
- "ultima_pagina": 1,
- "total_pagina": 0,
- "total": 0
}
}
}
Ambiente sandbox
Ambiente productivo
cargo_id required | string <uuid> Example: ef79007c-b47a-4816-b787-2d0c90d91a86 Identificador de la transacción |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "transaccion": {
- "monto": "21.00",
- "cargo_id": "string",
- "conciliado": true,
- "procesador": "string",
- "afiliacion": "string",
- "autorizacion_id": "1234567",
- "fecha_conciliacion": "2020-02-02",
- "fecha_creacion": "2019-08-24T14:15:22Z",
- "order_id": "pedido_123456",
- "tipo_operacion": "string"
}
}
}
Ambiente sandbox
Ambiente productivo
order_id required | string Example: pedido_ejemplo Identificador del pedido |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "transaccion": {
- "monto": "21.00",
- "cargo_id": "string",
- "conciliado": true,
- "procesador": "string",
- "afiliacion": "string",
- "autorizacion_id": "1234567",
- "fecha_conciliacion": "2020-02-02",
- "fecha_creacion": "2019-08-24T14:15:22Z",
- "order_id": "pedido_123456",
- "tipo_operacion": "string"
}
}
}
Ambiente sandbox
Ambiente productivo
Ejecutar evaluacion antifraude
monto required | number [ 0 .. 999999999999999 ] Monto de la transacción |
pais | string = 3 characters País la transacción de acuerdo al estándar ISO 3166-1 Alpha-3, con tres letras para representar el país. |
moneda | string = 3 characters Identificador de moneda de tres caracteres de acuerdo al estándar ISO 4217 |
descripcion | string [ 0 .. 250 ] characters Descripción breve de la transacción |
metodo_pago required | string Default: "tarjeta" Value: "tarjeta" Define el tipo de pago que será usado en la operacion |
object Objeto tarjeta, requerido si metodo_pago = tarjeta | |
required | object (Pedido) Objeto Pedido |
required | object |
object (PlanPagos) Objeto Plan de Pagos |
{- "monto": 999999999999999,
- "pais": "MEX",
- "moneda": "str",
- "descripcion": "string",
- "metodo_pago": "tarjeta",
- "tarjeta": {
- "nombre": "string",
- "pan": "4111111111111111",
- "expiracion_mes": 1,
- "expiracion_anio": 2000,
- "direccion": {
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}
}, - "pedido": {
- "id_externo": "string",
- "creacion": "2019-08-24T14:15:22Z",
- "direccion_envio": {
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90,
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string"
}, - "peso": 0,
- "articulos": [
- {
- "id_pedido": "string",
- "nombre_producto": "string",
- "descripcion_producto": "string",
- "sku": "string",
- "ean_upc": "string",
- "tipo_producto": "digital",
- "cantidad": 0,
- "precio_unitario": 0,
- "precio_total": 0,
- "otros": "string",
- "es_digital": true
}
], - "total_articulos": 0,
- "fecha_creacion": "2019-08-24T14:15:22Z",
- "fecha_entrega": "2019-08-24T14:15:22Z",
- "empresa_envio": "noventamin",
- "numero_guia": "string",
- "es_regalo": true,
- "monto_articulos": 0,
- "monto_envio": 0,
- "total_monto": 0,
- "device_fingerprint": "string",
- "ip_cliente": "192.168.0.1",
- "datos_comercio": {
- "1": "test string",
- "2": "another string"
}
}, - "cliente": {
- "id": "string",
- "id_externo": "string",
- "creacion_externa": "2019-08-24T14:15:22Z",
- "nombre": "string",
- "apellido_paterno": "string",
- "apellido_materno": "string",
- "email": "usuario@t1pagos.com",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "direccion": {
- "linea1": "string",
- "linea2": "string",
- "linea3": "string",
- "cp": "string",
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "municipio": "string",
- "ciudad": "string",
- "estado": "str",
- "pais": "str",
- "referencia_1": "string",
- "referencia_2": "string",
- "longitud": -90,
- "latitud": -90
}
}, - "PlanPagos": {
- "plan": "msi",
- "parcialidades": 6,
- "diferido": 0,
- "redime_puntos": false
}
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "evaluacion": {
- "id": "string",
- "orden_id": "string",
- "estatus": "aprobada-antifraude",
- "decision": "aceptar",
- "procesador": "cybersource",
- "descripcion": "string",
- "score": 0,
- "codigo": 0,
- "profile": "string",
- "resultados": [
- {
- "score": 0,
- "codigo": 0,
- "profile": "string",
- "resultado": "verde",
- "monitor": false,
- "procesador": "cybersource"
}
]
}
}
}
Ambiente sandbox
Ambiente productivo
registros_por_pagina | integer [ 5 .. 100 ] Default: 25 Máximo de registros a regresar |
pagina | integer Número de página |
ordenar_por | string Enum: "actualizacion" "creacion" Valor que será usado como referencia en la búsqueda |
orden | string Enum: "asc" "desc" Podrá ser de orden Ascendente (asc) o Descendente (desc) |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "evaluaciones": {
- "data": [
- {
- "id": "string",
- "orden_id": "string",
- "estatus": "aprobada-antifraude",
- "decision": "aceptar",
- "procesador": "cybersource",
- "descripcion": "string",
- "score": 0,
- "codigo": 0,
- "profile": "string"
}
], - "desde": 0,
- "hasta": 0,
- "registros_por_pagina": 10,
- "pagina_actual": 1,
- "ultima_pagina": 1,
- "total_pagina": 0,
- "total": 0
}
}
}
Ambiente sandbox
Ambiente productivo
uuid required | string Identificador de operación |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "evaluacion": {
- "id": "string",
- "orden_id": "string",
- "estatus": "aprobada-antifraude",
- "decision": "aceptar",
- "procesador": "cybersource",
- "descripcion": "string",
- "score": 0,
- "codigo": 0,
- "profile": "string",
- "resultados": [
- {
- "score": 0,
- "codigo": 0,
- "profile": "string",
- "resultado": "verde",
- "monitor": false,
- "procesador": "cybersource"
}
]
}
}
}
Ambiente sandbox
Ambiente productivo
cliente_id required | string <uuid> Identificador de Cliente |
Crear cuenta spei de cliente
pais required | string = 3 characters País la transacción de acuerdo al estándar ISO 3166-1 Alpha-3, con tres letras para representar el país. |
moneda required | string = 3 characters Identificador de país de tres caracteres de acuerdo al estándar ISO 4217 |
monto_minimo required | number >= 0 |
monto_maximo required | number >= 1 |
dias_expiracion required | integer >= 1 |
antifraude required | boolean |
{- "pais": "MEX",
- "moneda": "MXN",
- "monto_minimo": 1,
- "monto_maximo": 1000,
- "dias_expiracion": 1,
- "antifraude": true
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "cliente": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "creacion": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "recurso_uuid": "286c5189-4c45-4d4f-8c86-3ff9b1020f97",
- "tipo_recurso": "cliente",
- "moneda": "MXN",
- "receptor": "646",
- "plaza": "180",
- "prefijo": "1234",
- "centro_de_costos": "0000002",
- "digito_verificador": "3",
- "cuenta": "646180123400000023",
- "monto_minimo": 1,
- "monto_maximo": 1000,
- "dias_expiracion": 0,
- "antifraude": 0,
- "pais": "MEX"
}
}
}
Ambiente sandbox
Ambiente productivo
cliente_id required | string Identificador de Cliente |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "cuenta": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "creacion": "2019-08-24T14:15:22Z",
- "moneda": "MXN",
- "cuenta": "646180123400000023",
- "monto_minimo": 1,
- "monto_maximo": 1000,
- "pais": "MEX"
}
}
}
Ambiente sandbox
Ambiente productivo
cliente_id required | string Identificador de Cliente |
registros_por_pagina | integer [ 5 .. 100 ] Default: 25 Máximo de registros a regresar |
pagina | integer Número de página |
ordenar_por | string Enum: "creacion" "estado" Valor que será usado como referencia en la búsqueda, podrá ser: creacion, estado |
orden | string Enum: "asc" "desc" Podrá ser de orden Ascendente (asc) o Descendente (desc) |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "depositos": {
- "data": [
- {
- "id": "string",
- "estado": "completado",
- "monto": 129.99,
- "metodo_pago": "transferencia",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z"
}
], - "desde": 0,
- "hasta": 0,
- "registros_por_pagina": 25,
- "pagina_actual": 1,
- "ultima_pagina": 1,
- "total_pagina": 0,
- "total": 0
}
}
}
Ambiente sandbox
Ambiente productivo
id_referencia required | string Referencia de depósito |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "referencia": {
- "estatus": "pendiente",
- "monto": "100.00",
- "moneda": "MXN",
- "expirada": 0,
- "expiracion": "2019-08-24",
- "formato": "sears-sanborns",
- "metodo_pago": [
- "efectivo",
- "tarjeta",
- "tarjeta-departamental"
], - "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z"
}
}
}
Ambiente sandbox
Ambiente productivo
id_referencia required | string Referencia de depósito |
Actualizar estatus de pago de referencia
monto | number [ 1 .. 1000000000000000 ] Monto que fue pagado, debe de coincidir con el monto de la referencia |
moneda | string = 3 characters Default: "MXN" Identificador de moneda de tres caracteres de acuerdo al estándar ISO 4217 |
pago_id | string [ 1 .. 40 ] characters Identificador único de pago |
fecha_pago | string <date-time> Fecha de creación del objeto |
forma_pago | string Enum: "efectivo" "tarjeta" "tarjeta-departamental" Indica el método con los que se realizó el pago |
sucursal_id | string [ 1 .. 40 ] characters Identificador de sucursal de pago |
nombre_sucursal | string [ 1 .. 100 ] characters Nombre de sucursal donde se realizó el pago |
{- "monto": "100.00",
- "moneda": "MXN",
- "pago_id": "string",
- "fecha_pago": "2019-08-24T14:15:22Z",
- "forma_pago": "efectivo",
- "sucursal_id": "string",
- "nombre_sucursal": "string"
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "referencia": {
- "estatus": "pendiente",
- "monto": "100.00",
- "moneda": "MXN",
- "expirada": 0,
- "expiracion": "2019-08-24",
- "formato": "sears-sanborns",
- "metodo_pago": [
- "efectivo",
- "tarjeta",
- "tarjeta-departamental"
], - "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z"
}
}
}
Ambiente sandbox
Ambiente productivo
id_referencia required | string Referencia de depósito |
Actualizar estatus de pago de referencia
pago_id | string [ 1 .. 40 ] characters Identificador único de pago |
sucursal_id | string [ 1 .. 40 ] characters Identificador de sucursal de pago |
{- "pago_id": "string",
- "sucursal_id": "string"
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "referencia": {
- "estatus": "pendiente",
- "monto": "100.00",
- "moneda": "MXN",
- "expirada": 0,
- "expiracion": "2019-08-24",
- "formato": "sears-sanborns",
- "metodo_pago": [
- "efectivo",
- "tarjeta",
- "tarjeta-departamental"
], - "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z"
}
}
}
Ambiente sandbox
Ambiente productivo
Crear Recarga
cliente_id | string Id de cliente en plataforma T1pagos, este parámetro es opcional |
monto required | number Monto que será cobrado en la recarga, en caso de tiempo aire este monto es validado. |
required | object (Telefono) |
metodo_pago required | string Value: "tarjeta" Define el tipo de pago que será usado en la recarga, en cargos con tarjeta bancaria deberá ser ('tarjeta') |
metodo_pago_token required | string Token de método de pago seleccionado, se esperaría que el valor de "token_tarjeta" sea verificado antes de realizar la recarga |
tipo required | string Enum: "paquete" "tiempo_aire" Define el tipo de recarga que será usada. |
tipo_paquete | string Define el tipo de paquete que se aplicará, este paramétro es obligatorio cuando el tipo de recarga es paquete. |
{- "cliente_id": "string",
- "monto": 129.99,
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "metodo_pago": "tarjeta",
- "metodo_pago_token": "string",
- "tipo": "paquete",
- "tipo_paquete": "DS750"
}
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "recarga": {
- "id": "string",
- "cliente_id": "string",
- "numero_autorizacion_pago": "string",
- "numero_autorizacion_recarga": "string",
- "estatus": "aprobada",
- "monto": 129.99,
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "metodo_pago": "tarjeta",
- "metodo_pago_token": "string",
- "tipo": "paquete",
- "tipo_paquete": "DS750",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z"
}
}
}
Ambiente sandbox
Ambiente productivo
registros_por_pagina | integer Máximo de registros a regresar |
pagina | integer Para realizar búsquedas filtrando por un rango de fechas |
ordenar_por | string Enum: "creacion" "estatus" "metodo_pago" "metodo_pago_token" Valor que será usado como referencia en la búsqueda |
orden | string Enum: "asc" "desc" Podrá ser de orden Ascendente (asc) o Descendente (desc) |
{- "status": "success",
- "http_code": 200,
- "datetime": "2019-08-24T14:15:22Z",
- "timestamp": 0,
- "data": {
- "recargas": {
- "data": [
- {
- "id": "string",
- "cliente_id": "string",
- "numero_autorizacion_pago": "string",
- "numero_autorizacion_recarga": "string",
- "estatus": "aprobada",
- "monto": 129.99,
- "telefono": {
- "tipo": "no_definido",
- "codigo_pais": "string",
- "codigo_area": "string",
- "prefijo": "string",
- "numero": "5566778899",
- "extension": 0
}, - "metodo_pago": "tarjeta",
- "metodo_pago_token": "string",
- "tipo": "paquete",
- "tipo_paquete": "DS750",
- "creacion": "2019-08-24T14:15:22Z",
- "actualizacion": "2019-08-24T14:15:22Z"
}
], - "desde": 0,
- "hasta": 0,
- "registros_por_pagina": 25,
- "pagina_actual": 1,
- "ultima_pagina": 1,
- "total_pagina": 0,
- "total": 0
}
}
}