Crear Enlace de Pago

Los enlaces de pago permiten generar una URL o código QR para llevar a sus clientes a una pantalla de pago generada por Wompi. Esta opción permite que no tenga que generar su propia pantalla de pago

POST /EnlacePago

Ejemplo Pantalla de Pago Generada por Wompi

Ejemplo Interfaz Pago

Creación Enlace de Pago

Ejemplo Petición Básica

Ejemplo de petición solo con campos requeridos

{
"identificadorEnlaceComercio": "string",
"monto": 0,
"nombreProducto": "string"
}

Ejemplo Respuesta

{
"idEnlace":15,
"urlQrCodeEnlace":"https://wompistorage.blob.core.windows.net/imagenes/6c8fa0db-fb0f-4e65-bad7-2f2aced974f2.jpg",
"urlEnlace":"https://lk.wompi.sv/yhDt",
"estaProductivo":false
}

Objeto Completo de Petición

En la sección anterior se definió una petición básica para crear un enlace de pago. En esta sección se detallan todas las propiedades opcionales que se pueden incluir para personalizar el contenido y comportamiento del botón.

JSON Completo

{
"identificadorEnlaceComercio": "string",
"monto": 0,
"nombreProducto": "string",
"formaPago": {
"permitirTarjetaCreditoDebido": true,
"permitirPagoConPuntoAgricola": true,
"permitirPagoEnCuotasAgricola": true
},
"cantidadMaximaCuotas": "Tres",
"infoProducto": {
"descripcionProducto": "string",
"urlImagenProducto": "string"
},
"configuracion": {
"esMontoEditable": true,
"esCantidadEditable": true,
"cantidadPorDefecto": 0,
"urlRedirect": "string",
"emailsNotificacion": "string",
"urlWebhook": "string",
"notificarTransaccionCliente": true
}
}

Definición Campos Objeto Root

Campo

Requerido

Tipo Dato

Descripción

identificadorEnlaceComercio

Si

string(500)

Identificador del comercio para este enlace de pago. La idea que sea un identificador único que permita al comercio identificar el pago en los reportes, en el correo de notificación o en el webhook.

monto

Si

double

Monto a cobrar al cliente en el botón de pago, tiene que ser al menos un monto de $0.01

nombreProducto

Si

string(500)

Nombre del producto que se muestra al usuario en la interfaz de pago.

formaPago

No

EnlaceFormaPago

Datos de las formas de pago aceptadas en la interfaz de pago. Si se omite se acepta solo pago con tarjeta de crédito/debido y pago con puntos . *Ver detalles del objeto más adelante*

cantidadMaximaCuotas

No

Enum

Puede ser uno de los siguientes valores: Tres, Seis, Nueve, Doce.

infoProducto

No

EnlaceInfoProducto

Datos adicionales del producto que se pueden mostrar en la interfaz de pago. Ver detalles del objeto más adelante.

Configuracion

No

EnlaceConfiguracion

Parámetros de configuración del comportamiento del enlace de pago y de la forma de notificar las transacciones exitosas. Ver detalles del objeto más adelante.

Definición Campos Objeto "EnlaceFormaPago"

Campo

Requerido

Tipo Dato

Descripción

permitirTarjetaCreditoDebido

Si

bool

Si es "verdadero" el cliente puede realizar el pago con tarjeta de crédito o débito, sino no.

permitirPagoConPuntoAgricola

Si

bool

Si es "verdadero" el cliente puede realizar el pago con puntos de Banco Agrícola

permitirPagoEnCuotasAgricola

Si

bool

Si es "verdadero" el cliente puede realizar el pago en cuotas con tarjetas de crédito de Banco Agrícola

Validación Adicional a Considerar: Al menos uno de los valores de este objeto tiene que ser "verdadero"

Definición Campos Objeto "EnlaceInfoProducto"

Campo

Requerido

Tipo Dato

Descripción

DescripcionProducto

No

string(max)

Descripción complementaria sobre el producto, puede ser un texto bastante extenso con información técnica del producto. Esta información se muestra en la interfaz de pago.

UrlImagenProducto

No

url

URL de la imagen de la imagen del producto que se desea mostrar en la interfaz de pago.

Definición Objeto "EnlaceConfiguracion"

Campo

Requerido

Tipo Dato

Descripción

EsMontoEditable

No

bool

Indica que el cliente puede editar el monto de la compra en la interfaz de pago. Normalmente el dato debe ser "falso"

EsCantidadEditable

No

bool

Indica que el cliente puede editar la cantidad de productos e comprar en la interfaz de pago.

CantidadPorDefecto

No

bool

Indica la cantidad de producto a adquirir que se muestra al cliente. Si no se especifica el valor por defecto es 1. El monto a cobrar al cliente es cantidad x monto.

urlRedirect

No

url

Url donde se redireccionará el usuairo después de pagar

emailsNotificacion

No

string

Lista de correos electrónicos divididos por coma a los que se enviará una notificación si la transacción es exitosa.

urlWebhook

No

url

Url proporcionada por el comercio que se invocará con los datos de la transacción cuando esta sea exitosa. Los webhook son la manera principal que los sistemas del comercio se enteren de una transacción exitosa. Para más información ver la sección Webhook.

notificarTransaccionCliente

Si

bool

Indica si Wompi debe enviar una notificación por correo electrónico al cliente después de efectuar una transacción exitosa. El correo del cliente ex capturado en la interfaz de pago.

Aún cuando la urlWebhook y emailsNotificación son opcionales es obligatorio que al menos uno de ellos no sea nulo.

Objeto de Respuesta

{
"idEnlace": 0,
"urlQrCodeEnlace": "string",
"urlEnlace": "string",
"estaProductivo": true
}

Definición Objeto de Respuesta

Campo

Tipo Dato

Descripción

idEnlace

Entero

Identificador único del enlace que se puede utilizar posteriormente para consultar el enlace y la transacción de compra realizada con ese enlace.

urlQrCodeEnlace

Url

Url para descargar la imagen del QR que redirecciona a la interfaz de pago.

urlEnlace

Url

Url del enlace de pago acortado que redirecciona a la interfaz de pago.

estaProductivo

Url

Indica si el enlace esta actualmente productivo, el enlace esta productivo si el aplicativo bajo el que se creo esta productivo, esta en desarrollo si el aplicativo bajo el que se creo esta en desarrollo.