VibeFox eWAY for PrestaShop — Ayuda

Requisitos

PrestaShop: 8.0 a 9.x.

PHP: 8.0 o posterior. El módulo no se instala en versiones anteriores de PHP.

Moneda de la tienda: AUD, NZD, SGD, HKD o MYR. Para otras monedas del carrito, el método de pago no se muestra en el proceso de compra. El pago se cobra en la moneda del carrito.

Cuenta de eWAY: necesitas una cuenta de comerciante de eWAY con acceso a Rapid API y su clave y contraseña de Rapid API, que se obtienen en MyeWAY en Settings, API Key. Para las pruebas necesitas una cuenta sandbox de eWAY con su propia clave y contraseña. Las claves de sandbox y de producción son distintas. No hay que configurar nada en eWAY: la URL de retorno se envía con cada pago.

Clave de licencia de VibeFox: se compra en vibefox.net. Una clave funciona en un solo dominio.

Instalación

1. En el back office ve a Modules > Module Manager y haz clic en Upload a module. Elige el archivo ZIP del módulo.

2. Cuando termine la subida, haz clic en Configure, o busca más tarde VibeFox eWAY Payment Gateway en la lista de módulos y haz clic en Configure.

3. Introduce tu clave de licencia de VibeFox en License key, en el bloque de licencia de la parte superior de la página Configure, y haz clic en Activate (véase Clave de licencia).

4. Introduce tu clave y contraseña de API de sandbox, deja activado Sandbox Mode, activa Enable/Disable, haz clic en Save y realiza un pedido de prueba.

5. Introduce tu clave y contraseña de API de producción, desactiva Sandbox Mode y haz clic en Save.

6. Opcionalmente, añade la URL de cron que aparece en la página Configure a las tareas cron de tu servidor (véase Configuración).

Al instalarse, el módulo crea el estado de pedido eWAY payment on hold. PrestaShop ofrece un nuevo módulo de pago para todas las monedas, países y grupos de clientes. Puedes limitarlos en Payment > Preferences.

Configuración

Todos los ajustes están en la página del módulo: Modules > Module Manager > VibeFox eWAY Payment Gateway > Configure. Cada sección tiene su propio botón Save, que guarda toda la página. Encima de los campos, una insignia muestra el modo: SANDBOX — payments go to the eWAY sandbox, no real money is charged. o LIVE — real payments are taken with the live API key. La página avisa cuando faltan la clave y la contraseña de API del modo actual (en ese caso el método de pago no se muestra en el proceso de compra) y cuando la moneda predeterminada de la tienda no es compatible con eWAY.

eWAY

Enable/Disable: Enable eWAY Payment Gateway activa o desactiva el método de pago. Predeterminado: desactivado.

Title: el nombre del método de pago que ven los clientes en el proceso de compra. También es el nombre del método de pago guardado en el pedido. Predeterminado: Credit Card (eWAY). Obligatorio.

Description: el texto que se muestra debajo del método de pago en el proceso de compra. Predeterminado: Pay securely using your credit card via eWAY. You will be redirected to the eWAY secure payment page.

Credenciales de API

La clave y la contraseña de Rapid API están en MyeWAY, en Settings, API Key. eWAY tiene guías para las claves de producción y de sandbox, enlazadas en esta sección. Las claves de sandbox y de producción son distintas.

Sandbox Mode: los pagos van al sandbox de eWAY con la clave y la contraseña de sandbox. No se cobra dinero real. Predeterminado: activado. Desactívalo para cobrar pagos reales con la clave de producción. Mientras está activado, los clientes ven Test mode: no real payment is taken. debajo del método de pago.

Live API Key: la clave de Rapid API de tu cuenta de eWAY de producción.

Live API Password: la contraseña de Rapid API de tu cuenta de eWAY de producción.

Sandbox API Key: la clave de Rapid API de tu sandbox de eWAY (cuenta de partner/desarrollador).

Sandbox API Password: la contraseña de Rapid API de tu cuenta sandbox de eWAY.

Las claves y contraseñas guardadas nunca se vuelven a mostrar. El campo queda vacío y muestra Saved — leave empty to keep it. Escribe un valor nuevo solo si quieres cambiarlo.

Clear saved credentials: marca una clave o contraseña y haz clic en Save para eliminarla. Un campo vacío conserva el valor guardado.

