API T1pagos
API docs by Redocly

T1pagos (1.10.16.130624)

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.

Detalles adicionales

tarjeta

Operaciones con tarjetas bancarias

Crear nueva tarjeta

Authorizations:
bearerAuth
Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "nombre": "string",
  • "pan": "4111111111111111",
  • "cvv2": "123",
  • "expiracion_mes": 1,
  • "expiracion_anio": 9999,
  • "direccion": {
    },
  • "cliente_id": "string",
  • "default": true,
  • "cargo_unico": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar listado de Tarjetas

Authorizations:
bearerAuth
query Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar tarjeta

Authorizations:
bearerAuth
path Parameters
token
required
string

Identificador de tarjeta

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Actualiza datos de tarjeta

Authorizations:
bearerAuth
path Parameters
token
required
string

Identificador de tarjeta

Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "nombre": "string",
  • "expiracion_mes": 0,
  • "expiracion_anio": 0,
  • "cvv2": "123",
  • "direccion": {
    },
  • "cliente_id": "string",
  • "default": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Borrar tarjeta

Authorizations:
bearerAuth
path Parameters
token
required
string

Identificador de tarjeta

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

cargo

Operaciones de autorización y preautorización

Crear nuevo cargo

Authorizations:
bearerAuth
Request Body schema: application/json

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

uso_antifraude
boolean
Default: true

Permite saltarse la evaluación antifraude del comercio. Si se omite, se evaluará la transacción

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

Responses

Request samples

