API Reference

Venta

Procesa la Autorizacion de un Cargo

Para efectuar una VENTA con CARGO AL TARJETAHABIENTE, deberá enviar las siguientes variables mediante un mensaje SOAP al webservice previamente indicado.

Variables de Envío

VARIABLEFORMATORESTRICCIONESDESCRIPCION
comercioIdNuméricoAdmite números sin espacios.Identificador del Comercio en OPENLINEA. Es un valor asignado.
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.
modoCarácterAdmite una solo letraIdentificador del Modo de operación, P=Producción, A=Prueba con Respuesta Aprobada, R=Prueba con Respuesta Rechazada
montoNuméricoAdmite números un punto y dos decimales sin espacios, no se permite comas o signos de pesos.Monto a procesar total de la orden o
pedido calculado en su aplicación en base
a la selección de los servicios y/o productos del cliente
PropinaNuméricoAdmite números un punto y dos decimales sin espacios, no se permite comas o signos de pesos.Cantidad de propina que dio el cliente.
transaccionIdAlfanuméricoAdmite letras y/o números sin espacios. No mayor a 20 caracteres.Número de Pedido o identificador de la orden o pedido en la Tienda Virtual o Sistema de Ventas del comercio.
referenciaAlfanuméricoAdmite letras y/o números sin espacios. No mayor a 20 caracteres.Referencia libre de uso para su aplicación
tarjetaNuméricoAdmite solo 16 números sin espacios para Visa y MastercardNúmero de la Tarjeta de Crédito o Débito
tipoAlfanuméricoAdmite letras. Solo debe contener 2 caracteresEl Tipo de Tarjeta que se está enviando. Posibles valores:
CR = Tarjeta de Crédito
DB = Tarjeta de Débito
mesNuméricoAdmite solo números con 2 dígitosMes de Vencimiento de la Tarjeta de Crédito o Débito
anioNuméricoAdmite solo números con 4 dígitosAño de Vencimiento de la Tarjeta de Crédito o Débito
digitosNuméricoAdmite solo números con 3 dígitosDígitos Verificadores de la Tarjeta de Crédito
titularAlfanuméricoAdmite solo Letras, Espacios y PuntosNombre completo del Titular tal cual aparece en la Tarjeta de Crédito
dirIPAlfanuméricoAdmite Números y PuntosDirección IP de quién realiza la Operación, es decir del acceso a Internet del Cliente Final o Navegante.
AIDAlfanuméricoAlfanumérico de longitud variableApplication ID.
Identificador de la aplicacion para detectar que tipo de tarjeta esta siendo usada
TVRAlfanuméricoAlfanumérico de longitud variableTerminal Verification Results

Verificacion de la terminal para determinar si debe de aceptar, declinar o posponer una transaccion.
TSIAlfanuméricoAlfanumérico de longitud variableTransactions Status Information.

Status de la transaccion.
Puede ser "Aceptada", "En Espera" o "Cancelada"
APNAlfanuméricoAlfanumérico de longitud variableApplication Preferred Name.
ALAlfanuméricoAlfanumérico de longitud variableApplication Label
ARQCAlfanuméricoAlfanumérico de longitud variableAuthorization Request Cryptogram.

La peticion de autorizacion en 8-Bytes recibida de la tarjeta
diferimientoNuméricoAdmite solo números con 2 dígitosPara compras de promoción, el número de meses que se concederá al cliente para empezar a pagar (compre hoy pague después). Es un número de dos dígitos justificado con ceros a la izquierda. Ejemplo: 03 (pague dentro de 3 meses)
numeroPagosNuméricoAdmite solo números con 2 dígitosPara compras de promoción, el plazo en que se diluye el pago del cliente (compras a meses con o sin intereses). Es un número de dos dígitos justificado con ceros a la izquierda. Ejemplo: 06 (pague en seis mensualidades)
planNuméricoAdmite solo números con 2 dígitosPara compras de promoción, indica si ésta se hace con intereses o no al cliente. Valores posibles: 03 = Sin intereses 05 = Con intereses 07 = Sólo diferimiento inicial
deviceIdNuméricoAdmite números sin espacios.Identificador del dispositivo usado para la VENTA
subcomercioNuméricoAdmite números sin espacios.Identificador de Comercio perteneciente a algún Aliado previamente registrado en OpenLinea
versionAlfanuméricoAdmite letras y/o números sin espacios. No mayor a 20 caracteres.Version de SDK (En caso de uso)

