# Obtener EnlacePago

{% hint style="info" %}
GET /EnlacePago
{% endhint %}

Autenticación: Usuario y contraseña de cuenta Wompi

### Parámetros de ruta:

<table><thead><tr><th valign="top">Campo</th><th valign="top">Es Requerido</th><th valign="top">Tipo Dato</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">FechaInicioVigencia</td><td valign="top">No</td><td valign="top">String (DateTimeOffset)</td><td valign="top">Fecha de inicio de la vigencia del enlace de pago</td></tr><tr><td valign="top">FechaFinVigencia</td><td valign="top">No</td><td valign="top">String (DateTimeOffset)</td><td valign="top">Fecha de fin de la vigencia del enlace de pago</td></tr><tr><td valign="top">Nombre</td><td valign="top">No</td><td valign="top">String</td><td valign="top">Nombre del enlace de pago</td></tr><tr><td valign="top">IdAplicativo</td><td valign="top">No</td><td valign="top">String</td><td valign="top">Identificador del negocio al que pertenece el enlace de pago</td></tr><tr><td valign="top">Activo</td><td valign="top">No</td><td valign="top">Bool</td><td valign="top">Indica si el enlace de pago debe estar activo o no</td></tr><tr><td valign="top">CantidadPorPagina</td><td valign="top">No</td><td valign="top">Int</td><td valign="top">Cantidad de resultados por página</td></tr><tr><td valign="top">PaginaActual</td><td valign="top">No</td><td valign="top">Int</td><td valign="top">Número de la página de resultados</td></tr><tr><td valign="top">Ids</td><td valign="top">No</td><td valign="top">Lista (Int)</td><td valign="top">Listado de identificadores de enlaces de pagos</td></tr></tbody></table>

### Objeto de respuesta:

<table><thead><tr><th valign="top">Campo</th><th valign="top">Tipo Dato</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">paginaActual</td><td valign="top">Int</td><td valign="top">Número de la página de resultados actual</td></tr><tr><td valign="top">cantidadPorPagina</td><td valign="top">Int</td><td valign="top">Número de resultados que consultados de la página actual</td></tr><tr><td valign="top">totalDeElementos</td><td valign="top">Int</td><td valign="top">Cantidad total de enlaces de pagos</td></tr><tr><td valign="top">totalPaginas</td><td valign="top">Int</td><td valign="top">Total, de páginas con resultados</td></tr><tr><td valign="top"><p>resultado</p><p> </p></td><td valign="top">Lista de Enlace de pago</td><td valign="top"> </td></tr></tbody></table>

### Objeto Enlace Pago

