Obtener EnlacePago
Obtiene el listado paginado de los enlaces de pago
GET /EnlacePago
Autenticación: Usuario y contraseña de cuenta Wompi
Parámetros de ruta:
FechaInicioVigencia
No
String (DateTimeOffset)
Fecha de inicio de la vigencia del enlace de pago
FechaFinVigencia
No
String (DateTimeOffset)
Fecha de fin de la vigencia del enlace de pago
Nombre
No
String
Nombre del enlace de pago
IdAplicativo
No
String
Identificador del negocio al que pertenece el enlace de pago
Activo
No
Bool
Indica si el enlace de pago debe estar activo o no
CantidadPorPagina
No
Int
Cantidad de resultados por página
PaginaActual
No
Int
Número de la página de resultados
Ids
No
Lista (Int)
Listado de identificadores de enlaces de pagos
Objeto de respuesta:
paginaActual
Int
Número de la página de resultados actual
cantidadPorPagina
Int
Número de resultados que consultados de la página actual
totalDeElementos
Int
Cantidad total de enlaces de pagos
totalPaginas
Int
Total, de páginas con resultados
resultado
Lista de Enlace de pago
Objeto Enlace Pago
idAplicativo
String
Identificador del negocio al que pertenece el enlace de pago
nombreEnlace
String
Nombre del enlace de pago
monto
Decimal
Monto asociado al enlace de pago
nombreProducto
String
Nombre del producto relacionado al enlace de pago
usable
Bool
Indica si el enlace de pago está disponible para usar
transaccionCompra
Objeto
Representa la última transacción exitosa del enlace de pago
cantidadIntentoPagoFallidos
Int
Cantidad de intentos fallidos al realizar transacciones con el enlace de pago
formaPago
Objeto
infoProducto
Objeto
configuracion
Objeto
cantidadMaximaCuotas
Int
Cantidad máxima de cuotas en meses permitidas cuando se permite el pago en cuotas.
· Uno = 1
· Dos =2
· Tres = 3
· Cuatro = 4
· Cinco = 5
· Seis = 6
· Siete =7
· Ocho = 8
· Nueve = 9
· Diez = 10
· Once =11
· Doce = 12
· Dieciocho=18
· Veinticuatro = 24
· Treintayseis = 36
transacciones
Lista Objeto Transacción
Listado de transacciones realizadas con el enlace de pago
nombreAplicativo
String
Nombre del negocio al que pertenece el enlace de pago
cantidadPagosExitosos
Int
Cantidad de pago exitosos que ha tenido el enlace de pago
imagenes
Lista
Listado de imágenes relacionadas al enlace de pago
vigencia
Objeto
limitesDeUso
Objeto
datosAdicionales
Objeto (Diccionario)
Datos adicionales relacionados al enlace de pago
idGrupoTarjetas
String
Identificador del grupo de tarjetas al cual está reStringido el enlace de pago
idEnlace
Int
Identificador del enlace de pago
urlQrCodeEnlace
String
URL de la imagen del código QR del enlace de pago
urlEnlace
String
URL del enlace de pago en su versión corta
estaProductivo
Bool
Indica si el enlace de pago está en modo producción y puede realizar transacciones reales
urlEnlaceLargo
String
URL del enlace de pago en su versión completa
Objeto Transacción Compra
transaccionCompra:datosAdicionales
Objeto (Diccionario)
Datos adicionales relacionados a la última transacción exitosa del enlace de pago
transaccionCompra:resultadoTransaccion
Int (puede ser nulo)
Número relacionado al resultado de la transacción. Los valores pueden ser:
· ExitosaAprobada = 0
· ExitosaDeclinada = 1
· Fallida = 2
transaccionCompra:fechaTransaccion
String (DateTimeOffset)
Fecha y hora de la transacción
transaccionCompra:montoOriginal
Decimal
Monto original de la transacción
transaccionCompra:idTransaccion
String
Identificador de la transacción
transaccionCompra:esReal
Bool
Indica si la transacción se trata de una compra real y no una de prueba
transaccionCompra:esAprobada
Bool
Indica si la transacción fue aprobada
transaccionCompra:codigoAutorizacion
String
Código de autorización de la transacción aprobada y real
transaccionCompra:mensaje
String
Incluye los mensajes relacionados a un error durante el procesamiento de la transacción
transaccionCompra:formaPago
Int
Forma de pago utilizada para realizar la transacción. Las formas pueden ser:
· PagoNormal = 0
· Puntos = 1
· Cuotas = 2
· Bitcoin = 3
· QuickPay = 4
transaccionCompra:monto
Decimal
Monto de la transacción (puede ser diferente al monto original si se realizó una devolución parcial)
transaccionCompra:idExterno
String
Identificador externo (Se puede utilizar para enviar un identificador de un sistema que implementa el API de Wompi, por ejemplo: el identificador de una orden)
Objeto Forma Pago
formaPago:permitirTarjetaCreditoDebido
Bool
Indica si el enlace de pago permite pagos con tarjetas de crédito o débito
formaPago:permitirPagoConPuntoAgricola
Bool
Indica si el enlace de pago permite pagos con puntos de Banco Agrícola
formaPago:permitirPagoEnCuotasAgricola
Bool
Indica si el enlace de pago permite pagos con cuotas de Banco Agrícola
formaPago:permitirPagoEnBitcoin
Bool
Indica si el enlace de pago permite pagos con Bitcoin
formaPago:permitePagoQuickPay
Bool
Indica si el enlace de pago permite pagos con QuickPay
infoProducto
Objeto
infoProducto:descripcionProducto
String
Descripción del producto relacionado al enlace de pago
infoProducto:urlImagenProducto
String
URL de la imagen del producto relacionado al enlace de pago
Objeto Info Producto
infoProducto:descripcionProducto
String
Descripción del producto relacionado al enlace de pago
infoProducto:urlImagenProducto
String
URL de la imagen del producto relacionado al enlace de pago
Objeto Configuración
configuracion:urlRedirect
String
URL a la cual redirecciona luego de realizar una transacción con el enlace de pago
configuracion:esMontoEditable
Bool
Indica si el monto del enlace de pago puede ser cambiado por el usuario
configuracion:esCantidadEditable
Bool
Indica si la cantidad del enlace de pago puede ser cambiada por el usuario
configuracion:cantidadPorDefecto
Int
Cantidad predeterminada del enlace de pago
configuracion:duracionInterfazIntentoMinutos
Int
Cantidad de minutos que debe durar la interfaz de pagos luego de abrirse
configuracion:urlRetorno
String
URL a la cual el usuario puede regresar al finalizar una transacción con éxito
configuracion:emailsNotificacion
String
Correos electrónicos separados por coma a los cuales se notificarán las transacciones.
configuracion:urlWebhook
String
URL del webhook al cual llegaran las transacciones exitosas relacionadas al enlace de pago
configuracion:telefonosNotificacion
String
Números de teléfono separados por coma a los cuales se notificarán las transacciones
configuracion:notificarTransaccionCliente
Bool
Indica si se debe notificar las transacciones a los correos electrónicos o números de teléfonos
Objeto Transacción
transacciones[n]:datosAdicionales
Objeto (Diccionario)
Datos adicionales relacionado a la transacción del enlace de pago
transacciones[n]:resultadoTransaccion
Int
Número relacionado al resultado de la transacción. Los valores pueden ser:
· ExitosaAprobada = 0
· ExitosaDeclinada = 1
· Fallida = 2
transacciones[n]:fechaTransaccion
String (DateTimeOffset)
Fecha y hora de la transacción
transacciones[n]:montoOriginal
Decimal
Monto original de la transacción
transacciones[n]:idTransaccion
String
Identificador de la transacción
transacciones[n]:esReal
Bool
Indica si la transacción se trata de una compra real y no una de prueba
transacciones[n]:esAprobada
Bool
Indica si la transacción fue aprobada
transacciones[n]:codigoAutorizacion
String
Código de autorización de la transacción aprobada y real
transacciones[n]:mensaje
String
Incluye los mensajes relacionados a un error durante el procesamiento de la transacción
transacciones[n]:formaPago
Int
Forma de pago utilizada para realizar la transacción. Las formas pueden ser:
· PagoNormal = 0
· Puntos = 1
· Cuotas = 2
· Bitcoin = 3
· QuickPay = 4
transacciones[n]:monto
Decimal
Monto de la transacción (puede ser diferente al monto original si se realizó una devolución parcial)
transacciones[n]:idExterno
String
Identificador externo (Se puede utilizar para enviar un identificador de un sistema que implementa el API de Wompi, por ejemplo: el identificador de una orden)
Objeto Imagenes
imagenes[m]:url
String
URL de la imagen
imagenes[m]:esPrincipal
Bool
Indica si la imagen es utilizada como principal al mostrarse en el intento de pago
Objeto Vigencia
vigencia:fechaInicio
String (DateTimeOffset)
Fecha de inicio en el rango de vigencia
vigencia:fechaFin
String (DateTimeOffset)
Fecha fin en el rango de vigencia
Objeto Limites de Uso
limitesDeUso:cantidadMaximaPagosExitosos
Int
Cantidad máxima de pagos exitosos que se pueden realizar con el enlace de pago
limitesDeUso:cantidadMaximaPagosFallidos
Int
Cantidad máxima de pagos fallidos que se pueden realizar con el enlace de pago
Ejemplo de Respuesta
Last updated