Yape On File: One Click Payments
Conoce el paso a paso de cómo crear un pago con Yape en Perú
Crear un pago con esta modalidad consiste en hacer una solicitud de afiliación a través de nuestra API. Esta solicitud podrá realizarse tanto para versión web, como para versión mobile. Una vez realizada con éxito, el cliente podrá realizar sus pagos posteriores con un solo clic, a través de su cuenta de Yape.
Versiones
Es posible integrar el servicio Yape On File: One Click Payment de dos maneras:
- Versión web.
- Versión mobile.
Más abajo, verás las instrucciones para la versión web. Después, dentro de esta misma página, verás los pasos para la versión mobile. Para una navegación más rápida, te sugerimos usar el índice de la derecha.
¿Cómo funciona?
Yape es una aplicación que permite realizar pagos y transferencias de dinero en Perú, utilizando solo el número de celular. Con Yape, los usuarios pueden hacer pagos en línea, recargar saldo en su cuenta o realizar compras en comercios afiliados. Para completar una transacción utilizando este método de pago, el cliente debe seleccionar la opción "Agrega Yape como método de pago", tener una cuenta creada y aprobar la afiliación desde su aplicación.
El proceso de pago con Yape On File: One Click Payments en Perú consta de las siguientes etapas:
- Selección de afiliación. Durante el checkout, el cliente elige la opción de "Agrega Yape como método de pago". La siguiente parte del flujo varía según el dispositivo del cliente y si tu comercio tiene o no activado el servicio de validación de pago de terceros:
🌐 En web:
Se le pide al cliente ingresar su número de celular para solicitar el pago. Luego, se le muestra en pantalla un instructivo para abrir su aplicación y aprobar el pago en la sección de Aprobar compras.
Se le pide al cliente confirmar su número de celular y documento de identidad. Si los datos (número de celular y documento de identidad) no coinciden, se muestra un mensaje de error. Si los datos coinciden, la solicitud se envía directamente a su aplicación de Yape, donde el cliente podrá visualizar en pantalla las solicitudes pendientes, seleccionar la correspondiente y hacer clic en Confirmar.
En el caso del proceso de afiliación, Yape envía un correo electrónico únicamente cuando esta ha sido exitosa, y, en caso de una desafiliación, el cliente recibe una notificación push en su app.
📱En mobile:
El cliente debe hacer clic en el botón Solicitar aprobación. Luego, será redirigido a la aplicación de Yape mediante un deeplink dinámico generado a demanda, el cual estará activo por 15 minutos.
Después de ingresar su clave de acceso, aparecerá un modal en la pantalla, donde podrá aprobar la afiliación directamente.
Se le pide al cliente confirmar su número de celular y su documento de identidad, y luego hacer clic en el botón Solicitar aprobación. Si alguno de estos datos (número de celular y documento de identidad) no coincide, se muestra un mensaje de error. Si los datos coinciden, el cliente debe hacer clic en el botón Abrir Yape para ser redirigido a la aplicación. El cliente ingresa, visualiza en pantalla las solicitudes por aprobar, selecciona la indicada y hace clic en Confirmar afiliación.
Se utiliza un deeplink genérico, el cual redirige automáticamente al usuario a una sección específica dentro de la app de Yape.
La URL del deeplink genérico es:
https://www.yape.com.pe/app/checkout/approval_code.
- Confirmación de la afiliación. Se hace la afiliación, la pantalla de tu comercio se actualiza y se muestra el resultado de la transacción. A su vez, tu comercio recibe la confirmación a través de los webhooks que hayas configurado.
- One Click Payment. Ahora el cliente puede ver en el checkout la sección de "Métodos de pago guardados", con su cuenta Yape. Al elegirla, comienza el proceso de pago, y el dinero se mueve desde la wallet del cliente hacia la cuenta de tu comercio.
- Confirmación del One Click Payment. La pantalla de tu comercio se actualiza y se muestra el resultado de la transacción. A su vez, tu comercio recibe la confirmación a través de los webhooks que hayas configurado.
Validación pago terceros
ProntoPaga cuenta con un servicio de validación de pago de terceros, el cual confirma que el número de teléfono celular ingresado coincida con los datos de la cuenta del cliente, evitando que se realicen pagos de terceros, y maximizando la seguridad de tus transacciones.
Esta validación se asigna de forma automática a ciertos comercios integrados con nosotros. Si deseas activarla o desactivarla, comunícate con nuestro equipo de integración. Toma en cuenta las diferencias que existen en la experiencia del cliente para cada caso. Esas diferencias están descritas en la sección de ¿Cómo funciona? de este artículo, en la parte superior.
Motivos de rechazo de validación pago terceros
Códigos de rechazoPuedes consultar la tabla completa de códigos de error en la sección de Motivos de rechazo para Validación de terceros.
Integra la versión web
El front-end será el encargado de recopilar los datos necesarios de tu cliente para comenzar el proceso de afiliación, mientras que tu back-end estará integrado con nuestra API, procesando la afiliación y el pago.
Devolución de un One Click Payment
Para solicitar la devolución de un pago exitoso realizado con este método, usa este endpoint. A continuación, se muestra un ejemplo del body request que debe llevar:
{
"reference": "1111111111",
"clientDocument": "12345678912",
"amount": "100.90",
"urlCallbackRefund": "https://www.webhook.com",
"sign": "Signature of the parameters"
}Lista de afiliaciones
Puedes obtener una lista con las afiliaciones activas de cierto cliente, haciendo una consulta con su número de documento. Utiliza este endpoint para ello.
Detalle de una afiliación
Consulta el detalle del estado de una afiliación, usando el identificador único (UID) de la afiliación de la wallet del cliente. Utiliza este endpoint para conocer el detalle.
Cancelar una afiliación
Para cancelar la afiliación de un cliente, y que este ya no vea asociada su wallet a tu comercio, ni pueda realizar One Click Payments, haz una solicitud a este endpoint.
Para ello, deberás enviar el identificador único (UID) de la afiliación de la wallet del cliente en el path. Una vez finalizado el proceso de cancelación de forma exitosa, el cliente recibirá una notificación push de Yape, confirmando el proceso.
Integra la versión mobile
El front-end será el encargado de recopilar los datos necesarios de tu cliente para comenzar el proceso de afiliación, mientras que tu back-end estará integrado con nuestra API, procesando la afiliación y el pago.
Devolución de un One Click Payment
Para solicitar la devolución de un pago exitoso realizado con este método, usa este endpoint. A continuación, se muestra un ejemplo del body request que debe llevar:
{
"reference": "1111111111",
"clientDocument": "12345678912",
"amount": "100.90",
"urlCallbackRefund": "https://www.webhook.com",
"sign": "Signature of the parameters"
}Lista de afiliaciones
Puedes obtener una lista con las afiliaciones activas de cierto cliente, haciendo una consulta con su número de documento. Utiliza este endpoint para ello.
Detalle de una afiliación
Consulta el detalle del estado de una afiliación, usando el identificador único (UID) de la afiliación de la wallet del cliente. Utiliza este endpoint para conocer el detalle.
Cancelar una afiliación
Para cancelar la afiliación de un cliente, y que éste ya no vea asociada su wallet a tu comercio, ni pueda realizar One Click Payments, haz una solicitud a este endpoint.
Para ello, deberás enviar el identificador único (UID) de la afiliación de la wallet del cliente en el path. Una vez finalizado el proceso de cancelación de forma exitosa, el cliente recibirá una notificación push de Yape, confirmando el proceso.
Motivos de rechazo
La siguiente sección contiene los posibles motivos de rechazo en la validación de pago a terceros y los motivos de rechazo de un pago, así como los mensajes que se muestran en pantalla a tu cliente.
Notificación de erroresLos errores serán notificados a tu comercio vía webhook. También puedes consultarlos en el Portal de servicios > Transacciones > Payins (pagos), en el campo Nota del detalle de la transacción.
Motivos de rechazo de validación pago terceros
Ten en cuenta queEstos errores solo pueden presentarse en el primer flujo de pago. Luego de la validación de terceros, solo se pueden presentar errores de pago.
A continuación, se listan los posibles motivos de validación de pago a terceros, así como los mensajes que se mostrarán.
| Código | Motivo | Mensaje |
|---|---|---|
| 0 | El número de celular y el documento de identidad no están asociados. | The user's phone number and identity document do not match |
| 0 | El tipo de documento de identidad proporcionado del servicio de validación es distinto al enviado por el comercio. | The Document Type provided by the validation service does not match the one sent by the Merchant |
| 0 | El servicio de validación no está respondiendo correctamente. | The validation service is currently unavailable. Please try again, and if the error persists, contact your KAM |
Motivos de rechazo de un pago
A continuación, se listan los posibles motivos de rechazo para un pago de tipo One Click Payment, así como los mensajes que se muestran en pantalla a tu cliente.
| Código | Motivo | Mensaje |
|---|---|---|
YPSBS003 | Error por cuenta yapera no existe o inactiva | Ocurrió un inconveniente. Comunícate con Yape por WhatsApp al 939 339 299 para brindarte más información. |
YPSBS004 | Error por tipo de cuenta yapera no soportada | Tu tipo de cuenta Yape no está habilitada para esta funcionalidad. Conoce tu tipo de cuenta ingresando al menú de Yape, opción Mi perfil. |
YPSBS005 | Error por cuenta yapera en blacklist | Por seguridad, tu cuenta Yape fue bloqueada. Comunícate con Yape por WhatsApp al 939 339 299 para brindarte más información. |
YPSBS006 | Error por cuenta yapera bloqueada para el canal e-commerce | Tu cuenta Yape está bloqueada temporalmente. Por seguridad, tu cuenta de Yape fue bloqueada solo para compras por internet. Vuelve a intentar en 24 horas. |
YPSBS014 | Error por suscripción confirmada no existente | Ocurrió un inconveniente. Estamos poniendo manos a la obra. Por favor, vuelve a intentarlo en unos minutos. |
YPSBS015 | Error por no coincidencia del código de comercio de la suscripción | Ocurrió un inconveniente. Estamos poniendo manos a la obra. Por favor, vuelve a intentarlo en unos minutos. |
YPSBS016 | Error por límite diario excedido | Esta operación excede tu monto límite diario para compras por internet. Vuelve a intentarlo el día de mañana. |
YPTRX001 | Error por autorización detectada como fraude | Detectamos una actividad sospechosa. Comunícate con Yape por WhatsApp al 939 339 299 para validar y brindarte una solución. |
YPTRX002 | Error por fondos insuficientes | Necesitas más saldo para este pago. No cuentas con saldo suficiente para realizar este pago. |
YPTRX003 | Error por cuenta bancaria bloqueada | Tu cuenta asociada a Yape está bloqueada. No se pudo realizar el pago. Comunícate con Yape por WhatsApp al 939 339 299 para brindarte una solución. |
YPTRX004 | Error por timeout en el proceso de transferencia | Ocurrió un inconveniente. Estamos poniendo manos a la obra. Por favor, vuelve a intentarlo en unos minutos. |
YPTRX005 | Error por cuenta yapera no encontrada | Ocurrió un inconveniente. Comunícate con Yape por WhatsApp al 939 339 299 para validar y brindarte una solución. |
YPTRX006 | Error por tarjeta BCP desactualizada | Necesitas asociar tu nueva tarjeta BCP a Yape. Ingresa al Centro de Ayuda de Yape www.yape.com.pe y conoce los pasos para asociar tu nueva tarjeta y renovar tu cuenta. |
YPTRX007 | Error por tarjeta BCP bloqueada | Tu tarjeta asociada a Yape está bloqueada, necesitas una nueva. Si ya tienes tu nueva tarjeta, ingresa al Centro de Ayuda de Yape www.yape.com.pe y conoce los pasos para renovar tu cuenta con tus mismos datos. |
YPTRX008 | Error por tarjeta digital inválida | Tu cuenta está bloqueada. Si ya tienes tu nueva tarjeta, ingresa al Centro de Ayuda de Yape www.yape.com.pe y conoce los pasos para renovar tu cuenta con tus mismos datos. |
YPTRX009 | Error por tarjeta BCP vencida | Tu cuenta está vencida. Si ya tienes tu nueva tarjeta, ingresa al Centro de Ayuda de Yape www.yape.com.pe y conoce los pasos para renovar tu cuenta. De no tenerla, acude a una agencia BCP y solicita una nueva para renovar tu cuenta. |
YPTRX013 | Error por cuenta bancaria cerrada | Tu cuenta asociada a Yape está cerrada. No se pudo realizar el pago. Comunícate con Yape por WhatsApp al 939 339 299 para brindarte una solución. |
YPSBS998 | Error por incumplimiento de contrato | Ocurrió un inconveniente. Estamos poniendo manos a la obra. Por favor, vuelve a intentarlo en unos minutos. |
YPSBS999 | Error inesperado ocurrido en el servidor | Ocurrió un inconveniente. Estamos poniendo manos a la obra. Por favor, vuelve a intentarlo en unos minutos. |
YPTRX999 | Error inesperado ocurrido en el servidor | Ocurrió un inconveniente. Estamos poniendo manos a la obra. Por favor, vuelve a intentarlo en unos minutos. |
Límites transaccionales
Ten en cuenta que cada banco establece sus propios límites transaccionales. Estos límites pueden variar dependiendo del tipo de cuenta o sistema de autenticación del banco.
Consulta los límites transaccionales para el comercio, del procesador y de ProntoPaga en el siguente artículo:
Prueba tu integración
Contamos con demos que simulan la experiencia de pago del cliente, en donde podrás hacer pruebas. Conócelos aquí:
Certifica tu integración
La certificación de la integración en sandbox es un paso obligatorio que todos los comercios deben realizar antes de recibir sus credenciales de producción. Su propósito es asegurar que la integración cumpla con los estándares técnicos, funcionales y de seguridad requeridos por ProntoPaga. Dentro de esta sección, se establecen los requisitos que deben cumplirse sin excepción para que la certificación sea aprobada.
Requisitos de certificación
A continuación, encontrarás los distintos requisitos necesarios para completar tu certificación:
-
❌ El documento de identidad del cliente no debe ser modificable en ningún punto de la transacción.
-
✅ Es recomendable que este dato no se muestre en el checkout. Solo puede estar disponible en la sección de perfil del usuario autenticado.
-
⚠️ Esta medida tiene como objetivo prevenir fraudes y evitar que se realicen transacciones en nombre de terceros o menores de edad.
-
📥 Agregar los logotipos de los diferentes métodos de pago de ProntoPaga a tu front-end. Puedes descargarlos aquí.
-
🔎 Todos los nombres y logos de los métodos de pago habilitados deben mostrarse de forma clara, sin modificaciones visuales o estilísticas que puedan generar confusión o inducir a errores.
-
✅ Se recomienda ordenarlos según su popularidad o frecuencia de uso, para mejorar la experiencia del usuario y optimizar la conversión.
- ✅ El checkout debe incluir mensajes claros y visibles que orienten al usuario durante todo el proceso.
❗ Es obligatorio mostrar:
-
ℹ️ Montos mínimos y máximos permitidos para cada método de pago.
-
ℹ️ Estados transaccionales con claridad: por ejemplo, Transacción aprobada o Transacción rechazada, junto con una sugerencia de los pasos a seguir en caso de que corresponda.
-
❌ No almacenar datos sensibles del cliente en tu base de datos.
-
✅ La certificación se otorga únicamente si estos requisitos se cumplen en su totalidad en el entorno de sandbox.
-
💻 Una vez validada la integración, se habilitarán las credenciales para el entorno productivo.
-
⚠️ El incumplimiento de estos requisitos podrá resultar en la denegación de la certificación.
Para comercios tipo gambling es necesario cumplir con los siguientes requisitos:
-
✅ Verificación de contacto mediante OTP: El registro de usuarios debe incluir una validación de correo electrónico o número telefónico mediante código OTP.
-
✅ Verificación de identidad (KYC): Deben existir validaciones adicionales de identidad antes de permitir el uso completo de la plataforma o realizar transacciones.
-
⚙️ Controles para cambios de datos personales: Para la modificación de información sensible (correo electrónico, teléfono, nombre, etc.), el sistema debe solicitar una verificación adicional, como OTP o confirmación de seguridad.
-
⚙️ Controles antifraude básicos en el proceso de registro: Esto puede incluir validaciones adicionales para evitar registros automatizados o cuentas fraudulentas.
-
⚠️ El incumplimiento de estos requisitos podrá resultar en la denegación de la certificación.
Updated 4 days ago