<table><thead><tr><th valign="top">Campo</th><th valign="top">Tipo Dato</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">idAplicativo</td><td valign="top">String</td><td valign="top">Identificador del negocio al que pertenece el enlace de pago</td></tr><tr><td valign="top">nombreEnlace</td><td valign="top">String</td><td valign="top">Nombre del enlace de pago</td></tr><tr><td valign="top">monto</td><td valign="top">Decimal</td><td valign="top">Monto asociado al enlace de pago</td></tr><tr><td valign="top">nombreProducto</td><td valign="top">String</td><td valign="top">Nombre del producto relacionado al enlace de pago</td></tr><tr><td valign="top">usable</td><td valign="top">Bool</td><td valign="top">Indica si el enlace de pago está disponible para usar</td></tr><tr><td valign="top">transaccionCompra</td><td valign="top">Objeto</td><td valign="top">Representa la última transacción exitosa del enlace de pago</td></tr><tr><td valign="top">cantidadIntentoPagoFallidos</td><td valign="top">Int</td><td valign="top">Cantidad de intentos fallidos al realizar transacciones con el enlace de pago</td></tr><tr><td valign="top">formaPago</td><td valign="top">Objeto</td><td valign="top"> </td></tr><tr><td valign="top">infoProducto</td><td valign="top">Objeto</td><td valign="top"> </td></tr><tr><td valign="top">configuracion</td><td valign="top">Objeto</td><td valign="top"> </td></tr><tr><td valign="top">cantidadMaximaCuotas</td><td valign="top">Int</td><td valign="top"><p>Cantidad máxima de cuotas en meses permitidas cuando se permite el pago en cuotas.</p><p>·       Uno = 1</p><p>·       Dos =2</p><p>·       Tres = 3</p><p>·       Cuatro = 4</p><p>·       Cinco = 5</p><p>·       Seis = 6</p><p>·       Siete =7</p><p>·       Ocho = 8</p><p>·       Nueve = 9</p><p>·       Diez = 10</p><p>·       Once =11</p><p>·       Doce = 12</p><p>·       Dieciocho=18</p><p>·       Veinticuatro = 24</p><p>·       Treintayseis = 36</p></td></tr><tr><td valign="top">transacciones</td><td valign="top">Lista Objeto Transacción</td><td valign="top">Listado de transacciones realizadas con el enlace de pago</td></tr><tr><td valign="top">nombreAplicativo</td><td valign="top">String</td><td valign="top">Nombre del negocio al que pertenece el enlace de pago</td></tr><tr><td valign="top">cantidadPagosExitosos</td><td valign="top">Int</td><td valign="top">Cantidad de pago exitosos que ha tenido el enlace de pago</td></tr><tr><td valign="top">imagenes</td><td valign="top">Lista</td><td valign="top">Listado de imágenes relacionadas al enlace de pago</td></tr><tr><td valign="top">vigencia</td><td valign="top">Objeto</td><td valign="top"> </td></tr><tr><td valign="top">limitesDeUso</td><td valign="top">Objeto</td><td valign="top"> </td></tr><tr><td valign="top">datosAdicionales</td><td valign="top">Objeto (Diccionario)</td><td valign="top">Datos adicionales relacionados al enlace de pago</td></tr><tr><td valign="top">idGrupoTarjetas</td><td valign="top">String</td><td valign="top">Identificador del grupo de tarjetas al cual está reStringido el enlace de pago</td></tr><tr><td valign="top">idEnlace</td><td valign="top">Int</td><td valign="top">Identificador del enlace de pago</td></tr><tr><td valign="top">urlQrCodeEnlace</td><td valign="top">String</td><td valign="top">URL de la imagen del código QR del enlace de pago</td></tr><tr><td valign="top">urlEnlace</td><td valign="top">String</td><td valign="top">URL del enlace de pago en su versión corta</td></tr><tr><td valign="top">estaProductivo</td><td valign="top">Bool</td><td valign="top">Indica si el enlace de pago está en modo producción y puede realizar transacciones reales</td></tr><tr><td valign="top">urlEnlaceLargo</td><td valign="top">String</td><td valign="top">URL del enlace de pago en su versión completa</td></tr></tbody></table>

### Objeto Transacción Compra

<table><thead><tr><th valign="top">Campo</th><th valign="top">Tipo Dato</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">transaccionCompra:datosAdicionales</td><td valign="top">Objeto (Diccionario)</td><td valign="top">Datos adicionales relacionados a la última transacción exitosa del enlace de pago</td></tr><tr><td valign="top">transaccionCompra:resultadoTransaccion</td><td valign="top">Int (puede ser nulo)</td><td valign="top"><p>Número relacionado al resultado de la transacción. Los valores pueden ser:</p><p>·       ExitosaAprobada = 0</p><p>·       ExitosaDeclinada = 1</p><p>·       Fallida = 2</p></td></tr><tr><td valign="top">transaccionCompra:fechaTransaccion</td><td valign="top">String (DateTimeOffset)</td><td valign="top">Fecha y hora de la transacción</td></tr><tr><td valign="top">transaccionCompra:montoOriginal</td><td valign="top">Decimal</td><td valign="top">Monto original de la transacción</td></tr><tr><td valign="top">transaccionCompra:idTransaccion</td><td valign="top">String</td><td valign="top">Identificador de la transacción</td></tr><tr><td valign="top">transaccionCompra:esReal</td><td valign="top">Bool</td><td valign="top">Indica si la transacción se trata de una compra real y no una de prueba</td></tr><tr><td valign="top">transaccionCompra:esAprobada</td><td valign="top">Bool</td><td valign="top">Indica si la transacción fue aprobada</td></tr><tr><td valign="top">transaccionCompra:codigoAutorizacion</td><td valign="top">String</td><td valign="top">Código de autorización de la transacción aprobada y real</td></tr><tr><td valign="top">transaccionCompra:mensaje</td><td valign="top">String</td><td valign="top">Incluye los mensajes relacionados a un error durante el procesamiento de la transacción</td></tr><tr><td valign="top">transaccionCompra:formaPago</td><td valign="top">Int</td><td valign="top"><p>Forma de pago utilizada para realizar la transacción. Las formas pueden ser:</p><p>·       PagoNormal = 0</p><p>·       Puntos = 1</p><p>·       Cuotas = 2</p><p>·       Bitcoin = 3</p><p>·       QuickPay = 4</p></td></tr><tr><td valign="top">transaccionCompra:monto</td><td valign="top">Decimal</td><td valign="top">Monto de la transacción (puede ser diferente al monto original si se realizó una devolución parcial)</td></tr><tr><td valign="top">transaccionCompra:idExterno</td><td valign="top">String</td><td valign="top">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)</td></tr></tbody></table>

