# Introducción

Vista general de las funcionalidades del API de Wompi.

## 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 usted no tenga que generar su propia pantalla de pago acelerando de esta manera el proceso de desarrollo.

{% content-ref url="/pages/-MB516CISujPBe1v7Zi7" %}
[Crear Enlace de Pago](/metodos-api/enlace-de-pago)
{% endcontent-ref %}

## Transacción Compra

Permite ejecutar una transacción de comprar enviando al API los datos del método de pago del cliente. Este método de utiliza cuando no se desea utilizar la interfaz de pago de Wompi sino que mantener al usuario en el sitio del comercio afiliado.

{% content-ref url="/pages/-MBeBRBs3lBfgq38oYjJ" %}
[Broken mention](broken://pages/-MBeBRBs3lBfgq38oYjJ)
{% endcontent-ref %}

{% content-ref url="/pages/cWDgZC9Rnq5BWo1NAr2y" %}
[Crear Transacción Compra con 3DS](/metodos-api/crear-transaccion-compra-3ds)
{% endcontent-ref %}

## Webhooks

Los webhook consisten en una petición HTTP Post generada por Wompi hacia la URL que el comercio ha definido como webhook.

{% hint style="info" %}
Los webhook son la principal forma de notificación de transacciones exitosas utilizada por Wompi.
{% endhint %}

{% content-ref url="/pages/-MBfQXZdiHaS6i2YEOdU" %}
[Definición Webhook](/webhook/definicion-webhook)
{% endcontent-ref %}


# Autenticación

{% hint style="info" %}
POST <https://id.wompi.sv/connect/token>
{% endhint %}

La autenticación del API de Wompi se realiza utilizando [OAuth 2.0 con Client Credential Flow](https://tools.ietf.org/html/rfc6749#section-4.4).&#x20;

Este es un standard ampliamente documentado para cualquier lenguaje de programación y la mayor parte de lenguajes  ya cuentan con librerías que facilitan la implementación del OAuth 2.0. Algunos ejemplos:

{% tabs %}
{% tab title="C#" %}

```
var client = new RestClient("https://id.wompi.sv/connect/token");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/x-www-form-urlencoded");
request.AddParameter("application/x-www-form-urlencoded", "grant_type=client_credentials&client_id=%24%7Baccount.clientId%7D&client_secret=YOUR_CLIENT_SECRET&audience=YOUR_API_IDENTIFIER", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

{% endtab %}

{% tab title="PHP" %}

```
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://id.wompi.sv/connect/token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "grant_type=client_credentials&client_id=%24%7Baccount.clientId%7D&client_secret=YOUR_CLIENT_SECRET&audience=YOUR_API_IDENTIFIER",
  CURLOPT_HTTPHEADER => array(
    "content-type: application/x-www-form-urlencoded"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

{% endtab %}

{% tab title="JAVA" %}

```
HttpResponse<String> response = Unirest.post("https://id.wompi.sv/connect/token")
  .header("content-type", "application/x-www-form-urlencoded")
  .body("grant_type=client_credentials&client_id=%24%7Baccount.clientId%7D&client_secret=YOUR_CLIENT_SECRET&audience=YOUR_API_IDENTIFIER")
  .asString();
```

{% endtab %}

{% tab title="cURL" %}

```
curl --request POST \
  --url 'https://YOUR_DOMAIN/oauth/token' \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data grant_type=client_credentials \
  --data 'client_id=YOUR_CLIENT_ID' \
  --data client_secret=YOUR_CLIENT_SECRET \
  --data audience=YOUR_API_IDENTIFIER
```

{% endtab %}
{% endtabs %}

## Parametros a Utilizar

**Url para extraer token:** <https://id.wompi.sv/connect/token>

### Parametros del POST

* **grant\_type:** Dejar siempre client\_credentials.&#x20;
* **audience:** Dejar siempre "wompi\_api"
* **client\_id:** El client id del negocio de wompi bajo el cual desea ejecutar la acción en el api
* **client\_secret:** Es la llave secreta del negocio de wompi bajo el cual desea ejecutar la acción en el api

### Objeto JSON Retornado

```
{
  "access_token":"eyJz93a...k4laUWw",
  "expires_in": 3600,
  "token_type": "Bearer",
  "scope": "wompi_api"
}
```

Donde:

* **access\_token:** contiene el token de autenticación
* **expires\_in:** la duración del token en segundos (no es necesario obtener un token para cada petición)

## Obtener las Credenciales de Autenticación

Como se menciono anteriormente los únicos dos parámetros que no son fijos necesarios para hacer la petición son:

* **client\_id:** El client id del negocio de wompi bajo el cual desea ejecutar la acción en el api
* **client\_secret:** Es la llave secreta del negocio de wompi bajo el cual desea ejecutar la acción en el api

Estos parámetros se obtiene desde el [Panel de Control](https://panel.wompi.sv) de Wompi.&#x20;

<figure><img src="/files/aj99fYTSDeN5fqyrKKn1" alt="Ingresar al listado de aplicativos y editar el aplicativo deseado"><figcaption><p>Ingresar al listado de negocios y editar el negocio deseado</p></figcaption></figure>

<figure><img src="/files/ChmA6mJODMoSPWmJFE7m" alt=""><figcaption><p>Detalle negocio</p></figcaption></figure>

Una vez en el detalle del negocio el **App ID** corresponde a **client\_id** y **API Secret** a **client\_secret** de la petición OAuth

## Utilización de Token

Para utilizar el token solo hay que agregar un header HTTP en todas las peticiones al API:

* **Nombre header:** authorization
* **Valor Header:** Bearer ACCESS\_TOKEN

Donde "ACCESS\_TOKEN" es la token regresada en el proceso de autenticación mencionado previamente

{% tabs %}
{% tab title="C#" %}

```
var client = new RestClient("https://api.wompi.sv/EnlacePago");
var request = new RestRequest(Method.GET);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "Bearer ACCESS_TOKEN");
IRestResponse response = client.Execute(request);
```

{% endtab %}

{% tab title="PHP" %}

```
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.wompi.sv/EnlacePago",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "authorization: Bearer ACCESS_TOKEN",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

{% endtab %}

{% tab title="Java" %}

```
HttpResponse<String> response = Unirest.get("https://api.wompi.sv/EnlacePago")
  .header("content-type", "application/json")
  .header("authorization", "Bearer ACCESS_TOKEN")
  .asString();
```

{% endtab %}

{% tab title="cURL" %}

```
curl --request GET \
  --url https://api.wompi.sv/EnlacePago \
  --header 'authorization: Bearer ACCESS_TOKEN' \
  --header 'content-type: application/json'
```

{% endtab %}
{% endtabs %}


# 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

{% hint style="info" %}
POST [/EnlacePago](https://api.wompi.sv)
{% endhint %}

## Ejemplo Pantalla de Pago Generada por Wompi

<figure><img src="/files/IlJK11o0d5QtpbofNerH" alt=""><figcaption><p>Ejemplo de interfaz de pago</p></figcaption></figure>

## 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,
    "permitirPagoEnBitcoin": true,
    "permitePagoQuickPay": true,
  },
  "cantidadMaximaCuotas": "Tres",
  "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
  },
  "vigencia": {
    "fechaInicio": "2025-06-25T15:45:19.206Z",
    "fechaFin": "2025-06-25T15:45:19.206Z"
  },
  "limitesDeUso": {
    "cantidadMaximaPagosExitosos": 0,
    "cantidadMaximaPagosFallidos": 0
  },
  "idGrupoTarjetas": "string"
}
```

#### 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                | Si su cuenta es tiene la configuración por defecto los valores pueden ser uno de los siguientes valores: Tres, Seis, Nueve, Doce. Si su cuenta es un "Payment Gateway" negociado de manera externa con Banco Agrícola es necesario invocar el End Point de "[Datos Negocio](/metodos-api/datos-aplicativo)" para ver las cuotas que tiene disponibles. |
| idGrupoTarjetas             | No        | String              | Este id corresponde al grupo de tarjeta que delimitará con cuales tarjetas podrá ser utilizado el enlace. Este Id se encuentra en la sección de "Grupos de tarjetas" del panel de Wompi                                                                                                                                                                |
| 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.                                                                                                                                                                                         |
| Vigencia                    | No        | EnlaceVigencia      | Parámetros adicionales para definir la vigencia del enlace. Ver detalles del objeto mas adelante                                                                                                                                                                                                                                                       |
| LimitesDeUso                | No        | EnlaceLimitesDeUso  | Parámetros adicionales para definir los límites de uso de un enlace de pago. Ver detalles del objeto mas 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. Para estar seguro que su negocio soporta pago con puntos puede confirmarlo con el end point de "[Datos Negocio](/metodos-api/datos-aplicativo)"                       |
| permitirPagoEnCuotasAgricola  | Si        | bool      | Si es "verdadero" el cliente puede realizar el pago en cuotas con tarjetas de crédito de Banco Agrícola. Para estar seguro que su negocio soporta pago en cuotas puede confirmarlo con el end point de "[Datos Negocio](/metodos-api/datos-aplicativo)" |
| permitirPagoEnBitcoin         | Si        | bool      | Si es "verdadero" el cliente puede realizar un pago con bitcoin. Para estar seguro que su negocio soporta pago en cuotas puede confirmarlo con el end point de "[Datos Negocio](/metodos-api/datos-aplicativo)"                                         |
| &#xD;&#xD;permitePagoQuickPay | Si        | bool      | Si es "verdadero" el clientw puede realizar un pago con Quick Pay. Para estar seguro que su negocio soporta pago en cuotas puede confirmarlo con el end point de "[Datos Negocio](/metodos-api/datos-aplicativo)"                                       |

{% hint style="info" %}
**Validación Adicional a Considerar:** Al menos uno de los valores de este objeto tiene que ser "verdadero"
{% endhint %}

#### 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"

<table data-header-hidden><thead><tr><th>Campo</th><th width="103">Requerido</th><th width="91">Tipo Dato</th><th>Descripción</th></tr></thead><tbody><tr><td>urlRedirect</td><td>No</td><td>Url</td><td>Url donde se redireccionará al cliente después del pago, si no se especifica se usa la del negocio.<br><br>En los parámetros se incluye si la transacción fue exitosa o no. Es importante validar el hash para detectar si los parámetros no han sido modificados en tránsito. Para esto se puede ver el ejemplo de cómo se genera el hash aquí: <a href="/pages/-MDbIu_MpGtwuVzWOqgT">Ejemplo Hash</a>.<br><br>El texto al que se le genera el hash es la concatenación de estos parámetros agregados a la URL: <em>idTransaccion + monto + esReal + formaPago + esAprobada + codigoAutorizacion + mensaje</em></td></tr><tr><td>EsMontoEditable</td><td>No</td><td>bool</td><td>Indica que el cliente puede editar el monto de la compra en la interfaz de pago. Normalmente el dato debe ser "falso"</td></tr><tr><td>EsCantidadEditable</td><td>No</td><td>bool</td><td>Indica que el cliente puede editar la cantidad de productos e comprar en la interfaz de pago. </td></tr><tr><td>CantidadPorDefecto</td><td>No</td><td>bool</td><td>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. </td></tr><tr><td>duracionInterfazIntentoMinutos</td><td>No</td><td>entero</td><td>Define cuanto tiempo es válida la interfaz de pago en minutos depues que se le presneto en pantalla al cliente. Si se hace un pago despues de pasado ese tiempo este no se procesará.</td></tr><tr><td>urlRetorno</td><td>No</td><td>Url</td><td>En la interfaz de pago antes que el usuairo ingrese su tarjeta se mustra un boton de regresar. Este parametro especifica a que URL debe apuntar ese botón. Si no se espcificá el botón lleva a la página  anterior.</td></tr><tr><td>emailsNotificacion</td><td>No</td><td>string</td><td>Lista de correos electrónicos divididos por coma a los que se enviará una notificación si la transacción es exitosa.</td></tr><tr><td>urlWebhook</td><td>No</td><td>url</td><td>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<a href="/pages/-MBfQXZdiHaS6i2YEOdU"> Webhook</a>.</td></tr><tr><td>telefonosNotificacion</td><td>No</td><td>string</td><td>Lista de numeros celulares del comercio, dividido por comas donde se notificará por SMS la ejecución exitosa de la transacción</td></tr><tr><td>notificarTransaccionCliente</td><td>Si</td><td>bool</td><td>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.</td></tr></tbody></table>

{% hint style="danger" %}
Aún cuando la urlWebhook y emailsNotificación son opcionales es obligatorio que al menos uno de ellos no sea nulo.
{% endhint %}

#### Descripción objeto "EnlaceVigencia"

Estos campos opcionales son utilizados para definir un período de vigencia del enlace

<table data-header-hidden><thead><tr><th>Campo</th><th width="98">Requerido</th><th width="99">Tipo Dato</th><th>Descripción</th></tr></thead><tbody><tr><td>fechaInicio</td><td>No</td><td>Datetime</td><td>Fecha de inicio de vigencia del enlace</td></tr><tr><td>fechaFin</td><td>No</td><td>Datetime</td><td>Fecha de fin de vigencia del enlace</td></tr></tbody></table>

#### Descripción objeto "EnlaceLimitesDeUso"

Estos campos opcionales permiten definir los límites de uso del enlace en términos de cantidad de usos o consumo de crédito.

| Campo                       | Requerido | Tipo Dato | Descripción                                                              |
| --------------------------- | --------- | --------- | ------------------------------------------------------------------------ |
| cantidadMaximaPagosExitosos | No        | Entero    | Número máximo de veces que el enlace puede ser utilizado.                |
| cantidadMaximaPagosFallidos | No        | Entero    | Número máximo de pagos fallidos que el enlace soporta hasta inactivarse. |

## 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 negocio bajo el que se creo esta productivo, esta en desarrollo si el negocio bajo el que se creo esta en desarrollo. |


# Crear Transacción Compra con 3DS

Permite ejecutar una transacción de compra con 3DS enviando al API los datos del método de pago del cliente.

{% hint style="info" %}
POST [/TransaccionCompra/3DS](https://api.wompi.sv)
{% endhint %}

## Crear una transacción de compra con 3DS

### Descripción del Proceso

En síntesis el API funciona de la siguiente manera:

1. Desde el Back End del sistema se invoca el API y del objeto de retorno se toma la url del parámetro "urlCompletarPago3Ds"
2. Se redirecciona el explorador del usuario que desea pagar a esa URL
3. Luego se valida si el  pago fue exitoso o fallido ya se por la [URL de Redirect](/redirect-url/parametros-de-url-de-redirect) o el [Webhook](/webhook/definicion-webhook)

### Ejemplo de petición básica

En este ejemplo se incluyen solamente los parámetros obligatorios

```
{
  "tarjetaCreditoDebido": {
    "numeroTarjeta": "string",
    "cvv": "string",
    "mesVencimiento": 0,
    "anioVencimiento": 0
  },
  "monto": 0,
  "urlRedirect": "string",
  "nombre": "string",
  "apellido": "string",
  "email": "user@example.com",
  "ciudad": "string",
  "direccion": "string",
  "idPais": "string",
  "idRegion": "string",
  "codigoPostal": "string",
  "telefono": "string",
}
```

### Ejemplo de Respuesta

```
{
  "idTransaccion": "string",
  "esReal": true,
  "urlCompletarPago3Ds": "string",
  "monto": 0
}
```

## Objeto Completo de Petición

En la sección anterior se definió una petición básica para crear una transacción de compra con 3DS. En esta sección se detallan todas las propiedades opcionales que se pueden incluir.

### JSON Completo

```
{
  "tarjetaCreditoDebido": {
    "numeroTarjeta": "string",
    "cvv": "string",
    "mesVencimiento": 0,
    "anioVencimiento": 0
  },
  "monto": 0,
  "configuracion": {
    "emailsNotificacion": "string",
    "urlWebhook": "string",
    "telefonosNotificacion": "string",
    "notificarTransaccionCliente": true
  },
  "urlRedirect": "string",
  "nombre": "string",
  "apellido": "string",
  "email": "user@example.com",
  "ciudad": "string",
  "direccion": "string",
  "idPais": "string",
  "idRegion": "string",
  "codigoPostal": "string",
  "telefono": "string",
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}
```

#### Definición Campos Objeto Root

| Campo                | Es Requerido | Tipo Dato   | Descripción                                                                                                                                                                                                          |
| -------------------- | ------------ | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| monto                | si           | double      | El monto que se desea cargar a la tarjeta de crédito en la transacción                                                                                                                                               |
| email                | si           | string      | El e-mail del cliente que realiza la compra. Es de utilidad ya que allí es donde Wompi enviará una notificación de su compra al cliente su se activa dicha opción.                                                   |
| nombre               | si           | string      | Los nombres del cliente que realiza la compra.                                                                                                                                                                       |
| apellido             | si           | string      | Los apellidos del cliente que realiza la compra                                                                                                                                                                      |
| ciudad               | si           | string      | La ciudad indicada por el cliente                                                                                                                                                                                    |
| direccion            | si           | string      | Dirección del cliente                                                                                                                                                                                                |
| idPais               | si           | string      | Código ISO 3166-1 alpha2 para el país del cliente. Ver [/api/Regiones](https://api.wompi.sv)                                                                                                                         |
| idRegion             | si           | string      | Código ISO 3166-2 para el territorio del cliente. Ver [/api/Regiones](https://api.wompi.sv)                                                                                                                          |
| codigoPostal         | si           | string      | Código postal del cliente.                                                                                                                                                                                           |
| telefono             | si           | string      | Teléfono del cliente                                                                                                                                                                                                 |
| tarjetaCreditoDebito | si           | Objeto      | Ver definición de objeto abajo.                                                                                                                                                                                      |
| configuracion        | no           | Objeto      | Ver definición de objeto abajo. Solo se necesita si se desea utilizar una configuración diferente a la que esta definida a nivel de negocio.                                                                         |
| datosAdicionales     | no           | Diccionario | Permiten al cliente enviar una lista de Llave/Valor para identificar características adicionales de la transacción. Esta lista de Llave/Valor se entregan al comercio vía el [webhook](/webhook/definicion-webhook). |

#### Definición de Objeto tarjetaCreditoDebido

| Campo           | Es Requerido | Tipo Dato | Descripción                                                                                            |
| --------------- | ------------ | --------- | ------------------------------------------------------------------------------------------------------ |
| numeroTarjeta   | si           | string    | El numero de tarjeta sin espacios.                                                                     |
| cvv             | si           | string    | Una cadena de caracteres solo con números con el CVV de la tarjeta a la que se le desea hacer el cobro |
| mesVencimiento  | si           | entero    | El mes en que se vence la tarjeta                                                                      |
| anioVencimiento | si           | entero    | El año en que se vence la tarjeta                                                                      |

#### Objeto Configuración

| Campo                       | Es Requerido | Tipo Dato | Descripción                                                                                                                                                                                                                                                                                     |
| --------------------------- | ------------ | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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           | string    | 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](/webhook/definicion-webhook). |
| telefonosNotificacion       | No           | string    | Lista de telefonos dividida por comas a los que se enviará una notificación de esta transacción                                                                                                                                                                                                 |
| notificarTransaccionCliente | No           | 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.                                                                                                          |

#### Datos Adicionales

Permiten al cliente enviar una lista de Llave/Valor para identificar características adicionales de la transacción. Esta lista de Llave/Valor se entregan al comercio vía el [webhook](/webhook/definicion-webhook).

## Objeto de Respuesta

| Campo               | Tipo Dato | Descripción                                                                                                                                                                      |
| ------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| idTransaccion       | string    | Identificador único de la transacción                                                                                                                                            |
| esReal              | bool      | Verdadero si es un transacción ejecutada en producción, falso si es una transacción en desarrollo. La transacción en desarrollo no se cobra al cliente.                          |
| urlCompletarPago3Ds | string    | <p>URL para que el usuario pagador pueda completar el pago con 3DS. <br><br>El usuario que desea pagar debe redireccionarse a esta URL para que finalice el proceso de pago.</p> |
| monto               | decimal   | El monto cobrado en la transacción                                                                                                                                               |


# Crear Transacción Compra con Nequi

Permite ejecutar una transacción  de compra con nequi enviando al API los datos del método de pago del cliente

{% hint style="info" %}
POST /TransaccionCompra/Nequi
{% endhint %}

## Crear una transacción de compra con Nequi

### Ejemplo de petición básica&#x20;

En este ejemplo se incluyen solamente los parámetros obligatorios

```
{
	“monto”: 0,
	“dui”: “string”,
	“description”: “string”
}
```

### Ejemplo de respuesta

```
{
  "idTransaccion": "string",
  "esReal": true,
  "mensaje": "string",
  "formaPago": 0,
  "monto": 0,
  "idExterno": "string",
  "datosAdicionales":  {
	"additionalProp1": "string",
   	"additionalProp2": "string",
  	"additionalProp3": "string"
  },
  "resultadoTransaccion": "string",
  "fechaTransaccion": "2026-03-06T17:13:54.577Z"
}

```

### Objeto Completo de Petición&#x20;

En la sección anterior se definió una petición básica para crear transacción de compra con Nequi. En esta sección se detallan todas las propiedades opcionales que se pueden incluir.

### JSON Completo

```
{
	"monto": 0,
  "dui": "string",
  "descricion": "string",
  "configuracion": {
	    "emailsNotificacion": "string",
      "urlWebhook": "string",
      "telefonosNotificacion": "string",
      "notificarTransaccionCliente": true
  },
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "idExterno": "string"
}

```

### Definición Campos Objeto Root

| Campo            | Es Requerido | Tipo Dato   | Descripción                                                                                                                                                                                                                               |
| ---------------- | ------------ | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| monto            | Si           | double      | El monto que se desea cargar a la tarjeta de crédito en la transacción                                                                                                                                                                    |
| dui              | Si           | string      | El dui de la cuenta Nequi desde la cual se desea realizar el pago                                                                                                                                                                         |
| descripcion      | Si           | string      | La descripción del pago para Nequi                                                                                                                                                                                                        |
| configuracion    | No           | Objeto      | Ver definición de objeto abajo. Solo se necesita si se desea utilizar una configuración diferente a la que esta definida a nivel de negocio.                                                                                              |
| datosAdicionales | No           | Diccionario | Permiten al cliente enviar una lista de Llave/Valor para identificar características adicionales de la transacción. Esta lista de Llave/Valor se entregan al comercio vía el [webhook](https://docs.wompi.sv/webhook/definicion-webhook). |
| idExterno        | No           | string      | Id externo usado como referencia para el sistema que consume el api                                                                                                                                                                       |

### Objeto Configuración

| Campo                       | Es Requerido | Tipo Dato | Descripción                                                                                                                                                                                                                                                                                                          |
| --------------------------- | ------------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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           | string    | 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](https://docs.wompi.sv/webhook/definicion-webhook). |
| telefonosNotificacion       | No           | string    | Lista de telefonos dividida por comas a los que se enviará una notificación de esta transacción                                                                                                                                                                                                                      |
| notificarTransaccionCliente | No           | string    | 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.                                                                                                                               |

### Datos Adicionales

Permiten al cliente enviar una lista de Llave/Valor para identificar características adicionales de la transacción. Esta lista de Llave/Valor se entregan al comercio vía el [webhook](https://docs.wompi.sv/webhook/definicion-webhook).

### Objeto de respuesta

| Campo                | Tipo Dato   | Es Requerido                                                                                                                                            |
| -------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| idTransaccion        | string      | Identificador único de la transacción                                                                                                                   |
| esReal               | string      | Verdadero si es un transacción ejecutada en producción, falso si es una transacción en desarrollo. La transacción en desarrollo no se cobra al cliente. |
| mensaje              | string      | Mensaje introducido por el usuario.                                                                                                                     |
| formaPago            | nti         | Indica la forma de pago utilizada                                                                                                                       |
| monto                | decimal     | El monto cobrado en la transacción                                                                                                                      |
| idExterno            | string      | Identificador único dado por el usuario                                                                                                                 |
| datosAdicionales     | Diccionario | Dato adicionales dado por el usuario                                                                                                                    |
| resultadoTransaccion | string      | Indica el resultado de la transacción                                                                                                                   |
| fechaTransaccion     | DateTime    | Fecha en que la transacción fue realizada                                                                                                               |


# Ejecutar Transacciones de Prueba

Esta página detalla como hacer pruebas en el proceso integración con el API de Wompi.

## Modo de Prueba

Para activar el modo de prueba basta con colocar el negocio a utilizar en modo desarrollo. Para eso ingrese a su [Panel ](https://panel.wompi.sv)y asegúrese que el negocio a utilizar este en desarrollo.

<div align="center"><img src="/files/OIlCjtEVIjA9fCq1lOBg" alt="Opción para colocar negocio en desarrollo"></div>

## Simular Transacciones Denegadas

Por defecto todas las transacciones realizadas en modo desarrollo se autorizan como que el cobro fue exitoso. Para simular un cobro rechazado basta con enviar "111" (tres unos) en el dato de CVV, esto aplica para:

* Las transacciones realizadas desde la interfaz de pago (ya sea creadas con el [API de Enlace de Pago ](/metodos-api/enlace-de-pago)o desde un [botón de pago creado desde la interfaz administrativa](https://panel.wompi.sv/BotonPago/DetalleBotonPago/0).&#x20;

> Importante!
>
> No se pueden simular transacciones denegadas con 3DS, únicamente con pagos normales

## Transacciones de Prueba

El comercio se puede enterar de que una transacción se ejecuto en tres lugares:

* Por un e-mail de confirmación
* Por un Webhook
* En el reporte de transacciones

En esta sección especificamos como determinar si una transacción fue de prueba en cada uno de estos lugares.

### En E-Mail

Imagen de e-mail recibido al ejecutar transaccion:

<figure><img src="/files/kPb0hNngTKlaaXFLAe0K" alt=""><figcaption><p>E-Mail de Transacción</p></figcaption></figure>

### En Webhook

El webhook incluye la propiedad "esProductiva" que esta en "falso" cuando es una transacción de prueba. Es decir que si "esProductiva"  esta en "falso" en realidad no se realizo un cobro al cliente. Ver la definición del objeto del webhook [aqui](/webhook/definicion-webhook).

### En Reporte de Transacciones

Las transacciones de prueba no se reflejan en el [reporte de transacciones](https://panel.wompi.sv/TransaccionEstadistica), por lo tanto si la transacción esta en el reporte es porque es real.&#x20;


# Datos Negocio

Extra información relevante de su negocio en Wompi.

Este end point es de utilidad para poder consultar las formas de pago disponibles para su negocio y de esta manera ver cuales formas de pago son validas en los end point de "[Enlace Pago](/metodos-api/enlace-de-pago)" y "[Transaccion Compra](broken://pages/-MBeBRBs3lBfgq38oYjJ)".

{% hint style="info" %}
GET [/Aplicativo](https://api.wompi.sv)
{% endhint %}

## Consultar Datos de Negocio

### Objeto de Consulta

Este end point no requiere ningún dato de entrada para ejecutarse ya que el negocio a extraer se determina por medio de los datos de autenticación.

### Ejemplo de Respuesta

```
{
  "idAplicativo": "467a4b3f-d880-4e28-ac56-0ab08f6b0ddb",
  "clientIdApi": "467a4b3f-d880-4e28-ac56-0ab08f6b0ddb",
  "numeroCuenta": "Retail5",
  "nombre": "Web Bitworks",
  "urlAplicativo": "http://www.bitworks.com.sv/",
  "estaProductivo": false,
  "urlLogo": null,
  "aplicaPagoConPuntos": true,
  "aplicaPagoConBitcoin": true,
  "aplicaPagoConQuickPay": true,
  "cuotasDisponibles": [
    {
      "cantidadCuotas": 3,
      "tasa": 5
    },
    {
      "cantidadCuotas": 6,
      "tasa": 5.5
    }
  ]
}
```

## Objeto de Respuesta

| Campo                 | Tipo Dato | Descripción                                                                                                                                                                                                                                                                                                                      |
| --------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| idAplicativo          | string    | Identificador único del negocio                                                                                                                                                                                                                                                                                                  |
| clientIdApi           | string    | Identificador del negocio en el sistema de autenticación OAuth. Generalmente es el mismo valor que el idAplicativo.                                                                                                                                                                                                              |
| numeroCuenta          | string    | Número de cuenta en la que se  liquidan los pagos relacionados a este negocio                                                                                                                                                                                                                                                    |
| nombre                | string    | El nombre del negocio que se muestra a los clientes como nombre del comercio en el que pagan                                                                                                                                                                                                                                     |
| urlAplicativo         | string    | La URL del sitio asociada a ese negocio. Esta es una url meramente informativa.                                                                                                                                                                                                                                                  |
| estaProductivo        | bool      | Si es verdadero indica que el negocio se encuentra productivo y por ende los cobros realizados a través de este negocio serán reales. Si esta en falso todas las transacciones enviadas pro este negocio serán de prueba. Para poner productivo un negocio es necesario hacerlo en el [Panel de Wompi](https://panel.wompi.sv/). |
| urlLogo               | string    | Ell URL de logotipo de este negocio que se muestra a los clientes en la pantalla de pago.                                                                                                                                                                                                                                        |
| aplicaPagoConPuntos   | bool      | Si es verdadero indica que los clientes pueden pagar con puntos en este negocio, tanto a nivel de enlaces de pago como en el API de Transacciones.                                                                                                                                                                               |
| aplicaPagoConBitcoin  | bool      | Si es verdadero indica que los clientes puedan pagar con bitcoin en este negocio, tanto a nivel de enlaces de pago como en el API de Transacciones.                                                                                                                                                                              |
| aplicaPagoConQuickPay | bool      | Si es verdadero indica que los clientes pueden pagar con quick pay en este negocio, tanto a nivel de enlaces de pago con en el API de Transacciones.                                                                                                                                                                             |
| cuotasDisponibles     | Cuota     | Si el negocio tiene activo el pago en cuotas en esta lista se muestran las cuotas que están activas para el negocio, incluyendo la tasa de interés de cada una.                                                                                                                                                                  |

### Objeto "Cuota"

| Campo          | Tipo Dato | Descripción                                                                                                                    |
| -------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ |
| cantidadCuotas | entero    | indica en cuantas cuotas mensuales se le dividirá el pago al cliente                                                           |
| tasa           | decimal   | Indica la tasa que se cobra al comercio por la transacción cuando el cliente final utiliza la cantidad de cuotas especificada. |


# Tokenización

Este endpoint permite tokenizar una tarjeta  y así poderse usar en futuras transacciones únicamente enviando el CVV.

### Ejemplo de petición básica

{% hint style="info" %}
POST [/Tokenizacion](https://api.wompi.sv)
{% endhint %}

```json
{
  "numeroTarjeta": "string",
  "cvv": "string",
  "mesVencimiento": 0,
  "anioVencimiento": 0,
  "idGrupoTarjetas": "string"
}
```

### Definición de campos

| Campo           | Requerido | Tipo Dato | Descripción                                                                                                                                                                                                                                                                                                |
| --------------- | --------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| numeroTarjeta   | Si        | String    | Número de la tarjeta a tokenizar                                                                                                                                                                                                                                                                           |
| cvv             | Si        | String    | Número del CVV de la tarjeta                                                                                                                                                                                                                                                                               |
| mesVencimiento  | Si        | Entero    | Mes del vencimiento de la tarjeta                                                                                                                                                                                                                                                                          |
| anioVencimiento | Si        | Entero    | Año de vencimiento de la tarjeta                                                                                                                                                                                                                                                                           |
| idGrupoTarjetas | No        | String    | Este id corresponde al grupo de tarjeta que indicarán si la tarjeta puede ser tokenizada o no. Este Id se encuentra en la sección de "Grupos de tarjetas" del panel de Wompi. Este campo solo debe ser utilizado si se requiere una validación adicional para saber si se puede tokenizar o no la tarjeta. |


# Crear enlace pago recurrentes

En esta sección se describen los métodos disponibles en la sección de EnlacePagoRecurrente.

Este servicio puede ser utilizado para que los clientes se puedan suscribir y se les cargue mes a mes un monto definido por el comercio.

Posterior a creada la suscripción se les debe compartir a los clientes la urlEnlace para que puedan afiliarse al servicio. Esta afiliación debe ser aceptada manualmente por el usuario ya que está sujeta a términos y condiciones del servicio.

## Creación de la suscripción/ enlace cargo recurrente

Este método permite la creación de una suscripción a cargo recurrente que luego podrá ser compartida a los clientes finales que desean suscribirse.

{% hint style="info" %}
POST [/EnlacePagoRecurrente](https://api.wompi.sv)
{% endhint %}

### Objeto de petición

```json
{
  "diaDePago": 0,
  "nombre": "string",
  "idAplicativo": "string",
  "monto": 0,
  "descripcionProducto": "string"
}
```

### Definición de campos

| Campo               | Requerido | Tipo Dato | Descripción                                                                                          |
| ------------------- | --------- | --------- | ---------------------------------------------------------------------------------------------------- |
| diaDePago           | Si        | Entero    | Día del mes en el cual se realizará el cargo a los clientes                                          |
| nombre              | Si        | String    | Nombre de la suscripción (servicio) a cobrarle a los clientes                                        |
| idAplicativo        | Si        | String    | Id del negocio asociado al cargo recurrente.  (APP ID dentro del panel, en el detalle de un negocio) |
| monto               | Si        | Decimal   | Monto del pago recurrente                                                                            |
| descripcionProducto | Si        | String    | Descripción del producto o servicio a brindarle al cliente.                                          |

### Respuesta de endpoint

JSON de ejemplo

```json
{
  "idEnlace": "string",
  "urlEnlaceLargo": "string",
  "urlEnlace": "string",
  "estaProductivo": true,
  "urlQrCodeEnlace": "string"
}
```

### Descripción de campos de respuesta

| Campo           | Tipo Dato | Descripción                                                                         |
| --------------- | --------- | ----------------------------------------------------------------------------------- |
| idEnlace        | String    | Identificador único de la suscripción                                               |
| urlEnlaceLargo  | String    | Url larga del cargo recurrentepara que los clientes puedan suscribirse              |
| urlEnlace       | String    | Url corta del cargo recurrente para que los clientes puedan suscribirse             |
| estaProductivo  | Boolean   | Indicativo si se encuentra activo o no la suscripción del cargo recurrente          |
| urlQrCodeEnlace | String    | URL con la imagen del código QR para poderla compartir como comercio a sus clientes |

## Otros endpoints disponibles

| Endpoint                                                                                                                                                                     | Descripción                                                                |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>GET <a href="https://api.wompi.sv">/EnlacePagoRecurrente/id</a></p></div>              | Endpoint para obtener la información de un enlace recurrente (suscripción) |
| <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>POST <a href="https://api.wompi.sv">/EnlacePagoRecurrente/id</a></p></div>             | Permite desactivar un enlace recurrente (suscripción)                      |
| <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>PUT <a href="https://api.wompi.sv">/EnlacePagoRecurrente/id</a></p></div>              | Permite editar un enlace recurrente (suscripción)                          |
| <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>GET <a href="https://api.wompi.sv">/EnlacePagoRecurrente</a></p></div>                 | Obtiene la lista de enlaces recurrentes de la cuenta                       |
| <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>DELETE <a href="https://api.wompi.sv">/EnlacePagoRecurrente/id/imagen</a></p></div>    | Elimina la imagen del enlace recurrente                                    |
| <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>POST <a href="https://api.wompi.sv">/EnlacePagoRecurrente/id/imagen</a></p></div>      | Permite agregar una imagen (bytes) a un enlace recurrente                  |
| <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>GET <a href="https://api.wompi.sv">/EnlacePagoRecurrente/id/suscrpciones</a></p></div> | Obtiene todos los suscritos a un enlace recurrente                         |


# Obtener Negocio

Permite obtener un Negocio por su Id.

{% hint style="info" %}
GET /Aplicativo/{idAplicativo}
{% endhint %}

### Parámetros de ruta:

| Campo        | Es Requerido | Tipo Dato | Descripción                         |
| ------------ | ------------ | --------- | ----------------------------------- |
| idAplicativo | Si           | string    | <p>Identificador del<br>negocio</p> |

### Objeto de respuesta:

<table><thead><tr><th>Campo</th><th width="249">Tipo Dato</th><th>Descripción</th></tr></thead><tbody><tr><td>idAplicativo</td><td>string</td><td>Identificador del negocio</td></tr><tr><td>clientIdApi</td><td>string</td><td>Identificador del cliente para autenticarse con un negocio</td></tr><tr><td>clientSecret</td><td>string</td><td>Secreto del cliente para autenticarse con negocio</td></tr><tr><td>numeroCuenta</td><td>string</td><td>Número de cuenta de banco relacionada al negocio</td></tr><tr><td>nombre</td><td>string</td><td>Nombre del negocio</td></tr><tr><td>urlAplicativo</td><td>string</td><td>URL relacionada al negocio</td></tr><tr><td>estaProductivo</td><td>bool</td><td>Indica si el negocio está en modo productivo</td></tr><tr><td>urlLogo</td><td>string</td><td>URL de la imagen del logo relacionado al negocio</td></tr><tr><td>aplicaPagoConPuntos</td><td>bool</td><td>Indica si el negocio aplica para pagos con puntos del Banco Agrícola</td></tr><tr><td>aplicaPagoConBitcoin</td><td>bool</td><td>Indica si el negocio aplica para pagos con Bitcoin</td></tr><tr><td>aplicaPagoConQuickPay</td><td>bool</td><td>Indica si el negocio aplica para pagos con QR QuickPay</td></tr><tr><td>cuotasDisponibles</td><td>Lista Objeto CantidadCuotas</td><td>Listado de las cuotas disponibles para el negocio</td></tr></tbody></table>

### Objeto CantidadCoutas:

| Campo          | Tipo Dato | Descripción                               |
| -------------- | --------- | ----------------------------------------- |
| cantidadCuotas | int       | Número que indica la cantidad de la cuota |
| tasa           | int       | Porcentaje de Interés que tiene la cuota  |

### Ejemplo de respuesta

```
{
  "idAplicativo": "string",
  "clientIdApi": "string",
  "clientSecret": "string",
  "numeroCuenta": "string",
  "nombre": "string",
  "urlAplicativo": "string",
  "estaProductivo": true,
  "urlLogo": "string",
  "aplicaPagoConPuntos": true,
  "aplicaPagoConBitcoin": true,
  "aplicaPagoConQuickPay": true,
  "cuotasDisponibles": [
    {
      "cantidadCuotas": 1,
      "tasa": 0
    }
  ],
  "tapOnPhone": {
    "usuarioEnrolo": "string",
    "fechaEnrolamiento": "2026-03-10T13:43:54.627Z",
    "deviceId": "string",
    "retailerId": "string",
    "terminalId": "string"
  }
}
```


# Obtener Cuenta

Consulta los datos de la cuenta con el cual está actualmente autenticado, incluyendo la información del listado de negocio.

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

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

### Objeto de respuesta:

| Campo                  | Tipo Dato               | Descripciñon                                                                   |
| ---------------------- | ----------------------- | ------------------------------------------------------------------------------ |
| idCuenta               | string                  | Identificador de la cuenta Wompi                                               |
| emailLogin             | string                  | Correo electrónico de inicio de sesión relacionado a la cuenta Wompi           |
| tipoPersoneria         | string                  | <p>Tipo de persona. Los valores pueden ser:</p><p>-Natural</p><p>-Jurídica</p> |
| nit                    | string (null o vacio)   | Número de Identificación Tributaria                                            |
| nombreCompletoContacto | string                  | Nombre completo de contacto del propietario de la cuenta                       |
| nombreCuenta           | string                  | Nombre de la cuenta Wompi                                                      |
| nombreComercial        | string                  | Nombre comercial de la cuenta                                                  |
| razonSocial            | string (null)           | razonSocial                                                                    |
| fechaRegistro          | string (DateTimeOffset) | Fecha y hora de creación de la cuenta Wompi                                    |
| actividadEconomica     | string                  | Actividad económica de la cuenta Wompi                                         |
| direccion              | string                  | Dirección del propietario de la cuenta Wompi                                   |
| urbanizacion           | string                  | Urbanización                                                                   |
| calle                  | string                  | Calle                                                                          |
| local                  | string                  | Local                                                                          |
| aplicativos            | Listado Objeto Negocio  | Listado de negocio relacionados a la cuenta Wompi                              |

### Objeto Negocio

| Campo                 | Tipo Dato                    | Descripcion                                                          |
| --------------------- | ---------------------------- | -------------------------------------------------------------------- |
| idAplicativo          | string                       | Identificador del negocio                                            |
| clientIdApi           | string                       | Identificador del cliente para autenticarse con un negocio           |
| clientSecret          | string                       | Secreto del cliente para autenticarse con negocio                    |
| numeroCuenta          | string                       | Número de cuenta de banco relacionada al negocio                     |
| nombre                | string                       | Nombre del negocio                                                   |
| urlAplicativo         | string                       | URL relacionada al negocio                                           |
| estaProductivo        | bool                         | Indica si el negocio está en modo productivo                         |
| urlLogo               | string                       | URL de la imagen del logo relacionado al negocio                     |
| aplicaPagoConPuntos   | bool                         | Indica si el negocio aplica para pagos con puntos del Banco Agrícola |
| aplicaPagoConBitcoin  | bool                         | Indica si el negocio aplica para pagos con Bitcoin                   |
| aplicaPagoConQuickPay | bool                         | Indica si el negocio aplica para pagos con QR QuickPay               |
| cuotasDisponibles     | Lista Objeto CuotaDisponible | Listado de las cuotas disponibles para el negocio                    |
| tapOnPhone            | Object (null)                | Datos de TapOnPhone relacionados al negocio                          |

### Objeto CuotaDisponible

|                |     |                                           |
| -------------- | --- | ----------------------------------------- |
| cantidadCuotas | int | Número que indica la cantidad de la cuota |
| tasa           | int | Porcentaje de Interés que tiene la cuota  |

### Objeto TapOnPhone

|                   |                         |                                                             |
| ----------------- | ----------------------- | ----------------------------------------------------------- |
| usuarioEnrolo     | string                  | Usuario que vinculó el negocio a la App de Wompi            |
| fechaEnrolamiento | String (DateTimeOffset) | Fecha y hora en que se vinculó el negocio a la App de Wompi |
| deviceId          | string                  | Identificador del dispositivo vinculado al negocio          |
| retailerId        | string                  | Identificador del comercio de tipo TapOnPhone               |
| terminalId        | string                  | Identificador de la terminal de tipo TapOnPhone             |

### Ejemplo de Respuesta

```
{
  "idCuenta": "string",
  "emailLogin": "string",
  "tipoPersoneria": 0,
  "nit": "string",
  "nombreCompletoContacto": "string",
  "nombreCuenta": "string",
  "nombreComercial": "string",
  "razonSocial": "string",
  "fechaRegistro": "2026-03-10T13:48:57.376Z",
  "actividadEconomica": "string",
  "direccion": "string",
  "urbanizacion": "string",
  "calle": "string",
  "local": "string",
  "aplicativos": [
    {
      "idAplicativo": "string",
      "clientIdApi": "string",
      "clientSecret": "string",
      "numeroCuenta": "string",
      "nombre": "string",
      "urlAplicativo": "string",
      "estaProductivo": true,
      "urlLogo": "string",
      "aplicaPagoConPuntos": true,
      "aplicaPagoConBitcoin": true,
      "aplicaPagoConQuickPay": true,
      "cuotasDisponibles": [
        {
          "cantidadCuotas": 1,
          "tasa": 0
        }
      ],
      "tapOnPhone": {
        "usuarioEnrolo": "string",
        "fechaEnrolamiento": "2026-03-10T13:48:57.376Z",
        "deviceId": "string",
        "retailerId": "string",
        "terminalId": "string"
      }
    }
  ]
}
```


# Eliminar Cuenta

Permite eliminar la cuenta Wompi

{% hint style="info" %}
DELETE /Cuenta
{% endhint %}

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

### Objeto de respuesta:

| Campo                  | Tipo Dato               | Descripción                                                                    |
| ---------------------- | ----------------------- | ------------------------------------------------------------------------------ |
| idCuenta               | string                  | Identificador de la cuenta Wompi                                               |
| emailLogin             | string                  | Correo electrónico de inicio de sesión relacionado a la cuenta Wompi           |
| tipoPersoneria         | string                  | <p>Tipo de persona. Los valores pueden ser:</p><p>-Natural</p><p>-Jurídica</p> |
| nit                    | string (null o vacio)   | Número de Identificación Tributaria                                            |
| nombreCompletoContacto | string                  | Nombre completo de contacto del propietario de la cuenta                       |
| nombreCuenta           | string                  | Nombre de la cuenta Wompi                                                      |
| nombreComercial        | string                  | Nombre comercial de la cuenta                                                  |
| razonSocial            | string (null)           | razonSocial                                                                    |
| fechaRegistro          | string (DateTimeOffset) | Fecha y hora de creación de la cuenta Wompi                                    |
| actividadEconomica     | string                  | Actividad económica de la cuenta Wompi                                         |
| direccion              | string                  | Dirección del propietario de la cuenta Wompi                                   |
| urbanizacion           | string                  | Urbanización                                                                   |
| calle                  | string                  | Calle                                                                          |
| local                  | string                  | Local                                                                          |
| aplicativos            | Listado Objeto Negocio  | Listado de negocio relacionados a la cuenta Wompi                              |

### Objeto Negocio

| Campo                 | Tipo Dato                    | Descripción                                                          |
| --------------------- | ---------------------------- | -------------------------------------------------------------------- |
| idAplicativo          | string                       | Identificador del negocio                                            |
| clientIdApi           | string                       | Identificador del cliente para autenticarse con un negocio           |
| clientSecret          | string                       | Secreto del cliente para autenticarse con negocio                    |
| numeroCuenta          | string                       | Número de cuenta de banco relacionada al negocio                     |
| nombre                | string                       | Nombre del negocio                                                   |
| urlAplicativo         | string                       | URL relacionada al negocio                                           |
| estaProductivo        | bool                         | Indica si el negocio está en modo productivo                         |
| urlLogo               | string                       | URL de la imagen del logo relacionado al negocio                     |
| aplicaPagoConPuntos   | bool                         | Indica si el negocio aplica para pagos con puntos del Banco Agrícola |
| aplicaPagoConBitcoin  | bool                         | Indica si el negocio aplica para pagos con Bitcoin                   |
| aplicaPagoConQuickPay | bool                         | Indica si el negocio aplica para pagos con QR QuickPay               |
| cuotasDisponibles     | Lista Objeto CuotaDisponible | Listado de las cuotas disponibles para el negocio                    |
| tapOnPhone            | Object (null)                | Datos de TapOnPhone relacionados al negocio                          |

### Objeto CuotaDisponible

| Campo          | Tipo Dato | Descripción                               |
| -------------- | --------- | ----------------------------------------- |
| cantidadCuotas | int       | Número que indica la cantidad de la cuota |
| tasa           | int       | Porcentaje de Interés que tiene la cuota  |

### Objeto TapOnPhone

| Campo             | Tipo Dato               | Descripción                                                 |
| ----------------- | ----------------------- | ----------------------------------------------------------- |
| usuarioEnrolo     | string                  | Usuario que vinculó el negocio a la App de Wompi            |
| fechaEnrolamiento | String (DateTimeOffset) | Fecha y hora en que se vinculó el negocio a la App de Wompi |
| deviceId          | string                  | Identificador del dispositivo vinculado al negocio          |
| retailerId        | string                  | Identificador del comercio de tipo TapOnPhone               |
| terminalId        | string                  | Identificador de la terminal de tipo TapOnPhone             |

### Ejemplo de respuesta

```
{
  "idCuenta": "string",
  "emailLogin": "string",
  "tipoPersoneria": 0,
  "nit": "string",
  "nombreCompletoContacto": "string",
  "nombreCuenta": "string",
  "nombreComercial": "string",
  "razonSocial": "string",
  "fechaRegistro": "2026-03-10T13:53:14.486Z",
  "actividadEconomica": "string",
  "direccion": "string",
  "urbanizacion": "string",
  "calle": "string",
  "local": "string",
  "aplicativos": [
    {
      "idAplicativo": "string",
      "clientIdApi": "string",
      "clientSecret": "string",
      "numeroCuenta": "string",
      "nombre": "string",
      "urlAplicativo": "string",
      "estaProductivo": true,
      "urlLogo": "string",
      "aplicaPagoConPuntos": true,
      "aplicaPagoConBitcoin": true,
      "aplicaPagoConQuickPay": true,
      "cuotasDisponibles": [
        {
          "cantidadCuotas": 1,
          "tasa": 0
        }
      ],
      "tapOnPhone": {
        "usuarioEnrolo": "string",
        "fechaEnrolamiento": "2026-03-10T13:53:14.486Z",
        "deviceId": "string",
        "retailerId": "string",
        "terminalId": "string"
      }
    }
  ]
}
```


# Registrar negocio Tap On Phone

Permite registrar un negocio para usarse como POS en un dispositivo móvil Android.

{% hint style="info" %}
POST /Cuenta/{idAplicativo}/TapOnPhone
{% endhint %}

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

### Parámetros de ruta:

| Campo        | Es Requerido | Tipo Dato | Descripcion               |
| ------------ | ------------ | --------- | ------------------------- |
| idAplicativo | si           | string    | Identificador del negocio |

### Objeto de petición:

| Campo    | Es Requerido | Tipo Dato | Descripción                                                       |
| -------- | ------------ | --------- | ----------------------------------------------------------------- |
| deviceId | Si           | string    | Identificador del dispositivo que se va a vincular con un negocio |

### Ejemplo de petición

```
{
  "deviceId": "string"
}
```


# Eliminar negocio Tap On Phone

Permite dejar de usar un negocio como POS en un dispositivo móvil Android

{% hint style="info" %}
DELETE /Cuenta/{idAplicativo}/TapOnPhone
{% endhint %}

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

### Parámetros de ruta:

| Campo        | Es Requerido | Tipo Dato | Descripción               |
| ------------ | ------------ | --------- | ------------------------- |
| idAplicativo | Si           | string    | Identificador del negocio |


# Activar Mpos

Permite activar el negocio para que pueda transaccionar con mpos

{% hint style="info" %}
POST /Cuenta/{idAplicativo}/activar-mpos
{% endhint %}

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

### Parámetros de ruta:

| Campo        | Es Requerido | Tipo Dato | Descripción               |
| ------------ | ------------ | --------- | ------------------------- |
| idAplicativo | Si           | string    | Identificador del negocio |


# Actualizar dirección Cuenta Wompi

Permite actualizar la dirección de la cuenta

{% hint style="info" %}
PUT /Cuenta/{id}/Direccion
{% endhint %}

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

### Parámetros de ruta:

| Campo | Es Requerido | Tipo Dato | Descripción                      |
| ----- | ------------ | --------- | -------------------------------- |
| id    | Si           | string    | Identificador de la cuenta Wompi |

### Objeto de petición:

<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"><p>idDepartamento</p><p> </p></td><td valign="top">Sí</td><td valign="top">Int</td><td valign="top">Identificador del departamento (se puede obtener del EndpoInt GET ​/api​/Regiones)</td></tr><tr><td valign="top">idMunicipio</td><td valign="top">Sí</td><td valign="top">Int</td><td valign="top">Identificador del municipio (se puede obtener del EndpoInt GET ​/api​/Regiones)</td></tr><tr><td valign="top"><p>urbanizacion</p><p> </p></td><td valign="top">Sí</td><td valign="top">String (max 110)</td><td valign="top">Urbanización</td></tr><tr><td valign="top">calle</td><td valign="top">Sí</td><td valign="top">String (max 110)</td><td valign="top">Calle</td></tr><tr><td valign="top">local</td><td valign="top">Sí</td><td valign="top">String (max 25)</td><td valign="top">Local</td></tr></tbody></table>

### Objeto de respuesta:

| Campo                  | Tipo Dato               | Descripción                                                                    |
| ---------------------- | ----------------------- | ------------------------------------------------------------------------------ |
| idCuenta               | string                  | Identificador de la cuenta Wompi                                               |
| emailLogin             | string                  | Correo electrónico de inicio de sesión relacionado a la cuenta Wompi           |
| tipoPersoneria         | string                  | <p>Tipo de persona. Los valores pueden ser:</p><p>-Natural</p><p>-Jurídica</p> |
| nit                    | string (null o vacio)   | Número de Identificación Tributaria                                            |
| nombreCompletoContacto | string                  | Nombre completo de contacto del propietario de la cuenta                       |
| nombreCuenta           | string                  | Nombre de la cuenta Wompi                                                      |
| nombreComercial        | string                  | Nombre comercial de la cuenta                                                  |
| razonSocial            | string (null)           | razonSocial                                                                    |
| fechaRegistro          | string (DateTimeOffset) | Fecha y hora de creación de la cuenta Wompi                                    |
| actividadEconomica     | string                  | Actividad económica de la cuenta Wompi                                         |
| direccion              | string                  | Dirección del propietario de la cuenta Wompi                                   |
| urbanizacion           | string                  | Urbanización                                                                   |
| calle                  | string                  | Calle                                                                          |
| local                  | string                  | Local                                                                          |
| aplicativos            | Listado Objeto Negocio  | Listado de negocio relacionados a la cuenta Wompi                              |

### Objeto Negocio

| Campo                 | Tipo Dato                    | Descripción                                                          |
| --------------------- | ---------------------------- | -------------------------------------------------------------------- |
| idAplicativo          | string                       | Identificador del negocio                                            |
| clientIdApi           | string                       | Identificador del cliente para autenticarse con un negocio           |
| clientSecret          | string                       | Secreto del cliente para autenticarse con negocio                    |
| numeroCuenta          | string                       | Número de cuenta de banco relacionada al negocio                     |
| nombre                | string                       | Nombre del negocio                                                   |
| urlAplicativo         | string                       | URL relacionada al negocio                                           |
| estaProductivo        | bool                         | Indica si el negocio está en modo productivo                         |
| urlLogo               | string                       | URL de la imagen del logo relacionado al negocio                     |
| aplicaPagoConPuntos   | bool                         | Indica si el negocio aplica para pagos con puntos del Banco Agrícola |
| aplicaPagoConBitcoin  | bool                         | Indica si el negocio aplica para pagos con Bitcoin                   |
| aplicaPagoConQuickPay | bool                         | Indica si el negocio aplica para pagos con QR QuickPay               |
| cuotasDisponibles     | Lista Objeto CuotaDisponible | Listado de las cuotas disponibles para el negocio                    |
| tapOnPhone            | Object (null)                | Datos de TapOnPhone relacionados al negocio                          |

### Objeto CuotaDisponible

| Campo          | Tipo Dato | Descripción                               |
| -------------- | --------- | ----------------------------------------- |
| cantidadCuotas | int       | Número que indica la cantidad de la cuota |
| tasa           | int       | Porcentaje de Interés que tiene la cuota  |

### Objeto TapOnPhone

| Campo             | Tipo Dato               | Descripción                                                 |
| ----------------- | ----------------------- | ----------------------------------------------------------- |
| usuarioEnrolo     | string                  | Usuario que vinculó el negocio a la App de Wompi            |
| fechaEnrolamiento | String (DateTimeOffset) | Fecha y hora en que se vinculó el negocio a la App de Wompi |
| deviceId          | string                  | Identificador del dispositivo vinculado al negocio          |
| retailerId        | string                  | Identificador del comercio de tipo TapOnPhone               |
| terminalId        | string                  | Identificador de la terminal de tipo TapOnPhone             |

### Ejemplo de Respuesta

```
{
  "idCuenta": "string",
  "emailLogin": "string",
  "tipoPersoneria": 0,
  "nit": "string",
  "nombreCompletoContacto": "string",
  "nombreCuenta": "string",
  "nombreComercial": "string",
  "razonSocial": "string",
  "fechaRegistro": "2026-03-10T13:59:42.052Z",
  "actividadEconomica": "string",
  "direccion": "string",
  "urbanizacion": "string",
  "calle": "string",
  "local": "string",
  "aplicativos": [
    {
      "idAplicativo": "string",
      "clientIdApi": "string",
      "clientSecret": "string",
      "numeroCuenta": "string",
      "nombre": "string",
      "urlAplicativo": "string",
      "estaProductivo": true,
      "urlLogo": "string",
      "aplicaPagoConPuntos": true,
      "aplicaPagoConBitcoin": true,
      "aplicaPagoConQuickPay": true,
      "cuotasDisponibles": [
        {
          "cantidadCuotas": 1,
          "tasa": 0
        }
      ],
      "tapOnPhone": {
        "usuarioEnrolo": "string",
        "fechaEnrolamiento": "2026-03-10T13:59:42.052Z",
        "deviceId": "string",
        "retailerId": "string",
        "terminalId": "string"
      }
    }
  ]
}
```


# Obtener EnlacePago

Obtiene el listado paginado de los enlaces de pago

{% 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
}
```


# Obtener Enlace de Pago por Id

Consulta los datos de un enlace de pago creado previamente, incluyendo la información de la transacción de pago en caso ya se haya ejecutado una.

{% hint style="info" %}
GET /EnlacePago/{id}
{% 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">id</td><td valign="top">Sí</td><td valign="top">Int</td><td valign="top">Identificador del enlace de pago</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">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

```
{
  "idAplicativo": "string",
  "nombreEnlace": "string",
  "monto": 0,
  "nombreProducto": "string",
  "usable": true,
  "transaccionCompra": {
    "datosAdicionales": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "resultadoTransaccion": 0,
    "fechaTransaccion": "2026-03-10T14:36:38.243Z",
    "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:36:38.243Z",
      "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:36:38.243Z",
    "fechaFin": "2026-03-10T14:36:38.243Z"
  },
  "limitesDeUso": {
    "cantidadMaximaPagosExitosos": 0,
    "cantidadMaximaPagosFallidos": 0
  },
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "idGrupoTarjetas": "string",
  "idEnlace": 0,
  "urlQrCodeEnlace": "string",
  "urlEnlace": "string",
  "estaProductivo": true,
  "urlEnlaceLargo": "string"
}
```


# Actualizar Enlace de Pago

Permite editar un enlace de pago para que el usuario haga el proceso de ingreso de datos de pago en una interfaz de Wompi

{% hint style="info" %}
PUT /EnlacePago/{id}
{% endhint %}

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

Parámetros de ruta:

### 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">id</td><td valign="top">Sí</td><td valign="top">Int</td><td valign="top">Identificador del enlace de pago</td></tr></tbody></table>

### Objeto de petición:

<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">identificadorEnlaceComercio</td><td valign="top">Sí</td><td valign="top">String (max 500)</td><td valign="top">Identificador único del enlace de pago</td></tr><tr><td valign="top">monto</td><td valign="top">No</td><td valign="top">Decimal</td><td valign="top">Monto del enlace de pago</td></tr><tr><td valign="top">nombreProducto</td><td valign="top">Sí</td><td valign="top">String (max 500)</td><td valign="top">Nombre del producto relacionado al enlace de pago</td></tr><tr><td valign="top">formaPago</td><td valign="top">No</td><td valign="top">Objeto</td><td valign="top">Configuración de formas de pago del enlace de pago</td></tr><tr><td valign="top">cantidadMaximaCuotas</td><td valign="top">No</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">infoProducto</td><td valign="top">No</td><td valign="top">Objeto</td><td valign="top"> </td></tr><tr><td valign="top">configuracion</td><td valign="top">No</td><td valign="top">Objeto</td><td valign="top"> </td></tr><tr><td valign="top">vigencia</td><td valign="top">No</td><td valign="top">Objeto</td><td valign="top"></td></tr><tr><td valign="top">limitesDeUso</td><td valign="top">No</td><td valign="top">Objeto</td><td valign="top"></td></tr><tr><td valign="top">datosAdicionales</td><td valign="top">No</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">No</td><td valign="top">String (max 50)</td><td valign="top">Identificador del grupo de tarjetas al cual está reStringido el enlace de pago</td></tr></tbody></table>

### Objeto FormaPago

<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">formaPago:permitirTarjetaCreditoDebido</td><td valign="top">Sí</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">Sí</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">Sí</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">Sí</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">Sí</td><td valign="top">Bool</td><td valign="top">Indica si el enlace de pago permite pagos con QuickPay</td></tr></tbody></table>

### Objeto infoProducto &#x20;

<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">infoProducto:descripcionProducto</td><td valign="top">No</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">No</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 Configuracion

<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">configuracion:urlRedirect</td><td valign="top">No</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">No</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">No</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">No</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">No</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">No</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">No</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">No</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">No</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">No</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 Vigencia

<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">vigencia:fechaInicio</td><td valign="top">Sí</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">No</td><td valign="top">String (DateTimeOffset)</td><td valign="top">Fecha fin en el rango de vigencia</td></tr></tbody></table>

### Objeto limitesDeUso

<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">limitesDeUso:cantidadMaximaPagosExitosos</td><td valign="top">No</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">No</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 Petición

```
{
  "identificadorEnlaceComercio": "string",
  "monto": 0,
  "nombreProducto": "string",
  "formaPago": {
    "permitirTarjetaCreditoDebido": true,
    "permitirPagoConPuntoAgricola": true,
    "permitirPagoEnCuotasAgricola": true,
    "permitirPagoEnBitcoin": true,
    "permitePagoQuickPay": true
  },
  "cantidadMaximaCuotas": 1,
  "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
  },
  "vigencia": {
    "fechaInicio": "2026-03-10T14:43:51.452Z",
    "fechaFin": "2026-03-10T14:43:51.452Z"
  },
  "limitesDeUso": {
    "cantidadMaximaPagosExitosos": 0,
    "cantidadMaximaPagosFallidos": 0
  },
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "idGrupoTarjetas": "string"
}
```

### 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">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/aplicativo/aplicativo 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

```
{
  "idAplicativo": "string",
  "nombreEnlace": "string",
  "monto": 0,
  "nombreProducto": "string",
  "usable": true,
  "transaccionCompra": {
    "datosAdicionales": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "resultadoTransaccion": 0,
    "fechaTransaccion": "2026-03-10T14:36:38.243Z",
    "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:36:38.243Z",
      "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:36:38.243Z",
    "fechaFin": "2026-03-10T14:36:38.243Z"
  },
  "limitesDeUso": {
    "cantidadMaximaPagosExitosos": 0,
    "cantidadMaximaPagosFallidos": 0
  },
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "idGrupoTarjetas": "string",
  "idEnlace": 0,
  "urlQrCodeEnlace": "string",
  "urlEnlace": "string",
  "estaProductivo": true,
  "urlEnlaceLargo": "string"
}
```


# Desactivar Enlace Pago

Desactiva un enlace de pago invalidandole realizar pagos nuevamente

{% hint style="info" %}
PUT /EnlacePago/{id}/desactivar
{% 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">id</td><td valign="top">Sí</td><td valign="top">Int</td><td valign="top">Identificador del enlace de pago</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">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ñon</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

```
{
  "idAplicativo": "string",
  "nombreEnlace": "string",
  "monto": 0,
  "nombreProducto": "string",
  "usable": true,
  "transaccionCompra": {
    "datosAdicionales": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "resultadoTransaccion": 0,
    "fechaTransaccion": "2026-03-10T14:36:38.243Z",
    "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:36:38.243Z",
      "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:36:38.243Z",
    "fechaFin": "2026-03-10T14:36:38.243Z"
  },
  "limitesDeUso": {
    "cantidadMaximaPagosExitosos": 0,
    "cantidadMaximaPagosFallidos": 0
  },
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "idGrupoTarjetas": "string",
  "idEnlace": 0,
  "urlQrCodeEnlace": "string",
  "urlEnlace": "string",
  "estaProductivo": true,
  "urlEnlaceLargo": "string"
}
```


# Eliminar Imagen en enlace de pago

Elimina la imagen de un botón de pago, dada su URL

{% hint style="info" %}
DELETE /EnlacePago/{id}/imagen
{% 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">id</td><td valign="top">Sí</td><td valign="top">Int</td><td valign="top">Identificador del enlace de pago</td></tr><tr><td valign="top">url</td><td valign="top">Sí</td><td valign="top">String</td><td valign="top">URL de la imagen que se va a eliminar del enlace de pago</td></tr></tbody></table>


# Agregar Imagen en enlace de pago

Agregar una imagen de un botón de pago

{% hint style="info" %}
POST /EnlacePago/{id}/imagen
{% 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">id</td><td valign="top">Sí</td><td valign="top">Int</td><td valign="top">Identificador del enlace de pago</td></tr><tr><td valign="top">esPrincipal</td><td valign="top">No</td><td valign="top">Bool</td><td valign="top">Indicará si la imagen nueva será la principal</td></tr></tbody></table>


# Activar Enlace de Pago

Reactiva un enlace de pago permitiéndole realizar pagos nuevamente

{% hint style="info" %}
PUT /EnlacePago/{id}/activar
{% endhint %}

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

Parámetros de ruta:

### Parámetros de ruta:

<table><thead><tr><th valign="top">Campo</th><th valign="top">Tipo Dato</th><th valign="top">Es Requerido</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">id</td><td valign="top">Int</td><td valign="top">Sí</td><td valign="top">Identificador del enlace de pago</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">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">Es Requerido</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

```
{
  "idAplicativo": "string",
  "nombreEnlace": "string",
  "monto": 0,
  "nombreProducto": "string",
  "usable": true,
  "transaccionCompra": {
    "datosAdicionales": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "resultadoTransaccion": 0,
    "fechaTransaccion": "2026-03-10T14:36:38.243Z",
    "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:36:38.243Z",
      "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:36:38.243Z",
    "fechaFin": "2026-03-10T14:36:38.243Z"
  },
  "limitesDeUso": {
    "cantidadMaximaPagosExitosos": 0,
    "cantidadMaximaPagosFallidos": 0
  },
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "idGrupoTarjetas": "string",
  "idEnlace": 0,
  "urlQrCodeEnlace": "string",
  "urlEnlace": "string",
  "estaProductivo": true,
  "urlEnlaceLargo": "string"
}
```


# Solicitar Mpos

Permite crear una solicitud de compra de MPos

{% hint style="info" %}
POST /Mpos/Solicitar
{% endhint %}

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

### Objeto de petición:

<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">nombre</td><td valign="top">Sí</td><td valign="top">String (max 250)</td><td valign="top">Nombre del solicitante</td></tr><tr><td valign="top">email</td><td valign="top">Sí</td><td valign="top">String (max 250)</td><td valign="top">Dirección de correo electrónico del solicitante</td></tr><tr><td valign="top">celular</td><td valign="top">Sí</td><td valign="top">String (max 14)</td><td valign="top">Número de celular del solicitante</td></tr><tr><td valign="top">direccionEntrega</td><td valign="top">Sí</td><td valign="top">String (max 500)</td><td valign="top">Dirección a la cual se debe entregar el dispositivo POS</td></tr><tr><td valign="top">idDepartamento</td><td valign="top">Sí</td><td valign="top">Int</td><td valign="top"><p>Identificador del departamento, se pueden obtener los departamentos disponibles en el Endpoint: GET</p><p>​/api​/Regiones</p></td></tr><tr><td valign="top">idMunicipio</td><td valign="top">Sí</td><td valign="top">Int</td><td valign="top"><p>Identificador del municipio, se pueden obtener los municipios disponibles en el Endpoint: GET</p><p>​/api​/Regiones</p></td></tr><tr><td valign="top">requiereCreditoFiscal</td><td valign="top">No (false por defecto)</td><td valign="top">Bool</td><td valign="top">Indica si se debe entregar un documento de crédito fiscal por la compra</td></tr><tr><td valign="top">nombreRazonSocial</td><td valign="top">Sí (solo si requiereCreditoFiscal es true)</td><td valign="top">String</td><td valign="top">Nombre o razón social del solicitante</td></tr><tr><td valign="top">numeroRegistro</td><td valign="top">Sí (solo si requiereCreditoFiscal es true)</td><td valign="top">String (formato: XXXXXX-X)</td><td valign="top">Número de registro de IVA del solicitante</td></tr><tr><td valign="top">giro</td><td valign="top">Sí (solo si requiereCreditoFiscal es true)</td><td valign="top">String (max 250)</td><td valign="top">Giro o actividad económica del solicitante</td></tr><tr><td valign="top">mpos</td><td valign="top">Sí</td><td valign="top">Lista</td><td valign="top">Listado de nombres amigables que tendrán los Mpos.</td></tr></tbody></table>

### Ejemplo de petición

```
{
  "nombre": "string",
  "email": "user@example.com",
  "celular": "string",
  "direccionEntrega": "string",
  "idDepartamento": 0,
  "idMunicipio": 0,
  "requiereCreditoFiscal": true,
  "nombreRazonSocial": "string",
  "numeroRegistro": "string",
  "giro": "string",
  "mpos": [
    "string"
  ]
}
```

### 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">paymentUrl</td><td valign="top">String</td><td valign="top">URL del enlace de pago</td></tr><tr><td valign="top">requestedMposData</td><td valign="top">Lista</td><td valign="top"> </td></tr><tr><td valign="top">requestedMposData:friendlyName</td><td valign="top">String</td><td valign="top">Nombre amigable del Mpos solicitado</td></tr></tbody></table>

### Ejemplo de respuesta

```
{
    "paymentUrl": "String",
    "requestMposData": [
        "friendlyName": "string"
    ]
}
```


# Obtener Mpos

Obtiene un listado de los Mpos registrados

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

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

### Objeto de respuesta: Lista

<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">mposId</td><td valign="top">String</td><td valign="top">Identificador del Mpos</td></tr><tr><td valign="top">friendlyName</td><td valign="top">String</td><td valign="top">Nombre amigable del Mpos solicitado</td></tr><tr><td valign="top">assignmentDate</td><td valign="top">String (DateTimeOffset)</td><td valign="top">Fecha de asignación del Mpos</td></tr><tr><td valign="top">state</td><td valign="top">Bool</td><td valign="top">Indica si el Mpos está activado</td></tr></tbody></table>

### Ejemplo Respuesta

```
[
  {
    "mposId": "string",
    "friendlyName": "string",
    "assignmentDate": "2026-03-10T15:52:47.335Z",
    "state": true
  }
]
```


# Registrar Mpos

Permite registrar un MPos sin necesidad de una solicitud de compra

{% hint style="info" %}
POST /Mpos/Registrar
{% endhint %}

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

### Objeto de petición: Listado

<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">mposId</td><td valign="top">Sí</td><td valign="top">String (min 5, max 5)</td><td valign="top">Ultimo 5 dígitos del identificador del Mpos</td></tr><tr><td valign="top">friendlyName</td><td valign="top">Sí</td><td valign="top">String (max 100)</td><td valign="top">Nombre amigable del Mpos</td></tr></tbody></table>

### Ejemplo Petición

```
[
  {
    "mposId": "string",
    "friendlyName": "string"
  }
]
```

### Objeto de respuesta: Listado

<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">mposId</td><td valign="top">String</td><td valign="top">Identificador del Mpos</td></tr><tr><td valign="top">friendlyName</td><td valign="top">String</td><td valign="top">Nombre amigable del Mpos solicitado</td></tr></tbody></table>

### Ejemplo Respuesta

```
[
  {
    "mposId": "string",
    "friendlyName": "string"
  }
]
```


# Activar Mpos

Permite activar un MPos

{% hint style="info" %}
POST /Mpos/{id}/Activar
{% 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">Tipo Dato</th><th valign="top">Es Requerido</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">id</td><td valign="top">String</td><td valign="top">Sí</td><td valign="top">Identificador del Mpos</td></tr></tbody></table>

### Objeto de respuesta: Listado

<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">mposId</td><td valign="top">String</td><td valign="top">Identificador del Mpos</td></tr><tr><td valign="top">friendlyName</td><td valign="top">String</td><td valign="top">Nombre amigable del Mpos solicitado</td></tr></tbody></table>

### Ejemplo Respuesta

```
[
  {
    "mposId": "string",
    "friendlyName": "string"
  }
]
```


# Desactivar Mpos

Permite desactivar un Mpos

{% hint style="info" %}
POST /Mpos/{id}/Desactivar
{% 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">Tipo Dato</th><th valign="top">Es Requerido</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">id</td><td valign="top">String</td><td valign="top">Sí</td><td valign="top">Identificador del Mpos</td></tr></tbody></table>


# Obtener Regiones

Obtener un listado de regiones según ISO 3166-1 alpha-2 y territorios según ISO 3166-2

{% hint style="info" %}
GET /api/Regiones
{% endhint %}

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

### Objeto de respuesta: Listado

<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">id</td><td valign="top">String</td><td valign="top">Identificador de la región</td></tr><tr><td valign="top">nombre</td><td valign="top">String</td><td valign="top">Nombre de la región</td></tr><tr><td valign="top">territorios</td><td valign="top">Lista</td><td valign="top"> </td></tr><tr><td valign="top">territorios:id</td><td valign="top">String</td><td valign="top">Identificador del territorio</td></tr><tr><td valign="top">territorios:nombre</td><td valign="top">String</td><td valign="top">Nombre del territorio</td></tr></tbody></table>

### Ejemplo Respuesta

```
[
    "id": "string",
    "nombre": "string",
    "territorios": [
        "id": "string",
        "nombre": "string"
    ]
]
```


# Crear Transacción Compra con Qr

Permite crear una transacción de compra con QR Wompi.

{% hint style="info" %}
POST /TransaccionCompra/PagoQr
{% endhint %}

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

### Objeto de petición:

<table><thead><tr><th valign="top">Campo</th><th valign="top">Tipo Dato</th><th valign="top">Es Requerido</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">urlEnlacePago</td><td valign="top">String</td><td valign="top">Sí</td><td valign="top">URL del enlace de pago en su versión corta</td></tr><tr><td valign="top">datosAdicionales</td><td valign="top">Objeto (Diccionario)</td><td valign="top">No</td><td valign="top">Datos adicionales relacionados a la transacción que se iniciará</td></tr></tbody></table>

### &#x20;Ejemplo petición

```
{
  "urlEnlacePago": "string",
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}
```

### 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">idTransaccion</td><td valign="top">String</td><td valign="top">Identificador de la transacción iniciada</td></tr><tr><td valign="top">numeroCuentaBanco</td><td valign="top">String</td><td valign="top">Número de la cuenta de banco relacionada a la transacción</td></tr><tr><td valign="top">monto</td><td valign="top">Decimal</td><td valign="top">Monto de la transacción</td></tr><tr><td valign="top">nombreComercial</td><td valign="top">String</td><td valign="top">Nombre comercial de la cuenta Wompi</td></tr><tr><td valign="top">razonSocial</td><td valign="top">String</td><td valign="top">Razón social de la cuenta Wompi</td></tr><tr><td valign="top">nombreAplicativo</td><td valign="top">String</td><td valign="top">Nombre del negocio relacionado a la transacción</td></tr><tr><td valign="top">producto</td><td valign="top">String</td><td valign="top">Nombre del producto relacionado a la transacción</td></tr></tbody></table>

### Ejemplo Respuesta

```
{
  "idTransaccion": "string",
  "numeroCuentaBanco": "string",
  "monto": 0,
  "nombreComercial": "string",
  "razonSocial": "string",
  "nombreAplicativo": "string",
  "producto": "string"
}
```


# Finalizar Transacción Compra con Qr

Permite finalizar una transacción de pago QR Wompi.

{% hint style="info" %}
PUT /TransaccionCompra/PagoQr/{id}
{% endhint %}

Autenticación: Cuenta Wompi o negocio

Autorización: Requiere permisos adicionales

### 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">id</td><td valign="top">Sí</td><td valign="top">String (max 50)</td><td valign="top">Identificador de la transacción que se desea finalizar</td></tr></tbody></table>

&#x20;

### Objeto de petición:

<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">resultadoTransaccion</td><td valign="top">Sí</td><td valign="top">Int</td><td valign="top"><p>Resultado de la transacción con la que se finalizará:</p><p>·       ExitosaAprobada = 0</p><p>·       ExitosaDeclinada = 1</p><p>·       Fallida = 2</p></td></tr><tr><td valign="top">fechaTransaccion</td><td valign="top">Sí</td><td valign="top">String (DateTimeOffset)</td><td valign="top">Fecha y hora de finalización de la transacción</td></tr><tr><td valign="top">codigoAutorizacion</td><td valign="top">No</td><td valign="top">String (500)</td><td valign="top">Código de autorización si la transacción fue exitosa y aprobada</td></tr><tr><td valign="top">identificadorTransaccion</td><td valign="top">No</td><td valign="top">String (500)</td><td valign="top">Identificador secundario de la transacción de un sistema externo a Wompi</td></tr><tr><td valign="top">mensajeRespuesta</td><td valign="top">No</td><td valign="top">String (1000)</td><td valign="top">Mensaje del resultado de la transacción</td></tr><tr><td valign="top">datosAdicionales</td><td valign="top">No</td><td valign="top">Objeto (Diccionario)</td><td valign="top">Datos adicionales relacionados a la transacción que se finalizará</td></tr></tbody></table>

### &#x20;Ejemplo Objeto petición

```
{
  "urlEnlacePago": "string",
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}
```

### 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">idTransaccion</td><td valign="top">String</td><td valign="top">Identificador único de la transacción.</td></tr><tr><td valign="top">esReal</td><td valign="top">Bool</td><td valign="top">Indica si la transacción de compra fue real. Depende de si el negocio asociado está en producción.</td></tr><tr><td valign="top">esAprobada</td><td valign="top">Bool</td><td valign="top">Indica si la transacción fue autorizada correctamente; si es verdadero, el cobro se realizó con éxito.</td></tr><tr><td valign="top">codigoAutorizacion</td><td valign="top">String</td><td valign="top">Código de autorización retornado cuando la transacción es exitosa.</td></tr><tr><td valign="top">mensaje</td><td valign="top">String</td><td valign="top">Mensaje de error retornado en caso de que la transacción no sea exitosa.</td></tr><tr><td valign="top">formaPago</td><td valign="top">Int (nulo)</td><td valign="top">Forma de pago utilizada en la transacción. Opcional. Valores: 0 = Tarjeta de crédito o débito, 1 = Pago con puntos Banco Agrícola.</td></tr><tr><td valign="top">monto</td><td valign="top">decimal</td><td valign="top">Monto de la transacción en dólares.</td></tr><tr><td valign="top">idExterno</td><td valign="top">String</td><td valign="top">Identificador definido por el comercio para la transacción (por ejemplo, ID de la orden).</td></tr><tr><td valign="top">datosAdicionales</td><td valign="top">Objeto (Diccionario)</td><td valign="top">Pares clave/valores relacionados a la transacción, incluyendo parámetros enviados durante la transacción y algunos ingresados por el cliente.</td></tr><tr><td valign="top">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">fechaTransaccion</td><td valign="top">String (DateTimeOffset, anulable)</td><td valign="top">Fecha y hora en la que la transacción fue realizada.</td></tr><tr><td valign="top">montoOriginal</td><td valign="top">Decimal (nulo)</td><td valign="top">Monto original de la transacción.</td></tr></tbody></table>

### Ejemplo Objeto Respuesta

```
{
  "idTransaccion": "string",
  "numeroCuentaBanco": "string",
  "monto": 0,
  "nombreComercial": "string",
  "razonSocial": "string",
  "nombreAplicativo": "string",
  "producto": "string"
}
```


# Crear Transaccion Compra

Debido a que este Endpoint no está protegido con 3D Secure solo está disponible bajo solicitud especial por medio de nuestro canal de soporte

{% hint style="info" %}
POST /TransaccionCompra
{% endhint %}

Autenticación: Cuenta Wompi o negocio

Autorización: Requiere permisos adicionales

### Objeto de petición:

<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">tarjetaCreditoDebido</td><td valign="top">No</td><td valign="top">Objeto</td><td valign="top">Datos de la tarjeta de crédito o débito con la que se realiza la transacción.</td></tr><tr><td valign="top">monto</td><td valign="top">Sí</td><td valign="top">decimal (anulable)</td><td valign="top">Monto de la transacción en dólares. Debe ser mayor a 0.</td></tr><tr><td valign="top">emailCliente</td><td valign="top">Sí</td><td valign="top">string</td><td valign="top">Correo electrónico del cliente para el envío de notificaciones.</td></tr><tr><td valign="top">nombreCliente</td><td valign="top">Sí</td><td valign="top">string</td><td valign="top">Nombre del cliente.</td></tr><tr><td valign="top">formaPago</td><td valign="top">No</td><td valign="top">int (anulable)</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">configuracion</td><td valign="top">No</td><td valign="top">Objeto</td><td valign="top">Configuración de la transacción. Si se omite, se usa la configuración del negocio.</td></tr><tr><td valign="top">datosAdicionales</td><td valign="top">No</td><td valign="top">Objeto (Diccionario)</td><td valign="top">Pares clave/valor incluidos en reportes y webhooks.</td></tr><tr><td valign="top">cantidadCuotas</td><td valign="top">No</td><td valign="top">int</td><td valign="top">Cantidad de cuotas cuando la forma de pago es en cuotas.</td></tr><tr><td valign="top">idExterno</td><td valign="top">No</td><td valign="top">string (max 50)</td><td valign="top">Identificador definido por el comercio para la transacción.</td></tr><tr><td valign="top">idGrupoTarjetas</td><td valign="top">No</td><td valign="top">string (max 50)</td><td valign="top">Identificador del grupo de tarjetas permitido para la transacción.</td></tr></tbody></table>

### Objeto Configuracion

<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">configuracion:emailsNotificacion</td><td valign="top">No</td><td valign="top">string</td><td valign="top">Lista de correos electrónicos separados por comas para notificaciones de la transacción.</td></tr><tr><td valign="top">configuracion:urlWebhook</td><td valign="top">No</td><td valign="top">string</td><td valign="top">URL del webhook a invocar después de una transacción exitosa.</td></tr><tr><td valign="top">configuracion:telefonosNotificacion</td><td valign="top">No</td><td valign="top">string</td><td valign="top">Lista de teléfonos separados por comas para notificaciones de la transacción.</td></tr><tr><td valign="top">configuracion:notificarTransaccionCliente</td><td valign="top">No</td><td valign="top">bool (anulable)</td><td valign="top">Indica si se enviará un correo al cliente tras un pago exitoso.</td></tr></tbody></table>

### Objeto tarjetaCreditoDebido

<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">tarjetaCreditoDebido:numeroTarjeta</td><td valign="top">Sí</td><td valign="top">string (max 20)</td><td valign="top">Número completo de la tarjeta. Debe ser válido, sin guiones y no iniciar con 3.</td></tr><tr><td valign="top">tarjetaCreditoDebido:cvv</td><td valign="top">Sí</td><td valign="top">string (max 3)</td><td valign="top">Código CVV de la tarjeta. Debe contener exactamente 3 dígitos numéricos.</td></tr><tr><td valign="top">tarjetaCreditoDebido:mesVencimiento</td><td valign="top">Sí</td><td valign="top">int</td><td valign="top">Mes de vencimiento de la tarjeta. Rango válido de 1 a 12.</td></tr><tr><td valign="top">tarjetaCreditoDebido:anioVencimiento</td><td valign="top">Sí</td><td valign="top">int</td><td valign="top">Año de vencimiento de la tarjeta de crédito.</td></tr></tbody></table>

### Ejemplo objeto petición

```
{
  "tarjetaCreditoDebido": {
    "numeroTarjeta": "string",
    "cvv": "string",
    "mesVencimiento": 0,
    "anioVencimiento": 0
  },
  "monto": 0,
  "emailCliente": "user@example.com",
  "nombreCliente": "string",
  "formaPago": 0,
  "configuracion": {
    "emailsNotificacion": "string",
    "urlWebhook": "string",
    "telefonosNotificacion": "string",
    "notificarTransaccionCliente": true
  },
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "cantidadCuotas": 1,
  "idExterno": "string",
  "idGrupoTarjetas": "string"
}
```

### 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">idTransaccion</td><td valign="top">string</td><td valign="top">Identificador único de la transacción.</td></tr><tr><td valign="top">esReal</td><td valign="top">bool</td><td valign="top">Indica si la transacción de compra fue real; depende del ambiente del negocio.</td></tr><tr><td valign="top">esAprobada</td><td valign="top">bool</td><td valign="top">Indica si la transacción fue autorizada correctamente y el cobro se realizó con éxito.</td></tr><tr><td valign="top">codigoAutorizacion</td><td valign="top">string</td><td valign="top">Código de autorización retornado cuando la transacción es exitosa.</td></tr><tr><td valign="top">mensaje</td><td valign="top">string</td><td valign="top">Mensaje de error retornado cuando la transacción no fue exitosa.</td></tr><tr><td valign="top">formaPago</td><td valign="top">int (anulable)</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">monto</td><td valign="top">decimal</td><td valign="top">Monto de la transacción en dólares.</td></tr><tr><td valign="top">idExterno</td><td valign="top">string</td><td valign="top">Identificador definido por el comercio para la transacción (por ejemplo, ID de la orden).</td></tr></tbody></table>

### Objeto Respuesta

```
{
  "idTransaccion": "string",
  "esReal": true,
  "esAprobada": true,
  "codigoAutorizacion": "string",
  "mensaje": "string",
  "formaPago": 0,
  "monto": 0,
  "idExterno": "string"
}
```


# Obtener Transacción Compra

Consulta un listado paginado de transacciones

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

Autenticación: Cuenta Wompi o negocio

### Parámetros de ruta:

<table><thead><tr><th valign="top">Campo</th><th valign="top">Tipo Dato</th><th valign="top">Es Requerido</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">cantidadPorPagina</td><td valign="top">int (anulable)</td><td valign="top">No</td><td valign="top">Cantidad de elementos por página. Valor por defecto: 20.</td></tr><tr><td valign="top">paginaActual</td><td valign="top">int (anulable)</td><td valign="top">No</td><td valign="top">Página actual. Por defecto es la primera.</td></tr><tr><td valign="top">fechaInicio</td><td valign="top">DateTimeOffset (anulable)</td><td valign="top">No</td><td valign="top">Fecha inicial de las transacciones. Si no se incluye, se toma desde la primera transacción realizada.</td></tr><tr><td valign="top">fechaFin</td><td valign="top">DateTimeOffset (anulable)</td><td valign="top">No</td><td valign="top">Fecha final de las transacciones. Si no se incluye, se toma hasta la última transacción realizada.</td></tr><tr><td valign="top">numeroCuenta</td><td valign="top">string</td><td valign="top">No</td><td valign="top">Número de cuenta bancaria. Opcional.</td></tr><tr><td valign="top">formaPago</td><td valign="top">int (anulable)</td><td valign="top">No</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">resultadoTransaccion</td><td valign="top">int (anulable)</td><td valign="top">No</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">emailCliente</td><td valign="top">string</td><td valign="top">No</td><td valign="top">Correo electrónico del cliente que realizó la transacción. Opcional.</td></tr><tr><td valign="top">idAplicativo</td><td valign="top">string</td><td valign="top">No</td><td valign="top">Identificador del negocio a consultar.</td></tr><tr><td valign="top">montoInicial</td><td valign="top">decimal (anulable)</td><td valign="top">No</td><td valign="top">Monto inicial de las transacciones a buscar.</td></tr><tr><td valign="top">montoFinal</td><td valign="top">decimal (anulable)</td><td valign="top">No</td><td valign="top">Monto final de las transacciones a buscar.</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 actual.</td></tr><tr><td valign="top">cantidadPorPagina</td><td valign="top">int</td><td valign="top">Cantidad de elementos solicitados por página.</td></tr><tr><td valign="top">totalDeElementos</td><td valign="top">int</td><td valign="top">Total, de elementos en todas las páginas.</td></tr><tr><td valign="top">resultado</td><td valign="top">List&#x3C;Transacción></td><td valign="top">Lista de transacciones correspondientes a la página actual.</td></tr><tr><td valign="top">totalPaginas</td><td valign="top">int</td><td valign="top">Total, de páginas calculado a partir del total de elementos y cantidad por página.</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">Campo</td><td valign="top">Tipo Dato</td><td valign="top">Descripción</td></tr><tr><td valign="top">idTransaccion</td><td valign="top">string</td><td valign="top">Identificador único de la transacción.</td></tr><tr><td valign="top">esReal</td><td valign="top">bool</td><td valign="top">Indica si la transacción fue real según el ambiente del negocio.</td></tr><tr><td valign="top">esAprobada</td><td valign="top">bool</td><td valign="top">Indica si la transacción fue autorizada correctamente.</td></tr><tr><td valign="top">codigoAutorizacion</td><td valign="top">string</td><td valign="top">Código de autorización retornado cuando la transacción es exitosa.</td></tr><tr><td valign="top">mensaje</td><td valign="top">string</td><td valign="top">Mensaje de error retornado cuando la transacción no fue exitosa.</td></tr><tr><td valign="top">formaPago</td><td valign="top">int (anulable)</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">monto</td><td valign="top">decimal</td><td valign="top">Monto de la transacción en dólares.</td></tr><tr><td valign="top">idExterno</td><td valign="top">string</td><td valign="top">Identificador definido por el comercio para la transacción.</td></tr></tbody></table>

### Ejemplo de respuesta

```
{
  "paginaActual": 0,
  "cantidadPorPagina": 0,
  "totalDeElementos": 0,
  "resultado": [
      {
      "datosAdicionales": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "resultadoTransaccion": 0,
      "fechaTransaccion": "2026-03-10T16:15:40.547Z",
      "montoOriginal": 0,
      "idTransaccion": "string",
      "esReal": true,
      "esAprobada": true,
      "codigoAutorizacion": "string",
      "mensaje": "string",
      "formaPago": 0,
      "monto": 0,
      "idExterno": "string"
    }
  ],
  "totalPaginas": 0
}
```


# Crear Transación Compra Bitcoin

{% hint style="info" %}
POST /TransaccionCompra/Bitcoin
{% endhint %}

Autenticación: Cuenta Wompi o negocio

### Objeto de petición:

<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">monto</td><td valign="top">Sí</td><td valign="top">decimal</td><td valign="top">Monto de la transacción en dólares. Debe ser mayor a 0.</td></tr><tr><td valign="top">emailCliente</td><td valign="top">Sí</td><td valign="top">string (max 100)</td><td valign="top">Correo electrónico del cliente. Debe tener un formato válido.</td></tr><tr><td valign="top">nombreCliente</td><td valign="top">Sí</td><td valign="top">string (max 100)</td><td valign="top">Nombre del cliente que realizará la compra con bitcoin.</td></tr><tr><td valign="top">apellidoCliente</td><td valign="top">Sí</td><td valign="top">string (max 100)</td><td valign="top">Apellido del cliente que realizará la compra con bitcoin.</td></tr><tr><td valign="top">fechaNacimientoCliente</td><td valign="top">Sí</td><td valign="top">DateTime</td><td valign="top">Fecha de nacimiento del cliente.</td></tr><tr><td valign="top">documentoIdentidadCliente</td><td valign="top">Sí</td><td valign="top">string (max 100)</td><td valign="top">Número de documento de identidad del cliente.</td></tr><tr><td valign="top">direccionCliente</td><td valign="top">Sí</td><td valign="top">string (max 150)</td><td valign="top">Dirección del cliente.</td></tr><tr><td valign="top">idRegion</td><td valign="top">Sí</td><td valign="top">string (max 2)</td><td valign="top">Código de país según ISO 3166-1 alpha-2 (ej. SV).</td></tr><tr><td valign="top">idTerritorio</td><td valign="top">Sí</td><td valign="top">string</td><td valign="top">Código de territorio según ISO 3166-2 (ej. SV-SS).</td></tr><tr><td valign="top">configuracion</td><td valign="top">No</td><td valign="top">Objeto</td><td valign="top">Configuración de la transacción. Si se omite, se usa la configuración del negocio.</td></tr><tr><td valign="top">datosAdicionales</td><td valign="top">No</td><td valign="top">Objeto (Diccionario)</td><td valign="top">Pares clave/valor incluidos en reportes y webhooks.</td></tr><tr><td valign="top">idExterno</td><td valign="top">No</td><td valign="top">string (max 50)</td><td valign="top">Identificador definido por el comercio para la transacción.</td></tr></tbody></table>

### Objeto Configuracion

<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">configuracion:emailsNotificacion</td><td valign="top">No</td><td valign="top">string</td><td valign="top">Lista de correos electrónicos separados por comas para notificaciones.</td></tr><tr><td valign="top">configuracion:urlWebhook</td><td valign="top">No</td><td valign="top">string</td><td valign="top">URL del webhook a invocar después de una transacción exitosa.</td></tr><tr><td valign="top">configuracion:telefonosNotificacion</td><td valign="top">No</td><td valign="top">string</td><td valign="top">Lista de teléfonos separados por comas para notificaciones.</td></tr><tr><td valign="top">configuracion:notificarTransaccionCliente</td><td valign="top">No</td><td valign="top">bool?</td><td valign="top">Indica si se enviará un correo al cliente tras un pago exitoso.</td></tr></tbody></table>

### Ejemplo petición:

```
{
  "monto": 0,
  "emailCliente": "user@example.com",
  "nombreCliente": "string",
  "apellidoCliente": "string",
  "fechaNacimientoCliente": "2026-03-10T16:18:35.786Z",
  "documentoIdentidadCliente": "string",
  "direccionCliente": "string",
  "idRegion": "string",
  "idTerritorio": "string",
  "configuracion": {
    "emailsNotificacion": "string",
    "urlWebhook": "string",
    "telefonosNotificacion": "string",
    "notificarTransaccionCliente": true
  },
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "idExterno": "string"
}
```

### 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">datosBitcoin</td><td valign="top">Objeto</td><td valign="top"> </td></tr><tr><td valign="top">Transacción</td><td valign="top"> Objeti</td><td valign="top"> </td></tr></tbody></table>

### Objeto datosBitcoin

<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">datosBitcoin:urlQR</td><td valign="top">string</td><td valign="top">URL del código QR para realizar el pago.</td></tr><tr><td valign="top">datosBitcoin:qrData</td><td valign="top">string</td><td valign="top">Dirección del pago para copiar y pegar en lugar de usar el QR.</td></tr><tr><td valign="top">datosBitcoin:ammountInBitcoins</td><td valign="top">decimal</td><td valign="top">Monto por pagar en bitcoins.</td></tr><tr><td valign="top">datosBitcoin:ammountInDollars</td><td valign="top">decimal</td><td valign="top">Monto por pagar en dólares.</td></tr><tr><td valign="top">datosBitcoin:fechaVencimiento</td><td valign="top">DateTimeOffset</td><td valign="top">Fecha y hora en la que expira el código QR.</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">Campo</td><td valign="top">Tipo Dato</td><td valign="top">Descripción</td></tr><tr><td valign="top">idTransaccion</td><td valign="top">string</td><td valign="top">Identificador único de la transacción.</td></tr><tr><td valign="top">esReal</td><td valign="top">bool</td><td valign="top">Indica si la transacción fue real según el ambiente del negocio.</td></tr><tr><td valign="top">esAprobada</td><td valign="top">bool</td><td valign="top">Indica si la transacción fue autorizada correctamente.</td></tr><tr><td valign="top">codigoAutorizacion</td><td valign="top">string</td><td valign="top">Código de autorización retornado cuando la transacción es exitosa.</td></tr><tr><td valign="top">mensaje</td><td valign="top">string</td><td valign="top">Mensaje de error retornado cuando la transacción no fue exitosa.</td></tr><tr><td valign="top">formaPago</td><td valign="top">int (anulable)</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">monto</td><td valign="top">decimal</td><td valign="top">Monto de la transacción en dólares.</td></tr><tr><td valign="top">idExterno</td><td valign="top">string</td><td valign="top">Identificador definido por el comercio para la transacción.</td></tr></tbody></table>

### Ejemplo Respuesta:

```
{
  "datosBitcoin": {
    "urlQR": "string",
    "qrData": "string",
    "ammountInBitcoins": 0,
    "ammountInDollars": 0,
    "fechaVencimiento": "2026-03-10T16:18:35.787Z"
  },
  "idTransaccion": "string",
  "esReal": true,
  "esAprobada": true,
  "codigoAutorizacion": "string",
  "mensaje": "string",
  "formaPago": 0,
  "monto": 0,
  "idExterno": "string"
}
```


# Crear Transaccion Compra Quick-Pay

Permite generar los datos para hacer un cobro con quick pay

{% hint style="info" %}
POST /TransaccionCompra/Quick-pay
{% endhint %}

Autenticación: Cuenta Wompi o negocio

### Objeto de petición:

<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">monto</td><td valign="top">Sí</td><td valign="top">decimal</td><td valign="top">Monto de la transacción en dólares. Debe ser mayor a 0.</td></tr><tr><td valign="top">configuracion</td><td valign="top">No</td><td valign="top">Objeto</td><td valign="top">Configuración de la transacción. Si se omite, se usa la configuración del negocio.</td></tr><tr><td valign="top">datosAdicionales</td><td valign="top">No</td><td valign="top">Objeto (Diccionario)</td><td valign="top">Pares clave/valor incluidos en reportes y webhooks.</td></tr><tr><td valign="top">idExterno</td><td valign="top">No</td><td valign="top">string (max 50)</td><td valign="top">Identificador definido por el comercio para la transacción.</td></tr></tbody></table>

### Objeto Configuracion

<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">configuracion:emailsNotificacion</td><td valign="top">No</td><td valign="top">string</td><td valign="top">Lista de correos electrónicos separados por comas para notificaciones.</td></tr><tr><td valign="top">configuracion:urlWebhook</td><td valign="top">No</td><td valign="top">string</td><td valign="top">URL del webhook a invocar después de una transacción exitosa.</td></tr><tr><td valign="top">configuracion:telefonosNotificacion</td><td valign="top">No</td><td valign="top">string</td><td valign="top">Lista de teléfonos separados por comas para notificaciones.</td></tr><tr><td valign="top">configuracion:notificarTransaccionCliente</td><td valign="top">No</td><td valign="top">bool (anulable)</td><td valign="top">Indica si se enviará un correo al cliente tras un pago exitoso.</td></tr></tbody></table>

### Ejemplo Petición:

```
{
  "monto": 0,
  "configuracion": {
    "emailsNotificacion": "string",
    "urlWebhook": "string",
    "telefonosNotificacion": "string",
    "notificarTransaccionCliente": true
  },
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "idExterno": "string"
}
```

### 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">datosQuickPay</td><td valign="top">Objeto</td><td valign="top"> </td></tr><tr><td valign="top">Transacción</td><td valign="top"> Objeto</td><td valign="top"> </td></tr></tbody></table>

### Objeto DatosQuickPay

<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">datosQuickPay:urlQR</td><td valign="top">string</td><td valign="top">URL del código QR para realizar el pago QuickPay.</td></tr><tr><td valign="top">datosQuickPay:fechaVencimiento</td><td valign="top">DateTimeOffset</td><td valign="top">Fecha y hora en la que expira el código QR.</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">Campo</td><td valign="top">Tipo Dato</td><td valign="top">Descripción</td></tr><tr><td valign="top">idTransaccion</td><td valign="top">string</td><td valign="top">Identificador único de la transacción.</td></tr><tr><td valign="top">esReal</td><td valign="top">bool</td><td valign="top">Indica si la transacción fue real según el ambiente del negocio.</td></tr><tr><td valign="top">esAprobada</td><td valign="top">bool</td><td valign="top">Indica si la transacción fue autorizada correctamente.</td></tr><tr><td valign="top">codigoAutorizacion</td><td valign="top">string</td><td valign="top">Código de autorización retornado cuando la transacción es exitosa.</td></tr><tr><td valign="top">mensaje</td><td valign="top">string</td><td valign="top">Mensaje de error retornado cuando la transacción no fue exitosa.</td></tr><tr><td valign="top">formaPago</td><td valign="top">int (anulable)</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">monto</td><td valign="top">decimal</td><td valign="top">Monto de la transacción en dólares.</td></tr><tr><td valign="top">idExterno</td><td valign="top">string</td><td valign="top">Identificador definido por el comercio para la transacción.</td></tr></tbody></table>

### Ejemplo Respuesta:

```
{
  "datosQuickPay": {
    "urlQR": "string",
    "fechaVencimiento": "2026-03-10T16:26:15.928Z"
  },
  "idTransaccion": "string",
  "esReal": true,
  "esAprobada": true,
  "codigoAutorizacion": "string",
  "mensaje": "string",
  "formaPago": 0,
  "monto": 0,
  "idExterno": "string"
}
```


# Crear Transaccion Compra Tokenizada Sin 3Ds

Permite realizar transacciones tokenizadas sin 3D Secure

{% hint style="info" %}
POST /TransaccionCompra/TokenizadaSin3Ds
{% endhint %}

Autenticación: Cuenta Wompi o negocio

### Parámetros de ruta:

<table><thead><tr><th valign="top">Campo</th><th valign="top">Es Rquerido</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">No</td><td valign="top">String</td><td valign="top">Identificador del negocio relacionado a la transacción</td></tr></tbody></table>

&#x20;

### Objeto de petición:

<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">monto</td><td valign="top">Sí</td><td valign="top">decimal (anulable)</td><td valign="top">Monto de la transacción en dólares (mayor a 0).</td></tr><tr><td valign="top">emailCliente</td><td valign="top">Sí</td><td valign="top">string</td><td valign="top">Correo electrónico del cliente para notificaciones.</td></tr><tr><td valign="top">nombreCliente</td><td valign="top">Sí</td><td valign="top">string</td><td valign="top">Nombre del cliente.</td></tr><tr><td valign="top">tokenTarjeta</td><td valign="top">Sí</td><td valign="top">string</td><td valign="top">Token de la tarjeta tokenizada.</td></tr><tr><td valign="top">configuracion</td><td valign="top">No</td><td valign="top">Objeto</td><td valign="top">Configuración opcional de la transacción.</td></tr><tr><td valign="top">datosAdicionales</td><td valign="top">No</td><td valign="top">Objeto (Diccionario)</td><td valign="top">Pares clave/valor incluidos en reportes y webhooks.</td></tr></tbody></table>

### Objeto Configuracion

<table><thead><tr><th valign="top">Campo</th><th valign="top">Es Rquerido</th><th valign="top">Tipo Dato</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">configuracion:emailsNotificacion</td><td valign="top">No</td><td valign="top">string</td><td valign="top">Correos separados por coma para notificaciones.</td></tr><tr><td valign="top">configuracion:urlWebhook</td><td valign="top">No</td><td valign="top">string</td><td valign="top">URL del webhook a invocar tras una transacción exitosa.</td></tr><tr><td valign="top">configuracion:telefonosNotificacion</td><td valign="top">No</td><td valign="top">string</td><td valign="top">Teléfonos separados por coma para notificaciones.</td></tr><tr><td valign="top">configuracion:notificarTransaccionCliente</td><td valign="top">No</td><td valign="top">Bool (anulable)</td><td valign="top">Indica si se notificará al cliente tras un pago exitoso.</td></tr></tbody></table>

### Ejemplo petición:

```
{
  "monto": 0,
  "emailCliente": "user@example.com",
  "nombreCliente": "string",
  "tokenTarjeta": "string",
  "configuracion": {
    "emailsNotificacion": "string",
    "urlWebhook": "string",
    "telefonosNotificacion": "string",
    "notificarTransaccionCliente": true
  },
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}
```

### 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">idTransaccion</td><td valign="top">string</td><td valign="top">Identificador único de la transacción.</td></tr><tr><td valign="top">esReal</td><td valign="top">bool</td><td valign="top">Indica si la transacción fue real (depende del entorno del aplicativo).</td></tr><tr><td valign="top">esAprobada</td><td valign="top">bool</td><td valign="top">Indica si la transacción fue autorizada correctamente.</td></tr><tr><td valign="top">codigoAutorizacion</td><td valign="top">string</td><td valign="top">Código de autorización retornado cuando la transacción es exitosa.</td></tr><tr><td valign="top">mensaje</td><td valign="top">string</td><td valign="top">Mensaje de error cuando la transacción no fue exitosa.</td></tr><tr><td valign="top">monto</td><td valign="top">decimal</td><td valign="top">Monto de la transacción en dólares.</td></tr></tbody></table>

### Ejemplo Respuesta

```
{
  "idTransaccion": "string",
  "esReal": true,
  "esAprobada": true,
  "codigoAutorizacion": "string",
  "mensaje": "string",
  "monto": 0
}
```


# Obtener Transacción Compra por Id

Consulta una transacción creada previamente incluyendo el resultado de esta

{% hint style="info" %}
GET /TransaccionCompra/{id}
{% endhint %}

Autenticación: Cuenta Wompi o negocio

### 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">id</td><td valign="top">Sí</td><td valign="top">string</td><td valign="top">Identificador de la transacción</td></tr></tbody></table>

&#x20;

### 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">datosBitcoin</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 asociados a la transacción.</td></tr><tr><td valign="top">resultadoTransaccion</td><td valign="top">int (anulable)</td><td valign="top">Resultado final de la transacción.</td></tr><tr><td valign="top">fechaTransaccion</td><td valign="top">DateTimeOffset (anulable)</td><td valign="top">Fecha y hora en que se realizó la transacción.</td></tr><tr><td valign="top">montoOriginal</td><td valign="top">decimal (anulable)</td><td valign="top">Monto original de la transacción.</td></tr><tr><td valign="top">Transacción</td><td valign="top"> </td><td valign="top"> </td></tr></tbody></table>

### Objeto datosBitcoin

<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">datosBitcoin:urlQR</td><td valign="top">string</td><td valign="top">URL del código QR para realizar el pago.</td></tr><tr><td valign="top">datosBitcoin:qrData</td><td valign="top">string</td><td valign="top">Dirección del pago para copiar y pegar en lugar de usar el QR.</td></tr><tr><td valign="top">datosBitcoin:ammountInBitcoins</td><td valign="top">decimal</td><td valign="top">Monto por pagar en bitcoins.</td></tr><tr><td valign="top">datosBitcoin:ammountInDollars</td><td valign="top">decimal</td><td valign="top">Monto por pagar en dólares.</td></tr><tr><td valign="top">datosBitcoin:fechaVencimiento</td><td valign="top">DateTimeOffset</td><td valign="top">Fecha y hora en la que expira el código QR.</td></tr></tbody></table>

### Ejemplo Respuesta

```
{
  "datosBitcoin": {
    "urlQR": "string",
    "qrData": "string",
    "ammountInBitcoins": 0,
    "ammountInDollars": 0,
    "fechaVencimiento": "2026-03-10T16:31:35.875Z"
  },
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "resultadoTransaccion": 0,
  "fechaTransaccion": "2026-03-10T16:31:35.875Z",
  "montoOriginal": 0,
  "idTransaccion": "string",
  "esReal": true,
  "esAprobada": true,
  "codigoAutorizacion": "string",
  "mensaje": "string",
  "formaPago": 0,
  "monto": 0,
  "idExterno": "string"
}
```


# Obtener Estadisticas de Transacciones Diarias

Obtiene un resumen de las transacciones diarias

{% hint style="info" %}
GET /TransaccionCompra/estadistica/diaria
{% endhint %}

Autenticación: Cuenta Wompi o negocio

### 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">fechaInicio</td><td valign="top">No</td><td valign="top">DateTimeOffset (anulable)</td><td valign="top">Fecha inicial de las transacciones. Si no se incluye, se toma desde la primera transacción realizada.</td></tr><tr><td valign="top">fechaFin</td><td valign="top">No</td><td valign="top">DateTimeOffset (anulable)</td><td valign="top">Fecha final de las transacciones. Si no se incluye, se toma hasta la última transacción realizada.</td></tr><tr><td valign="top">numeroCuenta</td><td valign="top">No</td><td valign="top">string</td><td valign="top">Número de cuenta bancaria.</td></tr><tr><td valign="top">formaPago</td><td valign="top">No</td><td valign="top">int (anulable)</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">resultadoTransaccion</td><td valign="top">No</td><td valign="top">int (anulable)</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">emailCliente</td><td valign="top">No</td><td valign="top">string</td><td valign="top">Email del cliente que realizó la transacción.</td></tr><tr><td valign="top">idAplicativo</td><td valign="top">No</td><td valign="top">string</td><td valign="top">Identificador del negocio que se desea consultar.</td></tr><tr><td valign="top">montoInicial</td><td valign="top">No</td><td valign="top">decimal (anulable)</td><td valign="top">Monto inicial de las transacciones a buscar.</td></tr><tr><td valign="top">montoFinal</td><td valign="top">No</td><td valign="top">decimal (anulable)</td><td valign="top">Monto final de las transacciones a buscar.</td></tr></tbody></table>

&#x20;

### 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">montoTotalDiario</td><td valign="top">decimal</td><td valign="top">Monto total de las compras realizadas en el día.</td></tr><tr><td valign="top">transaccionesAprobadasDelDia</td><td valign="top">int</td><td valign="top">Número total de transacciones exitosas del día.</td></tr><tr><td valign="top">transaccionesDeclinadasDelDia</td><td valign="top">int</td><td valign="top">Número total de transacciones declinadas del día.</td></tr></tbody></table>

### Ejemplo Respuesta

```
{
  "montoTotalDiario": 0,
  "transaccionesAprobadasDelDia": 0,
  "transaccionesDeclinadasDelDia": 0
}
```


# Obtener Comprobante de Transacción Compra

Obtiene el comprobante de pago de la transacción

{% hint style="info" %}
GET /TransaccionCompra/{idTransaccion}/comprobante
{% endhint %}

Autenticación: Cuenta Wompi o negocio

### Parámetros de ruta:

<table><thead><tr><th valign="top">Campo</th><th valign="top">Tipo Dato</th><th valign="top">Es Requerido</th><th valign="top">Descripción</th></tr></thead><tbody><tr><td valign="top">idTransaccion</td><td valign="top">string</td><td valign="top">Sí</td><td valign="top">Identificador de la transacción</td></tr></tbody></table>


# Crear Transacción Compra Mpos

Permite generar una transacción de mpos con los datos enviados

{% hint style="info" %}
POST /TransaccionCompra/Mpos
{% endhint %}

Autenticación: Cuenta Wompi o negocio

Autorización: Requiere permisos adicionales

### Objeto de petición:

<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">idAplicativo</td><td valign="top">Condicional</td><td valign="top">string</td><td valign="top">Identificador del negocio. Si el usuario está autenticado con datos del negocio, se toma automáticamente; de lo contrario, este campo se vuelve requerido.</td></tr><tr><td valign="top">tlv</td><td valign="top">Sí</td><td valign="top">string</td><td valign="top">TLV de la transacción MPOS. Dato obligatorio.</td></tr><tr><td valign="top">posId</td><td valign="top">Sí</td><td valign="top">string</td><td valign="top">Identificador del POS desde el cual se realiza la transacción.</td></tr><tr><td valign="top">tipoTransaccion</td><td valign="top">Sí</td><td valign="top">int</td><td valign="top">Tipo de transacción MPOS. Valores permitidos limitados (por validación) a MPosChip = 4 y MPosContactless = 5.</td></tr><tr><td valign="top">datosAdicionales</td><td valign="top">No</td><td valign="top">Objeto (Diccionario)</td><td valign="top">Lista de pares clave/valores asociados a la transacción. Se incluyen en reportes y webhooks. Campos especiales como <em>Email, Celular y Nombre</em> pueden visualizarse en reportes.</td></tr></tbody></table>

### &#x20;Ejemplo Petición

```
{
  "idAplicativo": "string",
  "tlv": "string",
  "posId": "string",
  "tipoTransaccion": 0,
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}
```

### 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">idTransaccion</td><td valign="top">string</td><td valign="top">Identificador único de la transacción.</td></tr><tr><td valign="top">esReal</td><td valign="top">bool</td><td valign="top">Indica si la transacción fue real. Depende de si el negocio asociado está en producción.</td></tr><tr><td valign="top">esAprobada</td><td valign="top">bool</td><td valign="top">Indica si la transacción fue autorizada correctamente.</td></tr><tr><td valign="top">codigoAutorizacion</td><td valign="top">string</td><td valign="top">Código de autorización retornado cuando la transacción es exitosa.</td></tr><tr><td valign="top">mensaje</td><td valign="top">string</td><td valign="top">Mensaje de error retornado cuando la transacción no fue exitosa.</td></tr><tr><td valign="top">tipoTransaccion</td><td valign="top">int</td><td valign="top">Tipo de transacción MPOS. Valores permitidos limitados (por validación) a MPosChip = 4 y MPosContactless = 5.</td></tr><tr><td valign="top">monto</td><td valign="top">decimal</td><td valign="top">Monto de la transacción en dólares.</td></tr><tr><td valign="top">fechaTransaccion</td><td valign="top">DateTimeOffset (anulable)</td><td valign="top">Fecha y hora en que se realizó la transacción.</td></tr><tr><td valign="top">confirmacionTransaccionTarjetaEmv</td><td valign="top">string</td><td valign="top">Datos de confirmación EMV de la tarjeta.</td></tr><tr><td valign="top">tarjetaParcial</td><td valign="top">string</td><td valign="top">Número parcial de la tarjeta utilizada en la transacción.</td></tr><tr><td valign="top">marca</td><td valign="top">string</td><td valign="top">Marca de la tarjeta (por ejemplo: Visa, MasterCard).</td></tr><tr><td valign="top">tsi</td><td valign="top">string</td><td valign="top">Transaction Status Indicator (TSI) de la transacción.</td></tr><tr><td valign="top">aid</td><td valign="top">string</td><td valign="top">Identificador de la aplicación EMV (AID).</td></tr><tr><td valign="top">rrn</td><td valign="top">string</td><td valign="top">Identificador correlativo de la transacción (Retrieval Reference Number).</td></tr></tbody></table>

### Ejemplo Respuesta:

```
{
  "idTransaccion": "string",
  "esReal": true,
  "esAprobada": true,
  "codigoAutorizacion": "string",
  "mensaje": "string",
  "tipoTransaccion": 0,
  "monto": 0,
  "fechaTransaccion": "2026-03-10T16:33:34.317Z",
  "confirmacionTransaccionTarjetaEmv": "string",
  "tarjetaParcial": "string",
  "marca": "string",
  "tsi": "string",
  "aid": "string",
  "rrn": "string"
}
```


# Crear Transacción Compra Banda

Permite generar una transacción de mpos tipo banda con los datos enviados

{% hint style="info" %}
POST /TransaccionCompra/Mpos/Banda
{% endhint %}

Autenticación: Cuenta Wompi o negocio

Autorización: Requiere permisos adicionales

### Objeto de petición:

<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">idAplicativo</td><td valign="top">Condicional</td><td valign="top">string</td><td valign="top">Identificador del negocio. Si el usuario está logueado con un negocio, se toma automáticamente; de lo contrario, este campo se vuelve requerido.</td></tr><tr><td valign="top">posId</td><td valign="top">Sí</td><td valign="top">string</td><td valign="top">Identificador del POS.</td></tr><tr><td valign="top">numeroTarjeta</td><td valign="top">Sí</td><td valign="top">string</td><td valign="top">Número completo de la tarjeta de crédito para ejecutar la transacción de compra.</td></tr><tr><td valign="top">mesVencimiento</td><td valign="top">Sí</td><td valign="top">int</td><td valign="top">Mes de vencimiento de la tarjeta. Debe estar en el rango de 1 a 12.</td></tr><tr><td valign="top">anioVencimiento</td><td valign="top">Sí</td><td valign="top">int</td><td valign="top">Año de vencimiento de la tarjeta de crédito. Validado por regla específica para MPOS.</td></tr><tr><td valign="top">monto</td><td valign="top">Sí</td><td valign="top">decimal (anulable)</td><td valign="top">Monto de la transacción en dólares. Debe ser mayor a 0.</td></tr><tr><td valign="top">tarjetaBan</td><td valign="top">Sí</td><td valign="top">string</td><td valign="top">Número de tarjeta en formato encTRACK2, retornado por el dispositivo MPOS.</td></tr><tr><td valign="top">llaveTarjetaBan</td><td valign="top">Sí</td><td valign="top">string</td><td valign="top">Llave encTRACK KSN, retornada por el dispositivo MPOS.</td></tr><tr><td valign="top">datosAdicionales</td><td valign="top">No</td><td valign="top">Objeto (Diccionario)</td><td valign="top">Lista de pares clave/valores relacionados a la transacción, utilizados en reportes y webhooks.</td></tr></tbody></table>

### Ejemplo petición:

```
{
  "idAplicativo": "string",
  "posId": "string",
  "numeroTarjeta": "string",
  "mesVencimiento": 0,
  "anioVencimiento": 0,
  "monto": 0,
  "tarjetaBan": "string",
  "llaveTarjetaBan": "string",
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}
```

### 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">idTransaccion</td><td valign="top">string</td><td valign="top">Identificador único de la transacción.</td></tr><tr><td valign="top">esReal</td><td valign="top">bool</td><td valign="top">Indica si la transacción de compra fue real. Depende de si el negocio está en producción.</td></tr><tr><td valign="top">esAprobada</td><td valign="top">bool</td><td valign="top">Indica si la transacción fue autorizada correctamente.</td></tr><tr><td valign="top">codigoAutorizacion</td><td valign="top">string</td><td valign="top">Código de autorización retornado cuando la transacción es exitosa.</td></tr><tr><td valign="top">mensaje</td><td valign="top">string</td><td valign="top">Mensaje de error retornado cuando la transacción no fue exitosa.</td></tr><tr><td valign="top">tipoTransaccion</td><td valign="top">int</td><td valign="top">Tipo de transacción MPOS. Valores permitidos limitados (por validación) a MPosChip = 4 y MPosContactless = 5.</td></tr><tr><td valign="top">monto</td><td valign="top">decimal</td><td valign="top">Monto de la transacción en dólares.</td></tr><tr><td valign="top">fechaTransaccion</td><td valign="top">DateTimeOffset (anulable)</td><td valign="top">Fecha en la que se realizó la transacción.</td></tr></tbody></table>

### Ejemplo Respuesta

```
{
  "idTransaccion": "string",
  "esReal": true,
  "esAprobada": true,
  "codigoAutorizacion": "string",
  "mensaje": "string",
  "tipoTransaccion": 0,
  "monto": 0,
  "fechaTransaccion": "2026-03-10T16:38:55.964Z"
}
```


# Agregar firma a Transacción Compra Mpos

Permite agregar una firma a una transacción de compra Mpos

{% hint style="info" %}
POST /TransaccionCompra/Mpos/{idTransaccion}/firma
{% endhint %}

Autenticación: Cuenta Wompi o negocio

Autorización: Requiere permisos adicionales

### 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">idTransaccion</td><td valign="top">Sí</td><td valign="top">string</td><td valign="top">Identificador de la transacción</td></tr></tbody></table>

&#x20;

### Objeto de petición:

Archivo con la firma

### 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">urlFirma</td><td valign="top">string</td><td valign="top">URL de la firma digital</td></tr></tbody></table>

### Ejemplo Respuesta:

```
{
  "urlFirma": "string"
}
```


# WooCommerce (Wordpress)

¡Acepta pagos en tu tienda WooCommerce en segundos!

![](/files/-MDFzrKeoeAVraI3BJYK)

## Requerimientos

1. Tener un sitio web con WordPress (5.4+) y con WooCommerce (4.3+) instalado.&#x20;
2. Tener permisos en el administrador de WordPress para instalar nuevos plugins&#x20;
3. [Crear una cuenta en Wompi ](https://wompi.sv)para poder obtener las llaves de acceso para poder utilizar la pasarela de pago.&#x20;

## Funcionalidades

1. Se permite pagar con la pasarela de pago de Wompi – El Salvador.&#x20;
2. Permite cobrar con Puntos Agrícola así como tarjetas de crédito, débito y configurar qué métodos de pago están activos.
3. Permite realizar cobros con Bitcoin, compatibles con Chivo Wallet

## Instalación

1. Descarga el plugin en formato zip desde [este enlace](https://github.com/wompisv/wocommerce-wompi-sv-plugin-v2/archive/refs/heads/main.zip).
2. Ingresar el sitio administrativo de tu WordPress.
3. Ingresar a la opción de menú de Plugins / Añadir Nuevo / Subir Plugin.
4. Buscar el plugin en formato .zip descargado en tu computadora y súbelo como cualquier otro archivo.
5. Después de instalar el .zip podrás verlo en el listado de plugins instalados, podrás activarlo.
6. Para configurar el plugin tendrás que ingresar a: Woocommerce / Ajustes / Pagos / WOMPI - El Salvador
7. [Dirígete a tu cuenta de Wompi](https://panel.wompi.sv) y copia el App ID y el API Secret obtenidos de las configuraciones generales del aplicativo en tu cuenta Wompi. Puedes ver como obtener el App Id y API Secret [aquí](https://docs.wompi.sv/auntenticacion/autenticacion#obtener-las-credenciales-de-autenticacion).&#x20;
8. Regresa a tu sitio administrativo de Wordpress y pega tu App ID y API Secret en la parte de la configuración de tu pasarela de pago Wompi - El Salvador.
9. Termina de configurar los demás campos como desees que funcione tu pasarela de pago.

**¡Comienza a hacer transacciones!**


# Shopify

¡Acepta pagos en tu tienda de Shopify con Wompi El Salvador en segundos!

<figure><img src="/files/jGwn6pB2bqoTPFAxgWRj" alt=""><figcaption></figcaption></figure>

## &#x20;**Requerimientos**

&#x20;1\. Tener una tienda en Shopify y con Wompi El Salvador instalado.

&#x20;2\. Crear una cuenta en Wompi para obtener las llaves de acceso para poder utilizar la pasarela de pago.

## &#x20;**Funcionalidades**

&#x20;1\. Se permite pagar con la pasarela de pago de Wompi – El Salvador.

&#x20;2\. Permite cobrar con Puntos Agrícola así como tarjetas de crédito, débito y configurar qué métodos de pago están activos.

&#x20;3\. Permite realizar cobros con Bitcoin, compatibles con Chivo Wallet.

&#x20;

## **Instalación**

&#x20;1\. Busca la aplicación en la tienda de aplicaciones de Shopify aquí (<https://apps.shopify.com/wompi-gateway?locale=es>).

&#x20;2\. Dar permisos a la aplicación y aceptar la instalación en el panel de administrador de la tienda de Shopify.

&#x20;

<figure><img src="/files/fnJpqUCrZNU7JPwgbrjh" alt=""><figcaption></figcaption></figure>

&#x20;&#x20;

3\. Dar click en Gestionar, lo que abrirá el formulario de configuración de la aplicación

<figure><img src="/files/c7L8AzlLiB6hlKbjgBgA" alt=""><figcaption></figcaption></figure>

&#x20;4\. Dirígete a tu cuenta de Wompi y copia el App ID y el API Secret obtenidos de las configuraciones generales del aplicativo en tu cuenta Wompi. Puedes ver como obtener el App Id y API Secret

&#x20;5\. Regresa a tu sitio administrativo de Shopify pega tu App ID y API Secret en la parte de la configuración de tu pasarela de pago Wompi El Salvador.

&#x20;6\. Termina de configurar los demás campos como desees que funcione tu pasarela de pago dando al botón de Guardar Aplicativo.

&#x20;7\. Después de guardar el aplicativo es necesario llenar los últimos 3 campos del formulario y dar al botón de Actualizar Aplicativo, será redirigido a las configuraciones de pagos en Shopify.

&#x20;8\. Activar Wompi El Salvador en el panel de configuraciones de pagos en Shopify.

&#x20;

<figure><img src="/files/U9a3Y0Rsy7WEl4xGOZCx" alt=""><figcaption></figcaption></figure>

&#x20;**¡Comienza a hacer transacciones!**

&#x20;

&#x20;

&#x20;

&#x20;

&#x20;

&#x20;

&#x20;

&#x20;


# Definición Webhook

Wompi notifica sobre las transacciones exitosas mediante webhook.

Los webhook consisten en una petición HTTP Post generada por Wompi hacia la URL que el comercio ha definid como webhook.

El contenido de un webhook es el siguiente:

```
{
  "IdCuenta": "980b36e6-15ab-463f-4444-ada3e396fe48",
  "FechaTransaccion": "2020-07-07T21:27:03.3403497-06:00",
  "Monto": 1,
  "ModuloUtilizado": "BotonPago",
  "FormaPagoUtilizada": "PagoNormal",
  "IdTransaccion": "2bedafea-0924-49f0-927d-8c638e193990",
  "ResultadoTransaccion": "ExitosaAprobada",
  "CodigoAutorizacion": "ba7dbfd3-50d1-403c-bbfd-d3be5dc766f8",
  "IdIntentoPago": "c6e10505-cada-4ae7-9892-d8786b7f455f",
  "Cantidad": 1,
  "EsProductiva": false,
  "Aplicativo": {
    "Nombre": "Sitio Web Bitworks",
    "Url": "https://www.bitworks.com.sv/",
    "Id": "d432aef2-3333-4a75-4444-22e20789834a"
  },
  "EnlacePago": {
    "Id": 66,
    "IdentificadorEnlaceComercio": "OC1234",
    "NombreProducto": "Camisa Azula"
  },
  "cliente": {
    "Nombre": "string",
    "Email": "string",
    "additionalProp1": "string",
    "additionalProp2": "string"
  }
}

```


# Como Registrar mi Webhook

Esta pagina describe como un comercio puede definir la URL de su webhook.

## Desde el Panel de Wompi

Ingresar al  [Panel de Control](https://panel.wompi.sv) de Wompi.&#x20;

![Ingresar al listado de aplicativos y editar el aplicativo deseado](/files/-MB7OErh9fWOoCXDyZ9B)

![Detalle aplicatico](/files/-MB7PIue67m0WinnFV4h)

En el detalle del aplicativo colocar le url del webhook en la opción "**Notifica via Webhook**".

## Al Crear un Enlace de Pago

Es posible configurar un webhook diferente al del aplicativo para un enlace de pago especifico. Para eso basta con definir el URL del Webhook en el objeto "configuracion" el momento de crear el enlace de pago, para mas información ver [Crear Enlace de Pago](/metodos-api/enlace-de-pago#objeto-completo-de-peticion).

## Al Crear una Transacción de Compra

Es posible configurar un webhook diferente al del aplicativo para una transacción de compra especifica. Para eso basta con definir el URL del Webhook en el objeto "configuracion" el momento de crear la transacción de compra, para mas información ver [Crear Transacción Compra 3DS](/metodos-api/crear-transaccion-compra-3ds).


# Validar Webhook

Para asegurar que el webhook es de Wompi es necesario validarlo, en esta documento se muestra como.

Usuario mal intencionados podrían tratar de falsificar un webhook de Wompi para forzar que una transacción se marque como pagada en el sistema cliente. Se ofrecen dos formas para evitar esto.

## Validar con Hash

Todo webhook enviado por Wompi incluirá el header "wompi\_hash", este header es el hash SHA256 del contenido del body calculado con HMAC.&#x20;

Los pasos para validar son:

1. Leer el "body" completo del webhook. **Asegurarse leerlo tal cual es enviando sin agregar ningún espacio o salto de linea**.
2. Sacar el HMAC con algoritmo SHA256 del "body" utilizando el API Secret de su aplicativo de Wompi como llave del HMAC
3. Comparar el resultado del punto anterior con el valor de header "wompi\_hash", si es igual el webhook se puede considerar válido.

### Ejemplos

Nuestro plugin de Woocommerce ya hace esta validación, para ver como se realiza la validación en PHP puede consultar el código [aqui](https://github.com/wompisv/wocommerce-wompi-sv-plugin/blob/master/wc-WOMPI-payment.php#L41).

Si desea calcular un hash SHA256 con HMAC en C# puede usar este código

```
        private static string EncriptarData(string body, string secret)
        {
            UTF8Encoding encoding = new UTF8Encoding();

            var hash = new HMACSHA256(encoding.GetBytes(secret));
            byte[] stream = hash.ComputeHash(encoding.GetBytes(body));
            string textHash = string.Concat(stream.Select(b => b.ToString("x2")));
            hash.Dispose();
            return textHash;
        }
```

Si desea probar en linea el calculo del HMAC del webhook puede usar esta herramienta: <https://www.freeformatter.com/hmac-generator.html> colocando SHA256 en el algoritmo Digest y su Api Secret en el "Secret Key".

## Validar Consultando Transacción

Como se puede ver en nuestro [Swagger](https://api.wompi.sv/index.html), se incluye un método para extraer los datos de una transacción **/TransaccionCompra/{id}**. Puede utilizar la propiedad "IdTransaccion" para consultar los datos de la transacción y así confirmar que exista y este aprobada.&#x20;


# Parámetros de URL de Redirect

Además de poder saber el resultado de una transacción por medio de los [Webhook](/webhook/definicion-webhook), también es posible saberlo por medio de la URL de Redirect.&#x20;

La URL de Redirect es donde el pagador se redirecciona después de hacer un pago, la URL de redirect se puede especificar tanto al crear un [enlace de pago](/metodos-api/enlace-de-pago) como al iniciar una transacción de compra por medio de [API](/metodos-api/crear-transaccion-compra-3ds).&#x20;

{% hint style="warning" %}
Aunque se puede saber el resultado de una transacción por medio de la URL de redirect se recomienda usar siempre los Webhook en conjunto con la URL de Redirect, debido a que la entrega de la URL de Redirect depende del navegador del pagador, y el flujo podría fallar por problemas con internet, problemas con el explorador, etc.&#x20;

Ya que los Webhook se entregan de servidor a servidor y se tiene una lógica de reintentos de entrega es mucho más confiable que la URL de Redirect
{% endhint %}

Un ejemplo de uso de la URL de Redirect es la página donde el usuario se redirecciona después de hacer el pago, en la que se confirma su pago y se muestra el detalle de su compra.

## Parámetros de la URL de Redirect

A continuación se detallan los parámetros que se agregan a la URL de Redirect. Estos parámetros pueden utilizarse para determinar si la transacción fue exitosa o fallida.

Es importante notar que los parámetros varían si la transacción viene de un [enlace de pago](/metodos-api/enlace-de-pago) o de una transacción por [API](/metodos-api/crear-transaccion-compra-3ds).

<table><thead><tr><th>Parametro</th><th width="142">Tipo Dato</th><th>Aplica para</th><th>Descripción</th></tr></thead><tbody><tr><td>idTransaccion</td><td>Cadena de 36 caracteres </td><td><ul><li>Enlace de Pago</li><li>API</li></ul></td><td>Es el identificador único de la tracción</td></tr><tr><td>monto</td><td>Decimal</td><td><p></p><ul><li>Enlace de Pago</li><li>API</li></ul></td><td>En formato #####.## (sin separador de miles y con punto para separar los decimales)</td></tr><tr><td>esReal</td><td>bool</td><td><p></p><ul><li>API</li></ul></td><td><p>Viene el texto "true" cuando la transacción es real.</p><p></p><p>Viene el texto "false" si es una transacción en un ambiente de prueba, es decir que el aplicativo asociado no es productivo y que no se hizo un cobro real.</p></td></tr><tr><td>codigoAutorizacion</td><td>Cadena de caracteres</td><td><p></p><ul><li>API</li></ul></td><td>El código de autorización de la transacción. No debería tener más de 10 caracteres.</td></tr><tr><td>mensaje</td><td>Cadena de Caracteres</td><td><p></p><ul><li>API</li></ul></td><td>Es de utilidad cuando la transacción fallo ya que allí se explica la razon del fallo, como máximo tendrá 50 caracteres.</td></tr><tr><td>formaPago</td><td>enum</td><td><ul><li>API</li></ul></td><td>Pude ser uno de los siguiente valores:<br>* PagoNormal<br>* Puntos<br>* Cuotas<br>* Bitcoin<br></td></tr><tr><td>esAprobada</td><td>bool</td><td><ul><li>API</li></ul></td><td>"true" si la transacción es exitosa.<br><br>"false" si es fallida</td></tr><tr><td>identificadorEnlaceComercio</td><td>cadena</td><td><ul><li>Enlace Pago</li></ul></td><td>Es la cadena de caracteres que se envió en el parámetro  "identificadorEnlaceComercio" al <a href="/pages/-MB516CISujPBe1v7Zi7">crear el enlace de pago</a></td></tr><tr><td>idEnlace</td><td>entero</td><td><ul><li>Enlace Pago</li></ul></td><td>El identificador único del enlace de pago generado internamente por Wompi</td></tr><tr><td>hash</td><td>cadena caracteres</td><td><ul><li>Enlace pago</li><li>API</li></ul></td><td>Hash HMAC para validar que ninguno de los parámetros haya sido modificado en transito.</td></tr></tbody></table>

## Como Determinar si Una Transacción es Exitosa

### Opción 1: Consultando datos de Transacción

Es posible invocar el end point del [API ](https://api.wompi.sv/index.html)"**/TransaccionCompra/{id}**" con el valor del paramero idTransaccion en el "id" de la url del end point del API.

Del objeto retornado por el API validar:

* esReal sea "true"
* esAprobada sea "true"
* Opcionalmente que la propiedad "monto" coincida con lo que se deseaba cobrar

Para la definición completa del API referirse al [Swagger](https://api.wompi.sv/).  Para entender como autenticarse en el API referirse a la [sección de autenticación](/autenticacion/autenticacion).

### Opción 2: Usar solo los parámetros del URL de Redirect

En el caso de las URL Redirect de API basta con usar los parámetros de redirect para saber si la transacción es exitosa, esto es posible ya que los tres parámetros vienen en la URL:

* esReal sea "true"
* esAprobada sea "true"
* Opcionalmente que la propiedad "monto: coincida con lo que se deseaba cobrar

{% hint style="danger" %}
**Importante:** Si se usa solo los parámetros de la URL de Redirect, sin consultar el API,  para ver si la transacción es exitosa; es indispensable validar que el HASH este correcto. Si esto no se hace es posible que el usuario pagador modifique los parámetros en transito. Por ejemplo , el parámetro "esAprobada" cambiarse  de "false" a "true", generando un falso positivo.

Para ver como generar el hash y validarlo referirse  a  "[Validar Parámetros de URL Redirect](/redirect-url/validar-parametros-url-redirect)"
{% endhint %}

### Ejemplos URLs de Redirect

* URL API:  <https://wompi.sv/?idTransaccion=0abac760-e642-46e0-b658-0f526957b88a&monto=10&esReal=True&formaPago=PagoNormal&esAprobada=True&codigoAutorizacion=270015&mensaje=AUTORIZADO&hash=986d4c7667bd0a9ef446dbbbb5939618c7a51f6a4860d34259a1c76f2a8f0d03>
* URL Enlace Pago: <https://wompi.sv/?identificadorEnlaceComercio=test-link&idTransaccion=d0efabed-12e0-4915-abc1-0d3689906700&idEnlace=1384854&monto=10&hash=1a658786ae50a582587183ee462c8fc63674636d82a688d4fe8c2b744fd27641>


# Validar Parámetros URL Redirect

La generación del Hash es distinta para la URL de Redirect del API y del enlace de pago. Hay diferencia debido a que los parámetros de cada enlace varían, y el orden con que se coloquen los parámetros para generar el hash causa que se genera un hash distinto.

Los pasos para validar son:

1. Concatenar los parámetros de interés de la URL de Redirect
2. Sacar el HMAC con algoritmo SHA256 de la cadena de caracteres resultante del punto 1, utilizando el API Secret de su aplicativo de Wompi como llave del HMAC
3. Comparar el resultado del punto anterior con el valor del parámetro "hash", si es igual es proque los parámetros no han sido modificados en transito.

Ya que el orden de los parámetros afecta el hash generado a continuación se detalla el orden en que se deben concatenar los parámetros en el paso 1 para cada tipo de URL de Redirect.

## Orden de Concatenación de Parametros en URL de Redirect de  API

1. idTransaccion
2. monto
3. esReal
4. formaPago
5. esAprobada
6. codigoAutorizacion
7. mensaje

## Orden de Concatenación de Parametros en URL de Redirect de  Enlace de Pago

1. identificadorEnlaceComercio
2. idTransaccion
3. idEnlace
4. monto

## Ejemplos

Si desea calcular un hash SHA256 con HMAC en C# puede usar este código:

```
private static string EncriptarData(string parametrosConcatenados, string secret)
        {
            UTF8Encoding encoding = new UTF8Encoding();

            var hash = new HMACSHA256(encoding.GetBytes(secret));
            byte[] stream = hash.ComputeHash(encoding.GetBytes(parametrosConcatenados));
            string textHash = string.Concat(stream.Select(b => b.ToString("x2")));
            hash.Dispose();
            return textHash;
        }
```