📚 Inicio

👥 API REST Zonapagos

⚙️ Especificación de Parámetros

💻 Servicio InicioPago

🔍Verificación del Estado del Pago

💳 Información del Pago

Parámetro Tipo Obligatorio Descripción
flt_total_con_iva Numérico Sí Valor total a pagar, incluyendo el IVA.
str_id_pago Alfanumérico (hasta 30) Sí Identificador único del pago. Puede corresponder al número de factura u otro valor que permita identificar la transacción en el futuro.
str_descripcion_pago Alfanumérico (hasta 70) Sí Concepto o descripción del pago que realizará el cliente.

Nota: El valor de str_id_pago debe ser único por transacción activa y no debe reutilizarse para evitar inconsistencias en la validación de pagos.

🛡 Información de Seguridad

Parámetro Tipo Obligatorio Descripción
int_id_comercio Numérico Sí Identificador único del comercio en Zonapagos. Este valor es suministrado por Zonapagos.
str_usuario Alfanumérico (hasta 40) Sí Usuario validador entre el comercio y Zonapagos. Este valor es entregado por Zonapagos y debe enviarse en cada solicitud de inicio de pago.
str_clave Alfanumérico (hasta 50) Sí Clave de validación entre el comercio y Zonapagos. Este valor es entregado por Zonapagos y debe enviarse en cada solicitud de inicio de pago. Puede ser modificada por el comercio.
int_modalidad Numérico Sí Valor fijo. Siempre se debe enviar -1.

➕ Información Adicional del Pago

Parámetro Tipo Obligatorio Descripción
int_codigo Numérico Sí Identificador de la información adicional que se va a enviar en la transacción.

⚙ Parámetros Adicionales de Configuración

Parámetro Tipo Obligatorio Descripción
int_codigo Numérico Sí Identificador de la configuración adicional que puede aplicar el comercio para la transacción.

📋 Configuraciones Adicionales Válidas

Código Descripción Aplica
50 Código de servicio principal Aplica cuando el comercio utiliza el medio de pago PSE.

🧾 Información del Pago – Parámetros Opcionales

Parámetro Tipo Obligatorio Descripción
flt_valor_iva Numérico No Valor total del IVA. Si la transacción no aplica IVA, se debe enviar 0.
str_email Alfanumérico (hasta 70) No* Correo electrónico del cliente. Se recomienda enviarlo para que el cliente reciba la información del pago al finalizar la transacción.
str_id_cliente Alfanumérico (hasta 30) No* Identificador del cliente (Cédula, NIT u otro). Obligatorio para certificación PSE.
str_tipo_id Alfanumérico (hasta 5) No* Tipo de identificación del cliente según catálogo definido por Zonapagos. Obligatorio para certificación PSE.
str_nombre_cliente Alfanumérico (hasta 50) No Nombre del cliente que realizará el pago.
str_apellido_cliente Alfanumérico (hasta 50) No Apellido del cliente que realizará el pago.
str_telefono_cliente Alfanumérico (hasta 50) No Número de teléfono del cliente que realizará el pago.
str_opcional1 Alfanumérico (hasta 70) No Campo opcional definido por el comercio para información adicional de la transacción.
str_opcional2 Alfanumérico (hasta 70) No Campo opcional definido por el comercio para información adicional de la transacción.
str_opcional3 Alfanumérico (hasta 70) No Campo opcional definido por el comercio para información adicional de la transacción.
str_opcional4 Alfanumérico (hasta 70) No Campo opcional definido por el comercio para información adicional de la transacción.
str_opcional5 Alfanumérico (hasta 70) No Campo opcional definido por el comercio para información adicional de la transacción.

🪪 Tipos de Identificación del Cliente

Código Tipo de Identificación Descripción
0 No identificado No se usa o tipo no identificado
1 CC Cédula de Ciudadanía
2 CE Cédula de Extranjería
3 NIT NIT Empresa
4 NUIP Número Único de Identificación
5 TI Tarjeta de Identidad
6 PP Pasaporte
7 IDC Identificador Único del Cliente
8 CEL Número móvil o celular
9 RC Registro Civil de Nacimiento
10 DE Documento de Identificación Extranjero
11 OT Otro no tipificado