### Objeto Forma Pago

<table><thead><tr><th valign="top">Campo</th><th valign="top">Tipo Dato</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">formaPago:permitirTarjetaCreditoDebido</td><td valign="top">Bool</td><td valign="top">Indica si el enlace de pago permite pagos con tarjetas de crédito o débito</td></tr><tr><td valign="top">formaPago:permitirPagoConPuntoAgricola</td><td valign="top">Bool</td><td valign="top">Indica si el enlace de pago permite pagos con puntos de Banco Agrícola</td></tr><tr><td valign="top">formaPago:permitirPagoEnCuotasAgricola</td><td valign="top">Bool</td><td valign="top">Indica si el enlace de pago permite pagos con cuotas de Banco Agrícola</td></tr><tr><td valign="top">formaPago:permitirPagoEnBitcoin</td><td valign="top">Bool</td><td valign="top">Indica si el enlace de pago permite pagos con Bitcoin</td></tr><tr><td valign="top">formaPago:permitePagoQuickPay</td><td valign="top">Bool</td><td valign="top">Indica si el enlace de pago permite pagos con QuickPay</td></tr><tr><td valign="top">infoProducto</td><td valign="top">Objeto</td><td valign="top"> </td></tr><tr><td valign="top">infoProducto:descripcionProducto</td><td valign="top">String</td><td valign="top">Descripción del producto relacionado al enlace de pago</td></tr><tr><td valign="top">infoProducto:urlImagenProducto</td><td valign="top">String</td><td valign="top">URL de la imagen del producto relacionado al enlace de pago</td></tr></tbody></table>

### Objeto Info Producto

<table><thead><tr><th valign="top">Campo</th><th valign="top">Tipo Dato</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">infoProducto:descripcionProducto</td><td valign="top">String</td><td valign="top">Descripción del producto relacionado al enlace de pago</td></tr><tr><td valign="top">infoProducto:urlImagenProducto</td><td valign="top">String</td><td valign="top">URL de la imagen del producto relacionado al enlace de pago</td></tr></tbody></table>

### Objeto Configuración

