API Reference

Crear Cliente

Dar alta a un cliente en la plataforma

CREAR CLIENTE (POST)

Para crear un nuevo Cliente, se requiere enviar una petición de tipo POST. Se deberá agregar en el HEADER de la petición las credenciales necesarias para acceder al servicio, estas son comercioId y contrasena. Los cuales deberán contener los valores asignados por Operaciones en Línea al momento de generada su Afiliación.

Como parte del cuerpo del POST se deberán incluir los siguientes parámetros:


VALORESFORMATORESTRICCIONESDESCRIPCION
comercioIdNuméricoAdmite números sin espacios.Identificador del Comercio en OPENLINEA. Es un valor asignado.
(Header)
contraseñaAlfanuméricoAdmite letras y/o números sin espacios. No mayor a 12 caracteres.Clave de Acceso a la Terminal Virtual, configurado para su aplicación.
(Header)
VARIABLEFORMATORESTRICCIONESDESCRIPCION
NombreAlfanuméricoAdmite letras y/o números. No mayor a 20 caracteres.Nombre del Cliente
apellidosAlfanuméricoAdmite letras y/o números. No mayor a 20 caracteres.Apellidos del Cliente
calleAlfanuméricoAdmite letras y/o números. No mayor a 20 caracteres.Dirección del Cliente (se sugiere Calle y Numero)
coloniaAlfanuméricoAdmite letras y/o números. No mayor a 20 caracteres.Dirección del Cliente (se sugiere cualquier referencia que ayude a ubicar la dirección del Cliente)
ciudadAlfanuméricoAdmite letras y/o números. No mayor a 20 caracteres.Ciudad
estadoAlfanuméricoAdmite letras y/o números. No mayor a 20 caracteres.Estado
estadoIdAlfanuméricoAdmite letras. Solo debe contener 2 caracteresEstado del Tarjetahabiente
Ejemplo: Nuevo León = NL
Anexo 2 - Código de Estados para México
paisAlfanuméricoAdmite letras y/o números. No mayor a 20 caracteres.País
paisIdAlfanuméricoAdmite letras. Solo debe contener 2 caracteresPaís de Tarjetahabiente
Ejemplo: México = MX
Anexo 1 - Código de Países

Anexo 1 - Código de Países
codigoPostalNuméricoAdmite números sin espacios.Código Postal
emailAlfanuméricoAdmite letras y/o números sin espacios, se permiten los símbolos de arroba (), punto (.) y guiones (-), (_). No mayor a 20 caracteresDirección de Correo Electrónico para el envío de Notificaciones.
telefonoAlfanuméricoAdmite letras y/o números, se permiten los símbolos de paréntesis, corchetes y guiones.Número Telefónico

Valores de Retorno

VARIABLEFORMATORESTRICCIONESDESCRIPCION
tokenAlfanuméricoAdmite letras y/o números de longitud variableTOKEN mediante el cual se identifica de forma única al CLIENTE, este dato es requerido en el caso de operaciones de Actualización, Búsqueda y/o Eliminación de cliente.
idNuméricoAdmite números sin espacios.ID del comercio
NombreAlfanuméricoAdmite letras y/o números. No mayor a 20 caracteres.Nombre del Cliente
apellidosAlfanuméricoAdmite letras y/o números. No mayor a 20 caracteres.Apellidos del Cliente
calleAlfanuméricoAdmite letras y/o números. No mayor a 20 caracteres.Dirección del Cliente (se sugiere Calle y Numero)
coloniaAlfanuméricoAdmite letras y/o números. No mayor a 20 caracteres.Dirección del Cliente (se sugiere cualquier referencia que ayude a ubicar la dirección del Cliente)
ciudadAlfanuméricoAdmite letras y/o números. No mayor a 20 caracteres.Ciudad
estadoAlfanuméricoAdmite letras y/o números. No mayor a 20 caracteres.Estado
estadoIdAlfanuméricoAdmite letras. Solo debe contener 2 caracteresEstado del Tarjetahabiente
Ejemplo: Nuevo León = NL
Anexo 2 - Código de Estados para México
Dato indispensable para el esquema 3D Secure 2.0
paisAlfanuméricoAdmite letras y/o números. No mayor a 20 caracteres.País
paisIdAlfanuméricoAdmite letras. Solo debe contener 2 caracteresPaís de Tarjetahabiente
Ejemplo: México = MX
Anexo 1 - Código de Países
Dato indispensable para el esquema 3D Secure 2.0
codigoPostalNuméricoAdmite números sin espacios.Código Postal
emailAlfanuméricoAdmite letras y/o números sin espacios, se permiten los símbolos de arroba (), punto (.) y guiones (-), (_). No mayor a 20 caracteresDirección de Correo Electrónico para el envío de Notificaciones.
telefonoAlfanuméricoAdmite letras y/o números, se permiten los símbolos de paréntesis, corchetes y guiones.Número Telefónico
estatusNuméricoAdmite números sin espacios.Estatus de errores
fechaAltaAlfanuméricoAdmite letras y/o números de longitud variableFecha exacta en la cual se creó el cliente

📘

Crear Cliente Desarrollo

https://servertest.operacionesenlinea.com/OpenLineaRestAPI/api/clientes/

📘

Crear Cliente Produccion

https://servidorseguro.operacionesenlinea.com/OpenLineaRestAPI/api/clientes/