Return URL / re-checks: no hace falta configurar ningún webhook ni URL de retorno en eWAY, porque la URL de retorno se envía con cada pago. Este campo muestra una URL de cron opcional. Llámala desde una tarea cron del servidor, por ejemplo cada 15 minutos. Si un cliente paga y cierra el navegador antes de volver a la tienda, el pago se consulta a eWAY aproximadamente una hora después y se crea el pedido. Si no se puede contactar con eWAY, la comprobación se repite hasta tres veces. Mantén esta URL en secreto: contiene un token, y una llamada con un token incorrecto recibe la respuesta Forbidden.

Pedidos

Order Status on Success: el estado del pedido una vez que eWAY confirma el pago.

Un importe o una moneda aprobados que no coincidan con el pedido siempre pasan a eWAY payment on hold.

Avanzado

Debug log: registra las llamadas a la API y los resultados de los pagos en logs/eway_p_debug.log.php dentro de la carpeta del módulo. El archivo no se puede abrir desde la web. No se registran datos de tarjeta, claves, contraseñas, correos de clientes ni códigos de acceso. Los errores siempre se registran. Predeterminado: desactivado.

Log: muestra el tamaño y las últimas entradas del registro. Haz clic en Clear log para vaciarlo.

Delete all plugin data on uninstall: si está activado, al desinstalar el módulo se eliminan los ajustes de la pasarela y el registro. Los datos de pago de eWAY de los pedidos y el estado de pedido eWAY payment on hold siempre se conservan. Predeterminado: desactivado.

Finalizar compra

En el paso de pago, el cliente elige el método de pago (por defecto Credit Card (eWAY)) y confirma. El módulo pide a eWAY una página de pago para el importe total del carrito en la moneda del carrito, con PS- y el número del carrito como referencia de factura, además de la dirección de facturación y el correo electrónico del cliente, y envía al cliente a la eWAY Responsive Shared Page. Allí el cliente paga con tarjeta. El cobro es inmediato. En este punto todavía no existe ningún pedido.

Tras el pago, el cliente vuelve a tu tienda. El módulo no confía en el navegador: pide a eWAY, de servidor a servidor, el resultado de la página de pago que creó este carrito. El pedido se marca como pagado solo cuando eWAY lo confirma y el importe y la moneda aprobados coinciden con el carrito. Entonces se crea el pedido y el cliente ve la página estándar de confirmación del pedido con Your payment with eWAY has been received. En un pedido retenido, la página muestra Your payment was received and is being reviewed by the store. We will contact you if anything is needed.

Si en ese momento no se puede consultar a eWAY, aparece una página Payment confirmation con el mensaje We have not received the confirmation of your payment from eWAY yet. If you completed the payment, this order will be updated shortly — please do not pay again., un botón Check again y un botón Back to checkout. El pedido se crea cuando el cliente vuelve a comprobarlo o cuando se ejecuta la URL de cron.

Si el pago es rechazado, el cliente vuelve a la página de finalizar compra con el motivo, por ejemplo Your payment was declined: D4451 Insufficient funds. Please try again or use a different payment method. Si el cliente hace clic en Cancelar en la página de eWAY, el módulo primero comprueba con eWAY que no se haya cobrado nada (por ejemplo, en otra pestaña). Entonces el cliente ve You cancelled the payment on the eWAY page. Your order has not been paid — you can try again. Si el pago no se completó, el mensaje es The payment was not completed. Please try again. El carrito se conserva en todos los casos.

El cliente puede volver a intentarlo. Antes de crear una nueva página de pago, se comprueba con eWAY la página anterior del carrito. Si resulta que ya está pagada, se crea el pedido en lugar de un segundo cobro. Si eWAY no puede crear la página de pago, el cliente se queda en la página de finalizar compra con un mensaje breve, por ejemplo Payment error: Unable to connect to eWAY. Please try again. o eWAY could not start the payment con los códigos de error de eWAY.

eWAY no envía notificaciones de servidor a servidor para la Shared Page: el resultado se obtiene cuando el cliente vuelve y mediante la URL de cron. El módulo no tiene campos de tarjeta en tu sitio, ni tarjetas guardadas ni suscripciones, ni autorización sin captura ni captura separada, y no evalúa las puntuaciones de fraude de Beagle (las transacciones bloqueadas por las reglas antifraude de eWAY son rechazadas por el propio eWAY).