Content type
application/json
{
  • "monto": "100.00",
  • "pais": "MEX",
  • "moneda": "MXN",
  • "descripcion": "string",
  • "capturar": true,
  • "incluir_riesgo": true,
  • "uso_antifraude": true,
  • "metodo_pago": "tarjeta",
  • "tarjeta": {
    },
  • "credito": {
    },
  • "transferencia": {
    },
  • "pedido": {
    },
  • "cliente": {
    },
  • "PlanPagos": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar un cargo

Authorizations:
bearerAuth
path Parameters
cargo_id
required
string

Identificador de operación

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Cancelar un cargo antes del final del día.

Authorizations:
bearerAuth
path Parameters
cargo_id
required
string

Identificador de transacción de cargo

Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "monto": 0,
  • "orden_id": "string",
  • "cliente_id": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Reembolso de una transacción

Authorizations:
bearerAuth
path Parameters
cargo_id
required
string

Identificador de transacción de cargo

Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "monto": 0,
  • "orden_id": "string",
  • "cliente_id": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Captura de una transacción

Authorizations:
bearerAuth
path Parameters
cargo_id
required
string

Identificador de transacción de cargo

Request Body schema: application/json

Capturar una transacción

monto
required
number >= 1

Monto de la transacción

Responses

Request samples

Content type
application/json
{
  • "monto": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

cliente

Operaciones con Clientes

Crear un Cliente

Authorizations:
bearerAuth
Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "id_externo": "string",
  • "nombre": "string",
  • "apellido_paterno": "string",
  • "apellido_materno": "string",
  • "sexo": "string",
  • "email": "user@example.com",
  • "telefono": {
    },
  • "nacimiento": "2019-08-24T14:15:22Z",
  • "direccion": {
    },
  • "creacion_externa": "2019-08-24T14:15:22Z",
  • "device_fingerprint": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar listado de Clientes

Authorizations:
bearerAuth
query Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar un cliente por Id de cliente en comercio

Authorizations:
bearerAuth
path Parameters
id_externo
required
string

Id de cliente en comercio

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar un Cliente

Authorizations:
bearerAuth
path Parameters
cliente_id
required
string

Identificador de Cliente

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Actualizar Cliente

Authorizations:
bearerAuth
path Parameters
cliente_id
required
string

Identificador de Cliente

Request Body schema: application/json

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

email
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

Responses

Request samples

Content type
application/json
{
  • "nombre": "string",
  • "apellido_paterno": "string",
  • "apellido_materno": "string",
  • "sexo": "masculino",
  • "email": "usuario@t1pagos.com",
  • "telefono": {
    },
  • "nacimiento": "2019-08-24T14:15:22Z",
  • "direccion": {
    },
  • "device_fingerprint": "string",
  • "estado": "activo"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Borrar el registro de un Cliente

Authorizations:
bearerAuth
path Parameters
cliente_id
required
string

Identificador de Cliente

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar Suscripciones de Cliente

Authorizations:
bearerAuth
path Parameters
cliente_id
required
string

Identificador de Cliente

query Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar Tarjetas Asociadas a Cliente

Authorizations:
bearerAuth
path Parameters
cliente_id
required
string

Identificador de Cliente

query Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar un cliente por correo electrónico

Authorizations:
bearerAuth
path Parameters
email
required
string <email>

Correo electrónico

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

plan

Operaciones con Planes

Crear Plan de Suscripcion

Authorizations:
bearerAuth
Request Body schema: application/json

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 puede_duplicar está activa

Responses

Request samples

Content type
application/json
{
  • "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
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar listado de Planes

Authorizations:
bearerAuth
query Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar un Plan

Authorizations:
bearerAuth
path Parameters
plan_id
required
string

Identificador de Plan

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Actualizar Plan

Authorizations:
bearerAuth
path Parameters
plan_id
required
string

Identificador de Plan

Request Body schema: application/json

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 puede_duplicar está activa

Responses

Request samples

Content type
application/json
{
  • "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
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Borrar el plan

Authorizations:
bearerAuth
path Parameters
plan_id
required
string

Identificador de plan

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar un Plan por medio de id_externo

Authorizations:
bearerAuth
path Parameters
id_externo
required
string

Identificador único de Plan en plataforma del comercio

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Muestra lista de suscripciones al plan

Authorizations:
bearerAuth
path Parameters
plan_id
required
string

Identificador de Plan

query Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Cancelar usuarios suscritos a plan

Authorizations:
bearerAuth
path Parameters
plan_id
required
string

Identificador de Plan

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Cancelar Plan

Authorizations:
bearerAuth
path Parameters
plan_id
required
string

Identificador de Plan

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

suscripcion

Operaciones con Suscripciones

Crear Suscripción

Authorizations:
bearerAuth
Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "plan_id": "string",
  • "cliente_id": "string",
  • "monto": 129.99,
  • "metodo_pago": "tarjeta",
  • "metodo_pago_token": "string",
  • "inicio": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar listado de Suscripciones

Authorizations:
bearerAuth
query Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar una Suscripción

Authorizations:
bearerAuth
path Parameters
suscripcion_id
required
string

Identificador de Suscripcion

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Actualizar Suscripcion

Authorizations:
bearerAuth
path Parameters
suscripcion_id
required
string

Identificador de Suscripcion

Request Body schema: application/json

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"

Responses

Request samples

Content type
application/json
{
  • "metodo_pago": "tarjeta",
  • "metodo_pago_token": "string",
  • "estado": "prueba"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Cancelar Suscripción

Authorizations:
bearerAuth
path Parameters
suscripcion_id
required
string

Identificador de Suscripcion

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

notificacion

Operaciones con Notificaciones y Eventos

Consultar listado de Eventos generados en el sistema en las últimas 48 horas

Authorizations:
bearerAuth
query Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

conciliacion

Consulta de procesos de conciliación

Consultar listado de operaciones y su estado de conciliación

Authorizations:
bearerAuth
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar detalle de conciliación de transacción

Authorizations:
bearerAuth
path Parameters
cargo_id
required
string <uuid>
Example: ef79007c-b47a-4816-b787-2d0c90d91a86

Identificador de la transacción

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar detalle de conciliación usando el id de pedido

Authorizations:
bearerAuth
path Parameters
order_id
required
string
Example: pedido_ejemplo

Identificador del pedido

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

antifraude

Servicio antifraude

Evaluacion antifraude

Authorizations:
bearerAuth
Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "monto": 999999999999999,
  • "pais": "MEX",
  • "moneda": "str",
  • "descripcion": "string",
  • "metodo_pago": "tarjeta",
  • "tarjeta": {
    },
  • "pedido": {
    },
  • "cliente": {
    },
  • "PlanPagos": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar listado de evaluaciones

Authorizations:
bearerAuth
query Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar evaluación

Authorizations:
bearerAuth
path Parameters
uuid
required
string

Identificador de operación

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

cliente cuenta spei

Operaciones para cuentas spei tipo cliente

Crear una cuenta para cliente SPEI

Authorizations:
bearerAuth
path Parameters
cliente_id
required
string <uuid>

Identificador de Cliente

Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "pais": "MEX",
  • "moneda": "MXN",
  • "monto_minimo": 1,
  • "monto_maximo": 1000,
  • "dias_expiracion": 1,
  • "antifraude": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar listado de cuenta cliente

Authorizations:
bearerAuth
path Parameters
cliente_id
required
string

Identificador de Cliente

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar depositos de Cliente

Authorizations:
bearerAuth
path Parameters
cliente_id
required
string

Identificador de Cliente

query Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

deposito Sears - Sanborns

Operaciones sears -sanborns

Validar referencia de depósito

Authorizations:
bearerAuth
path Parameters
id_referencia
required
string

Referencia de depósito

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Registar un pago a una referencia

Authorizations:
bearerAuth
path Parameters
id_referencia
required
string

Referencia de depósito

Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "monto": "100.00",
  • "moneda": "MXN",
  • "pago_id": "string",
  • "fecha_pago": "2019-08-24T14:15:22Z",
  • "forma_pago": "efectivo",
  • "sucursal_id": "string",
  • "nombre_sucursal": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Cancelar un pago a una referencia

Authorizations:
bearerAuth
path Parameters
id_referencia
required
string

Referencia de depósito

Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "pago_id": "string",
  • "sucursal_id": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

recarga

Crear Recarga

Authorizations:
bearerAuth
Request Body schema: application/json

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.

Responses

Request samples

Content type
application/json
{
  • "cliente_id": "string",
  • "monto": 129.99,
  • "telefono": {
    },
  • "metodo_pago": "tarjeta",
  • "metodo_pago_token": "string",
  • "tipo": "paquete",
  • "tipo_paquete": "DS750"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}

Consultar listado de Recargas

Authorizations:
bearerAuth
query Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "http_code": 200,
  • "datetime": "2019-08-24T14:15:22Z",
  • "timestamp": 0,
  • "data": {
    }
}