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

POST /v1/merchant/payment/intent

Encabezado

Name

Value

Content-Type *

application/json

x-auth-token *

<token>

child-id

{business_id}

El child-id es opcional y se usa para las cuentas administradas para conocer más puedes ingresa a este enlace.

Body

Name

Type

Description

external_reference *

string

Referencia única de la transacción a pagar Ej: A1A2A3A4A

method *

string

Método de pago Opciones: [NEQUI, PSE, QR, CASH]Ej: NEQUI

phone ^_opcional

string

Número de celular desde el que se va a realizar el pago. Obligatorio para method NEQUIEj: 3001234567

bank_code ^_opcional

string

Código del banco desde el que se va a realizar el pago. Obligatorio para method PSE y CASHEj: 1001

client_type ^_opcional

string

Tipo de cliente para procesar pago en PSE. Por defecto individual. Opciones: [individual, business]Ej: individual

Ejemplos

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

Respuesta

{
  "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": {}
  }
}

{
  "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": {}
  }
}

{
  "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": {}
  }
}

{
  "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": {}
  }
}

Última actualización hace 28 días