Manual Ipn

Embed Size (px)

Citation preview

Documento de especificacin tcnica IPN DineroMail

1

..::: Contenido1. Introduccin... 2 2. Descripcin general de IPN versin 2 2 3. Requisitos previos a la implementacin del sistema 2 4. Modificaciones al formulario de CARRITO/BOTON.. 3 5. Especificacin de la interfaz de notificacin.. 4 6. Especificacin de la interfaz de consulta... 6 7. Especificacin de la interfaz de reporte de operaciones. 8

21

..::: 1. IntroduccinPara aquellos casos en que los usuarios deseen recibir notificaciones de sus operaciones de manera automtica, DineroMail ha desarrollado IPN.

..::: 2. Descripcin general de IPNIPN v2 es una herramienta que permite a los usuarios vendedores de DineroMail recibir notificaciones de los ltimos movimientos de su cuenta y de ese modo informarse acerca del estado de cada uno de ellos. IPN permite asimismo que los usuarios vendedores puedan realizar consultas sobre los detalles de dichos movimientos. Los movimientos que se notificarn son los siguientes: - Operacin de Venta - Acreditacin de dinero - Cancelacin de una operacin de venta

..::: 3. Requisitos previos a la implementacin del sistema.Para poder implementar el IPN v2, es necesario que tu como usuario vendedor te identifiques mediante un cdigo alfanumrico de hasta veinte (20) caracteres para verificar cada operacin de intento de pago. Para ello, debers ingresar a la seccin Datos de usuario en tu cuenta de DineroMail, y dirigirte a Configurar IPN. A continuacin, ingresa la URL y una contrasea que slo t conozcas. De esta manera, slo t como usuario vendedor tendrs acceso al IPN 3 exclusivo que identifica a tu comercio.2

..::: 4. Modificaciones al formulario de CARRITO/BOTONDebe incluirse un parmetro (INPUT) del tipo oculto (HIDDEN) que contenga el identificador del intento de pago. El mismo ser llamado TRX_ID. Se adjunta un ejemplo de un botn a continuacin:

43

..::: 5. Especificacin de la interfaz de notificacin.En caso de crearse nuevas operaciones o de modificarse el estado de estas, DineroMail enviar por POST un parmetro NOTIFICACION que contiene un XML el cual contendr los identificadores de las operaciones que han sido modificadas. La estructura del XML se detalla a continuacin:

1 1 31548 1 XA5547

54

Descripcin de los elementos del documento XML de Notificacin ElementoNOTIFICACION

DescripcinElemento base del documento XML, dentro de este se encuentran todos los elementos de la notificacin. Indica el tipo de notificacin que se esta enviando. Contiene la coleccin de operaciones. Contiene el detalle de cada operacin, pueden ser una o ms operaciones. Tipo de notificacin que se enva. Este valor es el que proporciona el usuario como identificador nico de la operacin de pago.

TIPONOTIFICACION OPERACIONES OPERACIN

TIPO ID

Valores posibles del elemento TipoNotificacion1 Notificacin de cambio de estado de operaciones

Valores posibles del elemento Tipo1 Notificacin de cambio de estado de una venta de Carrito o Botn de Compras.

65

..::: 6. Especificacin de la interfaz de consultaSe enviar a una URL de DineroMail por POST un parmetro llamado DATA que contenga un XML de consulta, el cual contendr el nmero de cuenta del usuario y el detalle de las operaciones a consultar. Entre los datos que se deben enviar se encuentra el nmero de cuenta del usuario y la clave (a revisar en nombre del campo) ingresada en el sitio de DineroMail para la verificacin del usuario. La estructura del XML se detalla a continuacin:

31009 MIPASSWORD001 1 31548 XA5547

URL de consulta: https://argentina.dineromail.com/Vender/Consulta_IPN.asp 76

Descripcin de los elementos del documento XML de Consulta. ElementoREPORTE