Nota: Para la certificación de PSE, los campos str_id_cliente y str_tipo_id son obligatorios.

➕ Información Adicional del Pago

Parámetro Tipo Obligatorio Descripción
str_valor Alfanumérico Sí Información adicional enviada por el comercio asociada al código del parámetro adicional del pago.

⚙ Parámetros Adicionales de Configuración

Parámetro Tipo Obligatorio Descripción
str_valor Alfanumérico Sí Información adicional enviada por el comercio asociada al código de configuración adicional.

Los parámetros válidos para el envío de configuración adicional son los siguientes:

Código Tipo Valores Permitidos Descripción
50 Obligatorio — Código de servicio principal. Aplica si el comercio utiliza el medio de pago PSE.
100 Opcional 0 / 1 / 2 Dividir en varios medios de pago. 0: Valor por defecto (no enviado). 1: Se puede dividir el pago. 2: No se puede dividir el pago.
101 Opcional 0 / 1 Dividir en varias Tarjetas de Crédito. 1: Se puede dividir en varias TC. 0: No se puede dividir en varias TC. Si el parámetro 100 permite dividir, este indica si aplica para TC.
102 Opcional 0 / 1 Dividir en varios PSE. 1: Se puede dividir en varios PSE. 0: No se puede dividir en varios PSE. Aplica si el parámetro 100 permite dividir.
103 Opcional 0 / 1 Desactivar PSE. 1: Desactiva el pago PSE (si está disponible). 0: No desactiva PSE.
104 Opcional URL URL de retorno del cliente. El usuario puede ser redirigido a esta URL en cualquier momento del ciclo del pago. Si no se envía, se usa la configuración por defecto del comercio.
105 Opcional Numérico Valor mínimo de fracción. Define el valor mínimo permitido para fraccionar un pago cuando se usan varios medios de pago. Si no se envía, se permite fraccionar en cualquier valor entero.
106 Opcional Numérico Número de fracciones máximas. Define el número máximo de fracciones permitidas cuando se utilizan varios medios de pago.
107 Opcional 0 / 1 Desactivar Tarjeta de Crédito. 1: Desactiva el pago con TC (si está disponible). 0: No desactiva TC.
108 Opcional 0 / 1 Activar términos y condiciones. 1: Activa el checkbox de términos y condiciones por defecto. 0: No activa la opción.
109 Opcional 0 / 1 Habilitar pagos mixtos. 1: Habilitado. 0: Deshabilitado.
110 Opcional 0 / 1 Pago total del saldo vía PSE. 1: Habilita que los pagos por PSE se realicen por el total del saldo. 0: No habilitado.
111 Opcional 0 / 1 Ocultar campo nombre en Tarjeta de Crédito. 1: Oculta el campo nombre de la TC. 0: No lo oculta.
112 Opcional Numérico Valor mixto a pagar por defecto. Define el valor por defecto a pagar en pagos mixtos (por ejemplo en 2 o 3 partes).
113 Opcional 0 / 1 Habilitar recurrencias. 1: Habilita pagos recurrentes en el comercio. 0: Deshabilitado.
114 Opcional Numérico (meses) Plazo de la recurrencia. Define el plazo de los pagos recurrentes en meses.
115 Opcional Numérico (meses) Frecuencia de la recurrencia. Define cada cuántos meses se realiza el cobro recurrente.
116 Opcional 0 / 1 Habilitar cobro en dólares (Tarjeta de Crédito). 1: Habilitado. 0: Deshabilitado.
117 Opcional CO / US Moneda para cobro en Tarjeta de Crédito. CO: Pesos Colombianos. US: Dólares Americanos.

Los parámetros adicionales de configuración permiten modificar el comportamiento del flujo de pago sin alterar la lógica principal de la integración.

Los parámetros válidos para el envío de configuración adicional cuando se va a manejar cobro por transacción para los medios de pago PSE y Tarjeta de Crédito son:

Parámetros de Configuración Adicional