> For the complete documentation index, see [llms.txt](https://docs.qentaz.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.qentaz.com/documentation/cobros/intento-de-pago.md).

# Intento de pago

La API de Intento de Pago te permite integrar funcionalidades de procesamiento de pagos en sus aplicaciones. Los usuarios pueden elegir entre varios métodos de pago y la API proporcionará las opciones necesarias para completar la transacción de manera segura y eficiente. Según el método seleccionado, retorna la acción necesaria para completar el pago.

**Métodos soportados:**

* `NEQUI` — Envía push de cobro a la app Nequi (acción: Notificación push)
* `PSE` — Genera link de redirección bancaria (acción: enlace redirección al banco)
* `QR` — Genera código QR para escanear (acción: imagen con código qr)
* `CASH` — Retorna convenio y referencia para pago en punto físico (acción: información de pago)

## Ruta

<mark style="color:green;">`POST`</mark> `/v1/merchant/payment/intent`

### Encabezado

| Name                    | Value              |
| ----------------------- | ------------------ |
| `Content-Type` ***\**** | `application/json` |
| `x-auth-token` ***\**** | `<token>`          |
| `child-id`              | {business\_id}     |

{% hint style="info" %}
El child-id es opcional y se usa para las cuentas administradas para conocer más puedes ingresa a este [enlace](/documentation/cobros/terminos-de-relevancia.md#cuentas-administradas).
{% endhint %}

### Body

<table><thead><tr><th width="227.83203125">Name</th><th width="107.296875">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>external_reference</code> *</td><td>string</td><td>Referencia única de la transacción a pagar<br><em><mark style="color:$info;">Ej: A1A2A3A4A</mark></em></td></tr><tr><td><code>method</code> *</td><td>string</td><td>Método de pago<br><code>Opciones: [NEQUI, PSE, QR, CASH]</code><br><em><mark style="color:$info;">Ej: NEQUI</mark></em></td></tr><tr><td><code>phone</code> <sup><sub><em><mark style="color:$info;">opcional</mark></em></sub></sup></td><td>string</td><td>Número de celular desde el que se va a realizar el pago.<br><code>Obligatorio para method NEQUI</code><br><em><mark style="color:$info;">Ej: 3001234567</mark></em></td></tr><tr><td><code>bank_code</code> <sup><sub><em><mark style="color:$info;">opcional</mark></em></sub></sup></td><td>string</td><td>Código del banco desde el que se va a realizar el pago.<br><code>Obligatorio para method PSE y CASH</code><br><em><mark style="color:$info;">Ej: 1001</mark></em></td></tr><tr><td><code>client_type</code> <sup><sub><em><mark style="color:$info;">opcional</mark></em></sub></sup></td><td>string</td><td>Tipo de cliente para procesar pago en PSE. Por defecto individual.<br><code>Opciones: [individual, business]</code><br><em><mark style="color:$info;">Ej: individual</mark></em></td></tr></tbody></table>

### Ejemplos

{% tabs %}
{% tab title="Pago Nequi" %}

```json
{
  "external_reference": "A1A2A3A4A",
  "method": "NEQUI",
  "phone": "3001234567"
}
```

{% endtab %}

{% tab title="Pago PSE" %}

```json
{
  "external_reference": "BJOFA7AAC",
  "method": "PSE",
  "bank_code": "1007",
  "client_type": "individual",
}
```

{% endtab %}

{% tab title="Pago QR" %}

```json
{
  "external_reference": "BJOFA7AAC",
  "method": "QR"
}
```

{% endtab %}

{% tab title="Pago Efectivo" %}

```json
{
  "external_reference": "BJOFA7AAC",
  "method": "CASH",
  "bank_code": "8790"
}
```

{% endtab %}
{% endtabs %}

### Respuesta

{% tabs %}
{% tab title="200 Nequi" %}

```json
{
  "success": true,
  "code": "Q800",
  "message": "El proceso se completo de manera correcta.",
  "data": {
    "external_reference": "BJOFA7AAC",
    "status": "PENDING",
    "method": "NEQUI",
    "amount": 1000,
    "currency": "COP",
    "action": {
      "type": "PUSH",
      "details": {
        "name": "Nequi",
        "instructions": "Ingresa a la app de Nequi y aprueba la solicitud de cobro."
      }
    },
    "meta": {}
  }
}
```

{% endtab %}

{% tab title="200 PSE" %}

```json
{
  "success": true,
  "code": "Q800",
  "message": "El proceso se completo de manera correcta.",
  "data": {
    "external_reference": "BJOFA7AAC",
    "status": "PENDING",
    "method": "PSE",
    "amount": 1000,
    "currency": "COP",
    "action": {
      "type": "REDIRECT",
      "details": {
        "name": "Cuenta bancaria",
        "instructions": "Ingresa al banco y completa la autenticación del pago.",
        "redirect_url": "https://botonbancolombia.apps.bancolombia.com/web/transfer-gateway/checkout/_dBhrwRNYOd"
      }
    },
    "meta": {}
  }
}
```

{% endtab %}

{% tab title="200 QR" %}

```json
{
  "success": true,
  "code": "Q800",
  "message": "El proceso se completo de manera correcta.",
  "data": {
    "external_reference": "BJOFA7AAC",
    "status": "PENDING",
    "method": "QR",
    "amount": 1000,
    "currency": "COP",
    "action": {
      "type": "IMAGE",
      "details": {
        "name": "QR",
        "instructions": "Escanea el QR para completar el pago.",
        "image_url": "https://content.trazo.co/qr-codes/example.jpg"
      }
    },
    "meta": {}
  }
}
```

{% endtab %}

{% tab title="200 Efectivo" %}

```json
{
  "success": true,
  "code": "Q800",
  "message": "El proceso se completo de manera correcta.",
  "data": {
    "external_reference": "BJOFA7AAC",
    "status": "PENDING",
    "method": "CASH",
    "amount": 1000,
    "currency": "COP",
    "action": {
      "type": "DATA",
      "details": {
        "name": "Efectivo",
        "instructions": "Ve a un corresponsal y presenta el convenio y la referencia para pagar.",
        "agreement": {
          "name": "CASH",
          "code": "8790",
          "reference": "124154",
          "expiration_date": "2026-03-31T19:03:14.463Z"
        }
      }
    },
    "meta": {}
  }
}
```

{% endtab %}
{% endtabs %}