- Pautas de integración
- Características soportadas (opciones de pago)
- Vínculos de pago
Vínculos de pago
El vínculo de pago es un método seguro para recibir pagos a través de una URL de vínculo de pago simple. Le permite proporcionar un modo adicional de aceptar un pago que implica generar una dirección URL de vínculo de pago y luego compartirla con el pagador a través de varios canales de comunicación, como correo electrónico, mensaje de texto y código QR. Cuando un pagador hace clic en la URL del vínculo de pago, se le redirige a la página de pago, donde puede seleccionar el método de pago para completar la transacción.
Beneficios clave
Los beneficios clave del vínculo de pago son los siguientes:
- simplifica el proceso de pago;
- mejora la experiencia del cliente;
- permite un pago más rápido; y
- permite hacer un seguimiento de un cliente después de que una transacción haya fallado o si se abandona un carrito de compras.
Utilice un vínculo de pago
Cuando los pagadores reciben una URL de vínculo de pago única para el pago, pueden hacer clic en el vínculo y completar el pago.
Este diagrama muestra los diferentes pasos para completar una transacción utilizando un vínculo de pago.
- Ingrese la información de pago, como el número de factura, el monto total y solicite generar una URL de vínculo de pago.
- El motor de pagos genera un vínculo único que puede compartir con los pagadores.
- Cuando los pagadores hacen clic en el vínculo, son redirigidos a una página de Hosted Checkout.
- Los pagadores ingresan la información de pago en la página de Hosted Checkout y completan la transacción.
Solicitar una operación Initiate Checkout
Prerrequisitos
Antes de iniciar una operación Initiate Checkout, asegúrese de tener establecidos los atributos siguientes para los vínculos de pago:
- apiOperation: establezca el valor del campo en INITIATE_CHECKOUT.
- checkoutMode: establezca el valor del campo en PAYMENT_LINK.
- interaction.operation: elija AUTHORIZE o PURCHASE como tipo de transacción.
- interaction.merchant.name: el nombre de su empresa que se muestra al pagador en la página de pago.
- interaction.merchant.url: la dirección URL del sitio web de su empresa.
- order.amount: el monto total del pedido. Este es el monto neto más cualquier recargo.
- order.currency: la moneda del pedido.
- order.description: una descripción textual corta de los contenidos del pedido.
- paymentLink.errorUrl: la URL a la que desea redirigir el explorador del pagador en caso de que se produzca un error al invocar el vínculo de pago, como un pedido ya pagado, un vínculo de pago vencido, un vínculo de pago no válido, etc.
Si se especifica y se produce un error, el motor de pagos proporcionará el código de error (
errorCode) y la descripción (errorDescription) como parámetros de cadena de consulta. El motor de pagos también conservará cualquier parámetro de cadena de consulta que haya incluido en errorUrl.Por ejemplo, si especifica paymentLink.errorUrl como https://merchant.com/myPaymentLinkErrorPage.html, en caso de error, este errorUrl recibiría los siguientes parámetros de cadena de consulta del motor de pagos: https://merchant.com/myPaymentLinkErrorPage.html?errorCode=ERROR_CODE&errorDescription=Error+message. Consulte la sección Códigos de error y descripciones para obtener más información.
Este campo es opcional. Cuando no se especifica este campo, el pagador, en caso de error, será redirigido a la pantalla de error predeterminada. - order.id: un identificador único para este pedido para distinguirlo de cualquier otro pedido que cree.
- paymentLink.expiryDateTime: fecha y hora de vencimiento de este vínculo de pago. El valor predeterminado es de 3 meses.
- paymentLink.numberOfAllowedAttempts: número de intentos permitidos después de los cuales el pagador ya no podrá pagar mediante el vínculo de pago. El valor predeterminado es de 25 intentos.
Solicitud de ejemplo
Para crear una URL de vínculo de pago, debe solicitar una operación Initiate Checkout con el modo payment link. Este es un fragmento de muestra para la operación Initiate Checkout.
{
"apiOperation": "INITIATE_CHECKOUT",
"checkoutMode": "PAYMENT_LINK",
"interaction": {
"operation": "AUTHORIZE",
"merchant": {
"name": "<your_merchant_name>",
"url": "<website_url>"
}
},
"order": {
"currency": "USD",
"amount": 1234,
"id": "<order_ID>",
"description": "Ordered goods"
},
"paymentLink": {
"expiryDateTime": "2021-12-10T02:16:00.993Z",
"numberOfAllowedAttempts": "3"
}
}
Referencia de API de Initiate Checkout [REST][NVP]
Una respuesta correcta a esta operación contiene los parámetros URL del vínculo de pago e ID del vínculo de pago, que se pueden compartir con el cliente para realizar el pago.
Respuesta de ejemplo
{
"checkoutMode": "PAYMENT_LINK",
"merchant": "<your_merchant_id>",
"paymentLink": {
"expiryDateTime": "2021-12-10T02:16:00.993Z",
"id": "PAYLINK0001060519617G19059484L2",
"numberOfAllowedAttempts": 3,
"url": https://test.ibanke-commerce.nbg.gr/pbl/PAYLINK0001060519617G19059484L2
},
"result": "SUCCESS",
"successIndicator": "c89f62baad174e12"
}
Compartir vínculos de pago
El negocio comparte el vínculo de pago con el pagador a través de varios canales de comunicación, como correo electrónico, mensaje de texto y códigos QR. El pagador hace clic en el vínculo de pago que lo redirige a la página de pago de Hosted Checkout en un explorador y completa la transacción usando uno de los métodos de pago disponibles.
Eliminar vínculos de pago
La operación Delete Payment Link le permite eliminar o invalidar explícitamente el vínculo de pago si el pagador ya realizó el pago fuera de línea o si el pago ya no es necesario.
| URL | https://test.ibanke-commerce.nbg.gr/api/rest/version/64/merchant/{merchantId}/link/{linkId} |
| Método HTTP | DELETE |
Referencia de API de Delete Payment Link [REST][NVP]
La sesión en el motor de pagos vence automáticamente si:
- el pago no se realiza dentro de los 3 meses posteriores a la generación del vínculo de pago, el pagador ya no podrá usar el vínculo de pago para realizar el pago;
- el número de intentos de pago supera los 25, el pagador ya no podrá acceder al vínculo de pago para completar la transacción;
- el pago mediante un vínculo de pago se ha completado; o
- el negocio inicia la solicitud de eliminación.
Probar un vínculo de pago
Una vez que haya configurado la cuenta y creado su integración, debe probar el vínculo de pago con el perfil de pruebas del negocio (su ID de negocio comienza con "TEST"). El motor de pagos proporciona una página de Hosted Checkout de prueba para verificar el vínculo de pago.
- Ingrese los detalles del pago y solicite el vínculo de pago a través de la operación INITIATE_CHECKOUT. Se devolverá una URL de vínculo de pago cuando la operación INITIATE CHECKOUT se realice correctamente.
- Realice el pago con la tarjeta de prueba que figura en Detalles de las pruebas de las transacciones con tarjeta.
Notificaciones de webhook
Se recomienda que opte por el servicio de notificaciones para recibir notificaciones webhook si el pago se realiza correctamente. Para obtener información adicional sobre las notificaciones y la configuración de webhook, consulte Notificaciones de webhook.
Códigos de error y descripciones
Esta tabla describe la lista de códigos de error con sus descripciones.
| Código de error | Descripción |
|---|---|
| EXPIRED | El vínculo de pago venció. Comuníquese con el solicitante del pago. |
| PAID | El pedido asociado con este vínculo de pago ya se pagó. Comuníquese con el solicitante del pago. |
| USAGE_COUNT_EXCEEDED | Se excedió el máximo de intentos permitidos. Comuníquese con el solicitante del pago. |
| DOES_NOT_EXIST | Este vínculo de pago no es válido. Comuníquese con el solicitante del pago. |
| UNEXPECTED_ERROR | Se produjo un error inesperado. Comuníquese con el solicitante del pago. |
| DELETED | Este vínculo de pago se eliminó. Comuníquese con el solicitante del pago. |