Variables de Retorno

La petición regresara una respuesta en formato SOAP conteniendo la siguiente información:

VARIABLEFORMATORESTRICCIONESDESCRIPCION
comercioIdNuméricoNúmeros sin espaciosIdentificador del Comercio en OPENLINEA. Es un valor asignado.
terminalIDNuméricoNúmeros sin espaciosIdentificador de la terminal usada en la transaccion.
transaccionIdAlfanuméricoLetras y/o números sin espacios. No mayor a 20 caracteresNúmero de Pedido o identificador de la orden o pedido en la Tienda Virtual o Sistema de Ventas del comercio.
transaccionIDAlfanuméricoLetras y/o números sin espacios. No mayor a 20 caracteres.Número de Pedido o identificador de la orden o pedido en la Tienda Virtual o Sistema de Ventas del comercio.
fechaTransaccionAlfanuméricoRepresentación de fecha con formato MM/DD/AAFecha procesamiento de la Operación
horaTransaccionAlfanuméricoRepresentación de hora con formato HH:MM:SSHora de procesamiento de la Operación.
montoNuméricoAdmite números, un punto y dos decimales sin espacios, no se permite comas o signos de pesos.Monto a procesar total de la orden o pedido calculado en su aplicación en base a la selección de los servicios y/o productos del cliente.
referenciaNuméricoAlfanumérico de longitud variableReferencia libre de uso para su aplicación
numeroControlNuméricoAlfanumérico de longitud variableCodigo retornado de identificador de transaccion
codigoRespuestaNuméricoNúmeros sin espacios.Se regresa los siguientes valores:
0 = Aprobada,
1 = Rechazada
procReturnMsgAlfanuméricoAlfanumérico de 1 a 10 caracteresCódigo retornado por el procesador de la tarjeta.
ccErrCodeNuméricoNumérico de longitud variable. No mayor a 4 caracteres.Código devuelto por la Institución Financiera
ccReturnMsgAlfanuméricoAlfanumérico de longitud variableTexto específico retornado por el procesador de pagos
codigoAprobacionAlfanuméricoAlfanumérico de longitud variableCódigo de Aprobación Bancaria, típicamente con 6 Dígitos
afiliacionAlfanuméricoAlfanumérico de longitud variableNumero de afiliación con la que es ejecutada la Operación.
afiliacionEmpresaAlfanuméricoAlfanumérico de longitud variableNumero de afiliación de la empresa con la que es ejecutada la Operación.
tipoOperacionAlfanuméricoAlfanumérico de longitud variable
tarjetaTipoAlfanuméricoAlfanumérico de longitud variableTipo de tarjeta con la cual se realizo el cargo
tarjetaMarcaAlfanuméricoAlfanumérico de longitud variablemarca de la tarjeta con la cual se realizo el cargo
bancoEmisorAlfanuméricoAlfanumérico de longitud variableNombre del banco encargado de realizar el cargo
auth_resultAlfanuméricoAlfanumérico de longitud variableResultado de la operacion
referred_cardNuméricoAdmite solo 16 números sin espacios para Visa y MastercardTarjeta a la que hace referencia la venta
AIDAlfanuméricoAlfanumérico de longitud variableIdentificador de la aplicacion para detectar que tipo de tarjeta esta siendo usada
TVRAlfanuméricoAlfanumérico de longitud variableEs la verificacion de la terminal para determinar si debe de aceptar, declinar o posponer una transaccion (Terminal Verification Results)
TSIAlfanuméricoAlfanumérico de longitud variableStatus de la transaccion.
Puede ser "Aceptada", "En Espera" o "Cancelada"

(Transaction Status Indicator)
APNAlfanuméricoAlfanumérico de longitud variableConexion a la red de datos de tu operador
ALAlfanuméricoAlfanumérico de longitud variableVariable que registra que la tarjeta sea valida
ARQCAlfanuméricoAlfanumérico de longitud variableLa peticion de autorizacion en 8-Bytes recibida de la tarjeta

(Authorization Request Cryptogram)