Pedidos y reembolsos

Estados del pedido

No order yet: el cliente fue enviado a eWAY y no ha pagado, ha cancelado, el pago fue rechazado o el resultado todavía no se ha podido obtener. Solo existe el carrito.

Payment accepted or Delivered: el pago fue aprobado. El estado sigue a Order Status on Success. El pago se registra con el ID de transacción de eWAY, y una nota muestra el ID de transacción, el código de autorización, la respuesta y el modo (sandbox o producción).

eWAY payment on hold: eWAY aprobó un importe o una moneda distintos a los del carrito (por ejemplo, Approved for partial amount, o el carrito se modificó después de que el cliente abriera la página de pago), el pago fue aprobado después de que el cliente lo cancelara en la página de eWAY, o se aprobó después de que el pedido se hubiera cancelado. El pago se registra con el importe que eWAY cobró, y la nota lo explica. Revisa el pedido, tramítalo o reembolsa el pago.

Refunded: el pago fue reembolsado por completo a través del módulo.

Si se aprueba un segundo pago para un carrito que ya está pagado, el pedido no cambia. Una nota te pide que reembolses el duplicado en MyeWAY. Un pago aprobado para otra referencia de factura nunca se aplica al pedido.

Bloque de pago de eWAY

La página del pedido muestra un bloque eWAY payment con el ID de transacción, el código de autorización, la respuesta de eWAY, el estado, el modo y la referencia de factura, el importe pagado y reembolsado, una insignia Sandbox para los pagos de sandbox, el historial de reembolsos y las eWAY notes del pedido.

Reembolsos

En el bloque eWAY payment introduce el importe (se rellena el importe que aún no se ha reembolsado), opcionalmente un motivo, y haz clic en Refund via eWAY. Confirma la pregunta Refund this amount through eWAY? This cannot be undone. Se admiten reembolsos totales y parciales. Necesitas permiso para editar pedidos; no hace falta acceso a las páginas de Módulos. Los reembolsos se hacen en el importe y la moneda que eWAY cobró, así que tras una aprobación por un importe parcial puedes reembolsar hasta lo que el cliente realmente pagó, y no el total del pedido. El reembolso se envía en el entorno en el que se hizo el pago (sandbox o producción), por lo que deben estar configuradas la clave y la contraseña de API de ese entorno. Si eWAY rechaza el reembolso, el bloque muestra eWAY refund failed: con los códigos de eWAY, y no se registra ningún reembolso. Un reembolso correcto se añade al historial de reembolsos y a las notas con el ID de transacción del reembolso de eWAY. Un reembolso total pone el pedido en Refunded. Un reembolso parcial no cambia el estado. Los reembolsos están disponibles una vez que eWAY ha aprobado el pago.

El módulo no crea notas de crédito. Los botones de reembolso estándar de PrestaShop en la página del pedido no devuelven dinero a través de eWAY. Los reembolsos hechos en MyeWAY no se sincronizan con PrestaShop. Actualiza el pedido manualmente si es necesario.

Clave de licencia

El módulo funciona con una clave de licencia de VibeFox de vibefox.net. El bloque de licencia License — VibeFox eWAY Payment Gateway es el primer bloque de Modules > Module Manager > VibeFox eWAY Payment Gateway > Configure, por encima de los ajustes. Introduce la clave en License key y haz clic en Activate. Después, el bloque muestra la clave enmascarada, el estado (por ejemplo, la fecha hasta la que la licencia está activa y tu dominio) y los botones Check now para volver a comprobar el estado, Change key para introducir otra clave y Remove key para eliminar la clave de esta tienda. Debajo aparecen la línea Product: presta-payment-eway y el enlace Manage licenses and domains in your account, que abre tu cuenta de vibefox.net. Solo los empleados con el permiso Configure para el módulo pueden cambiar la clave. Los textos del bloque siguen el idioma del back office (se incluyen inglés y ruso).

Si la clave no es aceptada, el bloque indica el motivo, por ejemplo Key not found, This key belongs to another product, Domain limit reached o License expired on seguido de una fecha. Después de cambiar la dirección de la tienda, o después de liberar una plaza de dominio en tu cuenta, haz clic en Check now. Si no se puede contactar con el servidor de licencias, el módulo sigue funcionando con el último estado conocido.

