Download Tabla de parámetros
Document related concepts
no text concepts found
Transcript
ALTAS VÍA HTTP (TRADICIONAL) PAGOS PYMES Instructivo para la implementación de comercios Estimado Cliente, Recordaremos a modo introductorio, que dentro del servicio de PagosPyme, Ud. cuenta con la posibilidad de dar de alta usuarios, documentos y/o cupones de e-pago fácil, a través de distintos medios: • • Vía Web, en forma manual ingresando cada uno de los datos. Vía Correo Electrónico, enviando la información relacionada dentro de archivos, por email. El presente manual le permitirá, si lo desea, emplear un tercer modo: • Vía http, haciendo llegar la información mediante un formulario enviado a una URL específica de Pagos Pyme. Cordialmente, CajadePagos.com PagosPymes – Altas Vía http Versión 2.10 2 Contenidos Unidad 1 Unidad 2 Unidad 3 Unidad 4 Unidad 5 Anexo A Introducción Alta de Usuarios Alta de Documentos Generación de cupones de PagoFacil Informe de resultado de las operaciones Ejemplos de llamadas PagosPymes – Altas Vía http Versión 2.10 Página 4 Página 5 Página 7 Página 8 Página 9 Página 10 3 Unidad 1: Introducción La información se envía a PagosPyme mediante la llamada al sitio, enviando junto con la misma la información del usuario, el documento a pagar y/o algunos datos del cupón a generar. Los parámetros se deben enviar mediante el método POST a la URL: http://clientes.pagospyme.com/autogen/v2/receptor.php Por seguridad, además se pedirá que el cliente informe cuales son los posibles dominios / IPs desde los cuales se debe autorizar esta petición. Como requisito indispensable se debe enviar un parámetro que identifica al comercio que está haciendo la petición. Opcionalmente, aunque recomendado, se puede enviar un código mediante el cual el comercio podrá identificar la llamada para luego saber si fue exitosa o hubo algún tipo de error en la misma; y también una URL (perteneciente también al comercio) a la cual se enviará la información sobre el resultado de la operación. Parámetro v_gen_codcomercio v_gen_codoperacion v_gen_urlresultado • Formato Alfanumérico (hasta 8 caracteres) Alfanumérico (Hasta 16 caracteres) Alfanumérico (Hasta 500 caracteres) Requerido Si - v_gen_codcomercio: Identificación del comercio otorgada por PagosPyme precedida por una letra P. Ejemplo: Codigo de cliente 00001 → P00001 • v_gen_codoperacion: Código identificación de la transacción. • v_gen_urlresultado: URL del comercio donde se informará el resultado de la operación PagosPymes – Altas Vía http Versión 2.10 4 Unidad 2: Alta de usuarios El alta de usuarios requiere que se envíen además de los parámetros antes mencionados, otros correspondientes al usuario que se desea subir al sistema. Parámetro v_usu_numcliente v_usu_nombrecliente v_usu_tipoidentificacion v_usu_nroidentificacion v_usu_direccion v_usu_localidad v_usu_provincia v_usu_codpostal v_usu_telfijo1 v_usu_telfijo2 v_usu_celular1 v_usu_celular2 v_usu_emailusuario v_usu_emailusuario2 Formato Alfanumérico (Hasta 20 caracteres) Alfanumérico (Hasta 20 caracteres) Numérico (2 dígitos) Numérico (Hasta 11 dígitos) Alfanumérico (Hasta 100 caracteres) Alfanumérico (Hasta 100 caracteres) Numérico (2 dígitos) Alfanumérico (Hasta 6 caracteres) Alfanumérico (Hasta 20 caracteres) Alfanumérico (Hasta 20 caracteres) Alfanumérico (Hasta 20 caracteres) Alfanumérico (Hasta 20 caracteres) Alfanumérico (Hasta 50 caracteres) Alfanumérico (Hasta 50 caracteres) Requerido Si Si* - *: Solo en caso de que se deba dar de alta el usuario • v_usu_numcliente: Nro. De cliente del comprador • v_usu_nombrecliente: Nombre del comprador • v_usu_tipoidentificación: Código de identificación del comprador definido por la siguiente tabla: Código DNI CI • v_usu_tipoidentificación Descripción Documento Nacional de Identidad Cédula de identidad v_usu_nroidentificación: Nro de identificación / Documento del comprador especificado por el campo v_usu_tipoidentificación. • v_usu_dirección: Dirección del comprador. • v_usu_localidad: Localidad de la dirección del comprador • v_usu_provincia: Provincia de la dirección del comprador, definida por la siguiente tabla: v_usu_provincia 1 2 3 4 5 6 Buenos Aires Córdoba La Pampa Santa Fe Mendoza San Luís 7 8 9 10 11 12 Chaco Catamarca Chubut Corrientes Entre Ríos Formosa 13 14 15 16 17 18 Jujuy Misiones Neuquén Río Negro Salta San Juan PagosPymes – Altas Vía http Versión 2.10 19 20 21 22 23 24 Santa Cruz Sgo. Del Estero Tierra del Fuego Tucumán La Rioja CABA 5 • v_usu_codpostal: Código postal del comprador • v_usu_telfijo1: Teléfono fijo del comprador • v_usu_telfijo2: Teléfono fijo alternativo del comprador • v_usu_celular1: Teléfono celular del comprador • v_usu_celular2: Teléfono celular alternativo del comprador • v_usu_emailusuario: Dirección de email del comprador • v_usu_emailusuario2: Dirección de email alternativa del comprador PagosPymes – Altas Vía http Versión 2.10 6 Unidad 3: Alta de documentos Para el alta de documentos se sigue el mismo procedimiento que con los usuarios. Se agregan los siguientes parámetros: Parámetro v_doc_tipodocumento v_doc_nrodocumento v_doc_fechaemision v_doc_fechavto v_doc_diasvto2 v_doc_importeneto v_doc_recargovto2 v_doc_observaciones Formato Alfanumérico (3 caracteres) Alfanumérico (Hasta 20 caracteres) Numérico (8 dígitos) Numérico (8 dígitos) Numérico (2 dígitos) Numérico (8 dígitos) Numérico (6 dígitos) Alfanumérico (Hasta 100 caracteres) Requerido Si Si Si* Si* Si** Si* - *: Solo en caso de que se deba dar de alta el documento **: Solo en caso de que se ingrese el importe de recargo (v_doc_recargovto2) • v_doc_tipodocumento: Código del tipo de documento por el cual se envía el cupón definido por la siguiente tabla: v_doc_tipodocumento CÓDIGO FAA FAB FAC FAE RCP RCB DON APT CUO PED SLD • DESCRIPCIÓN Factura tipo “A” Factura tipo “B” Factura Tipo “C” Factura Tipo “E” Recibo provisorio Recibo Donación Aporte Cuota Pedido Saldo v_doc_nrodocumento: Nro de documento por el cual se envía el cupón • v_doc_fechaemision: Fecha de emisión del documento por el cual se envía el cupón. Formato yyyyMMdd: Ej.: 20/06/2010 = 20100620 • v_doc_fechavto: Fecha de vencimiento del documento por el cual se envía el cupón. Formato yyyyMMdd: Ej.: 20/06/2010 = 20100620 • v_doc_diasvto2: Dias adicionados a la fecha de vto. que resultan en la 2da fecha de vto. Formato dd. Ej.: 10 • v_doc_importeneto: Importe final del documento en formato [entero + 2 decimales obligatorios]. Ej.: $ 200.45 = 20045 o bien $ 100 = 10000 • v_doc_recargovto2: Importe adicionado al importe del documento que resulta en el importe con recargo a cobrar luego de pasado el 1er vencimiento. Formato [entero + 2 decimales obligatorios]. Ej.: $ 3,30 = 330 PagosPymes – Altas Vía http Versión 2.10 7 • v_doc_observaciones: Observaciones opcionales para el documento Consideraciones: Para poder dar de alta exitosamente un documento se requiere conocer el número de cliente al cual será agregado. En caso de que el cliente ya esté dado de alta, solo será necesario agregar a la llamada el parámetro v_usu_numcliente (número de cliente). En caso contrario se acepta que se envíen en la misma petición todos los datos del cliente junto con los del documento a subir. En caso de no encontrarse el cliente en el sistema ni dentro de los parámetros recibidos, la operación resultará fallida. PagosPymes – Altas Vía http Versión 2.10 8 Unidad 4: Generación de cupones de PagoFacil En el caso de cupones de PagoFácil los parámetros que se agregan son los siguientes: Parámetro v_cup_monto v_cup_recargovto2 v_cup_fechavto v_cup_diasvto2 v_cup_emailenvio v_cup_modogeneracion • Formato Numérico (8 dígitos) Numérico (6 dígitos) Numérico (8 dígitos) Numérico (Hasta 2 dígitos) Alfanumérico (Hasta 50 caracteres) Alfanumeración (3 caracteres) Requerido Si Si - v_cup_monto: Importe del cupón en formato [entero + 2 decimales obligatorios]. Ej.: $ 200.45 = 20045 o bien $ 100 = 10000 • v_cup_recargovto2: Importe adicionado al parámetro v_cup_monto que resulta en el importe con recargo a cobrar luego de pasado el 1er vencimiento. Formato [entero + 2 decimales obligatorios]. Ej.: $ 3,30 = 330 • v_cup_fechavto: Fecha de vencimiento del documento por el cual se envía el cupón. Formato yyyyMMdd: Ej.: 20/06/2010 = 20100620 • v_cup_diasvto2: Dias adicionados a la fecha de vto. que resultan en la 2da fecha de vto. Formato dd. Ej.: 10 • v_cup_emailenvio: Dirección electrónica del cliente en caso de que se desee enviar el cupón por email. Si la misma no se especifica, el cupón no se enviará por email y el cliente deberá mostrarlo en pantalla para su impresión. • v_cup_modogeneracion: Modo de generación del cupón. Determina la respuesta a la llamada. Debe ser uno de los siguientes valores: (Default: cup) Valor cup img cod Descripción Cupón en HTML con el formato estandar preestablecido de CajaDePagos. URL de la imagen del código de barras. Cadena de 42 dígitos correspondiente al código de barras. Consideraciones: Al momento de generar un nuevo cupón de PagoFacil es necesario conocer el dato del usuario y del documento por el cual se generará el mismo, por lo que es requisito indispensable enviar además*: • • • v_usu_numcliente v_doc_tipodocumento v_doc_nrodocumento * Se omiten los parámetros explicados en la unidad 1 ya que se pueden encontrar en toda llamada. Como en el caso del alta de documentos, se acepta que se envíen junto con la misma llamada los datos completos del usuario y/o documento. La falta de cualquiera de estos parámetros ocasionará que la generación del cupón será fallida. PagosPymes – Altas Vía http Versión 2.10 9 Unidad 5: Informe de resultado de las operaciones El resultado de todas las operaciones se informan al comercio a una URL enviada junto con la petición (v_gen_urlresultado) usando el método POST. Aquí se informarán los posibles errores detectados en la llamada, así como también si los datos enviados pudieron ser cargados correctamente. Los nombres de los parámetros enviados al comercio son: Nombre v_fecha v_gen_codoperacion v_usu_resultado v_doc_resultado v_cup_resultado v_observaciones v_datoadic Descripción Fecha y hora de la transacción (Formato dd/MM/yyyy HH:mm:ss) Cod. de operación provisto por el comercio 1: Usuario dado de alta. 0: Usuario existente. -1: Error en alta. 1: Documento dado de alta. 0: Documento existente. -1: Error en alta. 1: Cupón generado. 0: Cupón existente. -1 Error en generación. Descripción del error (en caso de haber alguno) Campo de observaciones adicional Ejemplo de respuesta enviada: Llamadas correctas (sin errores): Nombre v_fecha v_gen_codoperacion v_usu_resultado v_doc_resultado v_cup_resultado v_observaciones v_datoadic Valor 01/01/2009 18:25:43 1123455AB 0 0 1 Nombre v_fecha v_gen_codoperacion v_usu_resultado v_doc_resultado v_cup_resultado v_observaciones v_datoadic Valor 01/01/2009 18:25:43 1123456AB 1 1 1 Llamada con errores: Nombre v_fecha v_gen_codoperacion v_usu_resultado v_doc_resultado v_cup_resultado v_observaciones v_datoadic Valor 01/01/2009 18:26:21 1123457AB 0 0 -1 No se encuentra el documento A123456 PagosPymes – Altas Vía http Versión 2.10 10 Anexo A: Ejemplos de llamadas Numero de comercio: P0001 Alta de un nuevo usuario: Parámetros enviados: Parámetro v_gen_codcomercio v_gen_codoperacion v_usu_numcliente v_usu_nombrecliente Valor P00001 00000112334Z S0001 Juan Pérez Alta de un nuevo usuario – Con más detalles: Parámetros enviados: Parámetro v_gen_codcomercio v_gen_codoperacion v_gen_urlresultado v_usu_numcliente v_usu_nombrecliente v_usu_tipoidentificacion v_usu_nroidentificacion v_usu_direccion v_usu_localidad v_usu_telfijo1 v_usu_emailusuario Valor P00001 00000112335Z http://www.dominio.com/respuesta.php S0002 Juan Martínez DNI 12345678 Av. Corrientes 1628 1er Subsuelo C.A.B.A 011-5217-9410 [email protected] Alta de un documento: Factura A10000121521 con fecha de emisión 25/03/2009, fecha de vencimiento 15/04/2009 por un importe de $150. Observaciones: “Por compra de cartucho” Parámetros enviados: Parámetro v_gen_codcomercio v_gen_codoperacion v_gen_urlresultado v_usu_numcliente v_doc_tipodocumento v_doc_nrodocumento v_doc_fechaemision v_doc_fechavto v_doc_importeneto v_doc_observaciones Valor P00001 00000112336Z http://www.dominio.com/respuesta.php S0002 FAA 10000121521 20090325 20090415 15000 Por compra de cartucho Alta de un documento (con 2da fecha de vto.): Factura A10000121521 con fecha de emisión 25/03/2009, fecha de vencimiento 15/04/2009, fecha de 2do vencimiento 30/04/2009. Importe de $150, Importe con recargo de $200,50. Observaciones: “Repuesto cortina” Parámetros enviados: Parámetro v_gen_codcomercio v_gen_codoperacion v_gen_urlresultado Valor P00001 00000112336Z http://www.dominio.com/respuesta.php PagosPymes – Altas Vía http Versión 2.10 11 v_usu_numcliente v_doc_tipodocumento v_doc_nrodocumento v_doc_fechaemision v_doc_fechavto v_doc_diasvto2 v_doc_importeneto v_doc_recargovto2 v_doc_observaciones S0002 FAA 10000121521 20090325 20090415 15 15000 5050 Repuesto cortina Alta de usuario y documento simultáneos: Se da de alta al usuario S0003, junto con una factura C 10000215478 con fecha de emisión 30/05/2009 y fecha de vencimiento 20/06/2009 por un importe de $245,50. Parámetros enviados: Parámetro v_gen_codcomercio v_gen_codoperacion v_gen_urlresultado v_usu_numcliente v_usu_nombrecliente v_usu_tipoidentificacion v_usu_nroidentificacion v_doc_tipodocumento v_doc_nrodocumento v_doc_fechaemision v_doc_fechavto v_doc_importeneto Valor P00001 00000112337Z http://www.dominio.com/respuesta.php S0003 José Pérez DNI 12345679 FAC 10000215478 20090530 20090620 24550 Generación de cupones de pago - Información básica: Parámetros enviados: Parámetro v_gen_codcomercio v_gen_codoperacion v_gen_urlresultado v_usu_numcliente v_doc_tipodocumento v_doc_nrodocumento v_cup_monto v_cup_fechavto Valor P00001 00000112338Z http://www.dominio.com/respuesta.php S0003 FAC 10000215478 24550 20091212 Alta de usuario, documento y generación de cupón en la misma llamada Parámetros enviados: Parámetro v_gen_codcomercio v_gen_codoperacion v_gen_urlresultado v_usu_numcliente v_usu_nombrecliente v_doc_tipodocumento v_doc_nrodocumento v_doc_fechaemision v_doc_fechavto Valor P00001 00000112339Z http://www.dominio.com/respuesta.php S0004 José Martínez FAC 10000515475 20090601 20090621 PagosPymes – Altas Vía http Versión 2.10 12 v_doc_importeneto v_cup_monto v_cup_fechavto v_cup_emailenvio v_cup_modogeneracion 10050 10050 20090730 [email protected] cod Alta de usuario, documento y generación de cupón en la misma llamada (con 2do vencimiento) Parámetros enviados: Parámetro v_gen_codcomercio v_gen_codoperacion v_gen_urlresultado v_usu_numcliente v_usu_nombrecliente v_doc_tipodocumento v_doc_nrodocumento v_doc_fechaemision v_doc_fechavto v_doc_diasvto2 v_doc_importeneto v_doc_recargovto2 v_cup_monto v_cup_recargovto2 v_cup_fechavto v_cup_diasvto2 v_cup_emailenvio v_cup_modogeneracion Valor P00001 00000112339Z http://www.dominio.com/respuesta.php S0004 José Martínez FAC 10000515475 20090601 20090621 7 10050 4950 10050 4950 20090730 30 [email protected] img PagosPymes – Altas Vía http Versión 2.10 13