<table><thead><tr><th valign="top">Campo</th><th valign="top">Tipo Dato</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">configuracion:urlRedirect</td><td valign="top">String</td><td valign="top">URL a la cual redirecciona luego de realizar una transacción con el enlace de pago</td></tr><tr><td valign="top">configuracion:esMontoEditable</td><td valign="top">Bool</td><td valign="top">Indica si el monto del enlace de pago puede ser cambiado por el usuario</td></tr><tr><td valign="top">configuracion:esCantidadEditable</td><td valign="top">Bool</td><td valign="top">Indica si la cantidad del enlace de pago puede ser cambiada por el usuario</td></tr><tr><td valign="top">configuracion:cantidadPorDefecto</td><td valign="top">Int</td><td valign="top">Cantidad predeterminada del enlace de pago</td></tr><tr><td valign="top">configuracion:duracionInterfazIntentoMinutos</td><td valign="top">Int</td><td valign="top">Cantidad de minutos que debe durar la interfaz de pagos luego de abrirse</td></tr><tr><td valign="top">configuracion:urlRetorno</td><td valign="top">String</td><td valign="top">URL a la cual el usuario puede regresar al finalizar una transacción con éxito</td></tr><tr><td valign="top">configuracion:emailsNotificacion</td><td valign="top">String</td><td valign="top">Correos electrónicos separados por coma a los cuales se notificarán las transacciones.</td></tr><tr><td valign="top">configuracion:urlWebhook</td><td valign="top">String</td><td valign="top">URL del webhook al cual llegaran las transacciones exitosas relacionadas al enlace de pago</td></tr><tr><td valign="top">configuracion:telefonosNotificacion</td><td valign="top">String</td><td valign="top">Números de teléfono separados por coma a los cuales se notificarán las transacciones</td></tr><tr><td valign="top">configuracion:notificarTransaccionCliente</td><td valign="top">Bool</td><td valign="top">Indica si se debe notificar las transacciones a los correos electrónicos o números de teléfonos</td></tr></tbody></table>

### Objeto Transacción

<table><thead><tr><th valign="top">Campo</th><th valign="top">Tipo Dato</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">transacciones[n]:datosAdicionales</td><td valign="top">Objeto (Diccionario)</td><td valign="top">Datos adicionales relacionado a la transacción del enlace de pago</td></tr><tr><td valign="top">transacciones[n]:resultadoTransaccion</td><td valign="top">Int</td><td valign="top"><p>Número relacionado al resultado de la transacción. Los valores pueden ser:</p><p>·       ExitosaAprobada = 0</p><p>·       ExitosaDeclinada = 1</p><p>·       Fallida = 2</p></td></tr><tr><td valign="top">transacciones[n]:fechaTransaccion</td><td valign="top">String (DateTimeOffset)</td><td valign="top">Fecha y hora de la transacción</td></tr><tr><td valign="top">transacciones[n]:montoOriginal</td><td valign="top">Decimal</td><td valign="top">Monto original de la transacción</td></tr><tr><td valign="top">transacciones[n]:idTransaccion</td><td valign="top">String</td><td valign="top">Identificador de la transacción</td></tr><tr><td valign="top">transacciones[n]:esReal</td><td valign="top">Bool</td><td valign="top">Indica si la transacción se trata de una compra real y no una de prueba</td></tr><tr><td valign="top">transacciones[n]:esAprobada</td><td valign="top">Bool</td><td valign="top">Indica si la transacción fue aprobada</td></tr><tr><td valign="top">transacciones[n]:codigoAutorizacion</td><td valign="top">String</td><td valign="top">Código de autorización de la transacción aprobada y real</td></tr><tr><td valign="top">transacciones[n]:mensaje</td><td valign="top">String</td><td valign="top">Incluye los mensajes relacionados a un error durante el procesamiento de la transacción</td></tr><tr><td valign="top">transacciones[n]:formaPago</td><td valign="top">Int</td><td valign="top"><p>Forma de pago utilizada para realizar la transacción. Las formas pueden ser:</p><p>·       PagoNormal = 0</p><p>·       Puntos = 1</p><p>·       Cuotas = 2</p><p>·       Bitcoin = 3</p><p>·       QuickPay = 4</p></td></tr><tr><td valign="top">transacciones[n]:monto</td><td valign="top">Decimal</td><td valign="top">Monto de la transacción (puede ser diferente al monto original si se realizó una devolución parcial)</td></tr><tr><td valign="top">transacciones[n]:idExterno</td><td valign="top">String</td><td valign="top">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)</td></tr></tbody></table>

### Objeto Imagenes

<table><thead><tr><th valign="top">Campo</th><th valign="top">Tipo Dato</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">imagenes[m]:url</td><td valign="top">String</td><td valign="top">URL de la imagen</td></tr><tr><td valign="top">imagenes[m]:esPrincipal</td><td valign="top">Bool</td><td valign="top">Indica si la imagen es utilizada como principal al mostrarse en el intento de pago</td></tr></tbody></table>