Una clave funciona en un solo dominio: el dominio de la tienda principal, también en una configuración multitienda. Quitar la clave de la tienda no libera su plaza de dominio. Libera la plaza en tu cuenta de vibefox.net.

Sin una clave activa, eWAY no se muestra a los clientes en la página de finalizar compra. Si aun así se inicia un pago, el cliente ve Este método de pago no está disponible. Por favor, elige otro. La tienda de PrestaShop no sabe que has iniciado sesión en el back office, así que el método de pago también se oculta para ti: puedes configurar el módulo antes de comprar una clave, pero no probarlo en el checkout. Aparece un recordatorio en Modules > Module Manager, en la pestaña Alerts. Los pedidos existentes no se ven afectados: los pagos ya iniciados siguen confirmándose y los reembolsos funcionan.

Cuando una licencia caduca, el módulo sigue funcionando, pero las actualizaciones y el soporte necesitan una renovación. El estado se vuelve a comprobar automáticamente mientras trabajas en el back office: una vez al día durante los primeros 14 días después de introducir la clave, y después una vez a la semana. No hace falta ninguna tarea cron. Desinstalar o restablecer el módulo elimina siempre la clave de licencia y el estado de la licencia.

Solución de problemas

eWAY does not appear at checkout: comprueba que la licencia esté activa, que Enable/Disable esté activado, que la clave y la contraseña de API del modo actual estén configuradas (los campos de sandbox en modo sandbox, los de producción en modo producción) y que la moneda del carrito sea AUD, NZD, SGD, HKD o MYR. La página de ajustes muestra un aviso cuando faltan las credenciales. En Payment > Preferences comprueba que el módulo esté permitido para la moneda del carrito, el país del cliente y el grupo del cliente.

The payment went through, but no order was created: el cliente no volvió desde eWAY, o no se pudo consultar a eWAY en ese momento. eWAY no envía notificaciones para la Shared Page. Configura la URL de cron de Return URL / re-checks: recupera el pago aproximadamente una hora después. Comprueba la transacción en MyeWAY y revisa el campo Log de la página del módulo.

The customer sees This payment method is temporarily unavailable: faltan la clave o la contraseña de API del modo actual, o eWAY las ha rechazado. Revisa las credenciales del modo actual.

The customer sees eWAY could not start the payment: eWAY devolvió códigos de error, que se muestran en el mensaje. Muchas veces los datos de facturación no son válidos.

The customer sees We could not match this payment to an order: el enlace de retorno no pertenece a un carrito de esta tienda, o eWAY aprobó un pago para otra referencia de factura. Si el cliente fue cobrado, busca el pago en MyeWAY.

The customer sees We could not check the status of your previous payment attempt: otra solicitud estaba procesando el mismo carrito. El cliente puede volver a intentarlo en un momento.

Order is eWAY payment on hold after payment: lee las eWAY notes del bloque eWAY payment (véase Estados del pedido) y luego tramita el pedido o reembolsa el pago.

Refund fails with a message about the sandbox or live mode: el pedido se pagó en ese entorno y su clave y contraseña de API no están configuradas. Introdúcelas y vuelve a intentarlo.

Refund fails with at most … can be refunded: el importe es mayor que lo que eWAY cobró menos los reembolsos ya realizados.

Para desarrolladores: el README del módulo indica el hook actionWcpEwaySupportedCurrencies, para el caso en que tu cuenta de eWAY esté habilitada para más monedas.

Desinstalación

Ve a Modules > Module Manager, abre el menú junto a VibeFox eWAY Payment Gateway y elige Uninstall. La clave de licencia y el estado de la licencia de este módulo siempre se eliminan. Si Delete all plugin data on uninstall está activado, se eliminan los ajustes de la pasarela y el registro. Si está desactivado, todos los ajustes se conservan para una reinstalación posterior. Los datos de pago de eWAY de los pedidos y el estado de pedido eWAY payment on hold siempre se conservan, así que los pedidos pagados antes pueden reembolsarse tras una reinstalación. Los pedidos existentes conservan sus notas de pago y sus ID de transacción.

eWAY es una marca comercial de su respectivo titular. Este módulo no está afiliado a eWAY ni cuenta con su respaldo.