DescripcinElemento base del documento XML, dentro de este se encuentran todos los elementos de la consulta. Nmero cuenta del usuario de Dineromail Elemento que contiene todos los elementos correspondientes a la consulta. Contiene los elementos correspondientes a la consulta en si. Clave ingresada por el usuario en Mi Cuenta para autenticar La identificacin del mismo. Tipo de consulta solicitada. Los valores posibles se detallan en La siguiente tabla. Elemento que agrupa todas las operaciones que se solicitan en la consulta. Este valor es el que proporciona el usuario como identificador nico de la operacin de pago. Es el valor ingresado en el punto 2.

NROCTA DETALLE

CONSULTA CLAVE

TIPO

OPERACIONES

ID

Valores posibles del elemento Tipo 1Consulta de estado de ventas de Carrito o Botn de Compras.

87

..::: 7. Especificacin de la interfaz de reporte de operaciones.La consulta realizada en el punto 4 por el negocio ser respondida mediante un XML de consulta, el cual contendr los detalles de las operaciones consultadas. La estructura del XML se detalla a continuacin:

98

Descripcin de los elementos del documento XML de Reporte. ElementoREPORTE ESTADOREPORTE DETALLE OPERACIONES OPERACIN ID FECHA ESTADO NUMTRANSACCION COMPRADOR EMAIL DIRECCION NOMBRE TELEFONO TIPODOC NUMERODOC COMENTARIO MONTO MONTONETO METODOPAGO MEDIOPAGO CUOTAS ITEMS ITEM DESCRIPCION MONEDA PRECIOUNITARIO CANTIDAD VENDEDOR TIPODOC NUMERODOC

DescripcinElemento base del documento XML, dentro de este se encuentran todos los elementos de la consulta. Este elemento devuelve el estado de la operacin de consulta. Los valores que puede devolver se especifican en la tabla siguiente. Elemento que contiene todos los elementos correspondientes al reporte. Contiene los elementos correspondientes a la consulta en si. Contiene la cantidad solicitada de operaciones que se requieren en la consulta del punto 4. Detalle de la operacin solicitada. Identificador nico ingresado en el punto 2. Fecha Estado actual de la operacin. Se describen los valores correspondientes en la tabla siguiente. Nmero de transaccin en DineroMail Contiene los elementos correspondientes a los datos del comprador. Direccin de mail del comprador. Direccin que ingresa el comprador como destino de la compra. Es opcional durante el pago de la operacin de compra Nombre completo del comprador Nmero de telfono del comprador Tipo de documento del comprador Nmero de documento del comprador Comentario que ingresa el comprador durante la compra. Es opcional. Monto total de la compra en pesos. Se utiliza punto (.) como separador de decimales. Monto neto de la operacin en pesos. Es el valor informado en MONTO con las comisiones aplicadas. Mtodo de pago seleccionado para pago de operacin. Se describen los valores correspondientes en la tabla siguiente. Medio con el cual se realiz el pago. Cantidad de cuotas con las que se realiz un pago con tarjeta de crdito. Contiene la coleccin de tems de la operacin. Elemento que contiene los elementos correspondientes a los datos de cada tem. Descripcin del tem. Tipo de moneda utilizada en el tem. Se describen los valores correspondientes en la tabla siguiente. Precio unitario del tem. Cantidad del tem. Contiene los elementos correspondientes a los datos del vendedor. Tipo de documento del vendedor Nmero de documento del vendedor

109

Valores posibles del elemento EstadoReporte1 2 3 4 5 6 7 8 CORRECTO XML MAL FORMADO NUMERO DE CUENTA INVALIDO (validacin de sintaxis) CLAVE INVALIDA (validacin de sintaxis) TIPO DE CONSULTA INVALIDO (validacin de sintaxis) ID OPERACIN INVALIDO (validacin de sintaxis) NUMERO DE CUENTA O CLAVE INVALIDO NO SE ENCONTRARON OPERACIONES A REPORTAR

Valores posibles del elemento Estado1 2 3 PENDIENTE DE PAGO ACREDITADO CANCELADO

Valores posibles del elemento MetodoPago1 2 3 4 FONDOS DINEROMAIL EFECTIVO MEDIANTE PAGOFACIL, RAPIPAGO, COBROEXPRESS O BAPROPAGO TARJETADECREDITO TRANSFERENCIA BANCARIA

Valores posibles del elemento Moneda1 2 PESO DLAR

1110