### Objeto Vigencia

<table><thead><tr><th valign="top">Campo</th><th valign="top">Tipo Dato</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">vigencia:fechaInicio</td><td valign="top">String (DateTimeOffset)</td><td valign="top">Fecha de inicio en el rango de vigencia</td></tr><tr><td valign="top">vigencia:fechaFin</td><td valign="top">String (DateTimeOffset)</td><td valign="top">Fecha fin en el rango de vigencia</td></tr></tbody></table>

### Objeto Limites de Uso

<table><thead><tr><th valign="top">Campo</th><th valign="top">Tipo Dato</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">limitesDeUso:cantidadMaximaPagosExitosos</td><td valign="top">Int</td><td valign="top">Cantidad máxima de pagos exitosos que se pueden realizar con el enlace de pago</td></tr><tr><td valign="top">limitesDeUso:cantidadMaximaPagosFallidos</td><td valign="top">Int</td><td valign="top">Cantidad máxima de pagos fallidos que se pueden realizar con el enlace de pago</td></tr></tbody></table>

### Ejemplo de Respuesta

```
{
  "paginaActual": 0,
  "cantidadPorPagina": 0,
  "totalDeElementos": 0,
  "resultado": [
    {
      "idAplicativo": "string",
      "nombreEnlace": "string",
      "monto": 0,
      "nombreProducto": "string",
      "usable": true,
      "transaccionCompra": {
        "datosAdicionales": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "resultadoTransaccion": 0,
        "fechaTransaccion": "2026-03-10T14:01:30.248Z",
        "montoOriginal": 0,
        "idTransaccion": "string",
        "esReal": true,
        "esAprobada": true,
        "codigoAutorizacion": "string",
        "mensaje": "string",
        "formaPago": 0,
        "monto": 0,
        "idExterno": "string"
      },
      "cantidadIntentoPagoFallidos": 0,
      "formaPago": {
        "permitirTarjetaCreditoDebido": true,
        "permitirPagoConPuntoAgricola": true,
        "permitirPagoEnCuotasAgricola": true,
        "permitirPagoEnBitcoin": true,
        "permitePagoQuickPay": true
      },
      "infoProducto": {
        "descripcionProducto": "string",
        "urlImagenProducto": "string"
      },
      "configuracion": {
        "urlRedirect": "string",
        "esMontoEditable": true,
        "esCantidadEditable": true,
        "cantidadPorDefecto": 0,
        "duracionInterfazIntentoMinutos": 0,
        "urlRetorno": "string",
        "emailsNotificacion": "string",
        "urlWebhook": "string",
        "telefonosNotificacion": "string",
        "notificarTransaccionCliente": true
      },
      "cantidadMaximaCuotas": 0,
      "transacciones": [
        {
          "datosAdicionales": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "resultadoTransaccion": 0,
          "fechaTransaccion": "2026-03-10T14:01:30.248Z",
          "montoOriginal": 0,
          "idTransaccion": "string",
          "esReal": true,
          "esAprobada": true,
          "codigoAutorizacion": "string",
          "mensaje": "string",
          "formaPago": 0,
          "monto": 0,
          "idExterno": "string"
        }
      ],
      "nombreAplicativo": "string",
      "cantidadPagosExitosos": 0,
      "imagenes": [
        {
          "url": "string",
          "esPrincipal": true
        }
      ],
      "vigencia": {
        "fechaInicio": "2026-03-10T14:01:30.248Z",
        "fechaFin": "2026-03-10T14:01:30.248Z"
      },
      "limitesDeUso": {
        "cantidadMaximaPagosExitosos": 0,
        "cantidadMaximaPagosFallidos": 0
      },
      "datosAdicionales": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "idGrupoTarjetas": "string",
      "idEnlace": 0,
      "urlQrCodeEnlace": "string",
      "urlEnlace": "string",
      "estaProductivo": true,
      "urlEnlaceLargo": "string"
    }
  ],
  "totalPaginas": 0
}
```
