🇪🇸 Español
Checkout
Todas las pantallas dirigidas al usuario—incluyendo selección del método de pago, instrucciones de pago, confirmación y mensajes de éxito—están completamente alojadas y gestionadas por Cobre. El integrador solo es responsable de redirigir al usuario a la URL de Checkout y manejar la lógica posterior al pago a través de Webhooks.
Métodos de pago compatibles
| Método de Pago | Rail | Tipo de Interacción |
|---|---|---|
| PSE | pse | Checkout Alojado (Enlace de Pago) |
| Bancolombia | bancolombia | Checkout Alojado (Enlace de Pago) |
| Nequi | nequi | Checkout Alojado (Notificación Push) |
| BreB QR | breb_qr | Checkout Alojado (Código QR) |
| BreB Key | breb_key | Checkout Alojado (Clave) |
Para pagos PSE, el email definido en la contraparte se utiliza para autenticar al usuario en el flujo PSE. Para pagos Nequi, el número de teléfono definido en la contraparte se utiliza para enviar la notificación push.
Personalización de Checkout
| Experiencia Personalizable | Descripción | Campo |
|---|---|---|
| Elegir el nombre del Checkout | Especifica un título claro y descriptivo (ej. "Mi empresa") para que los clientes sepan instantáneamente por qué están pagando. | checkout_header |
| Descripción de producto abierta o fija | Decide si quieres establecer una descripción de artículo de producto predefinida o permitir que el pagador agregue su propia referencia personalizada. (ej., "Membresía Mensual" o "Donación a XYZ") | checkout_item |
| Monto Abierto o Fijo | Decide si el monto está bloqueado o abierto para que el pagador lo especifique. Por ejemplo, establece un precio fijo para un producto o permite un pago de lo que quieras. | amount |
| Enlaces Reutilizables | Determina si tu enlace de checkout debe ser de un solo uso o reutilizable (intenciones fijas o ilimitadas). | money_movement_intent_limit |
| Establecer una fecha de vencimiento | Controla la disponibilidad de tu enlace de checkout estableciendo una fecha de vencimiento. Una vez que se alcanza esta fecha, el enlace se vuelve inválido. | valid_until |
| Elegir Rails de Pago | Selecciona qué métodos de pago (ej., Nequi, PSE, Bancolombia, BreB) incluir en tu checkout. | checkout_rail |
Para enlaces abiertos sin vencimiento y/o enlaces abiertos sin límite de intenciones y/o valor de monto abierto y/o valor de artículo abierto, por favor usa -1
| Elemento Personalizable | Descripción | Campo |
|---|---|---|
| ID Externo | Una referencia externa o ID de seguimiento que se pasa al movimiento de dinero. | external_id |
| Descripción al Beneficiario | La descripción del pago que aparece en la transacción registrada en tu saldo de Cobre. | description_to_payee |
| URL de Redirección | La URL a la cual el cliente es redirigido una vez que el enlace de pago es pagado. | redirect_url |
Combinaciones de Checkout permitidas
| Geografía | Tipo de Origen | Tipo de Destino | Rails |
|---|---|---|---|
| COL | r2p | cobre_balance | PSE, Bancolombia, Nequi, BreB |
| COL | r2p_breb | cobre_balance | BreB |
Ciclo de vida del Checkout
1.
Crear una contraparte con la información del pagador es opcional al usar Checkout.
Si la contraparte no se crea previamente, Checkout recopilará toda la información requerida del pagador durante el flujo alojado y creará automáticamente la contraparte
r2p correspondiente.2.
Crea un Checkout especificando los siguientes parámetros:
counterparty_id del paso anterior como source_id (opcional)account_id donde quieres recibir los fondos como destination_idcheckout_railscheckout_header y checkout_itemamount expresado en la unidad más pequeña de la moneda (ej., 100.00 MXN debe enviarse como 10000)valid_untilredirect_url donde el pagador será redirigido después de que Cobre muestre la pantalla de confirmaciónmoney_movement_intent_limit, que define cuántos Movimientos de Dinero pueden crearse usando el mismo Enlace de Checkout3.
Una vez que se crea el Checkout, Cobre devuelve una
checkout_url que representa la experiencia de pago alojada.4.
Redirige al pagador a la
checkout_url para completar el pago.5.
El pagador selecciona un método de pago y completa la transacción dentro del Checkout alojado por Cobre. Una vez que se inicia el pago, Checkout crea un Movimiento de Dinero que permite rastrear el estado del pago y sus cambios de estado posteriores.
6.
Los cambios de estado del Movimiento de Dinero se comunican a través de Webhooks.
7.
Una vez que el pago es exitoso, los fondos son acreditados al Cobre Balance asociado.
El Movimiento de Dinero generado por Checkout incluirá el checkout_iden el campobatch_id. Esto te permite correlacionar y conciliar el pago con el Checkout que inició la transacción.
Acciones realizadas en un Checkout
🔑 Crear
🔍 Obtención
❌ Desactivar
Descripción: Creación de Checkout.
Qué esperar después de la acción: El Checkout se crea en Cobre.
📘 Aprende más:
Qué esperar después de la acción: El Checkout se crea en Cobre.
📘 Aprende más:
Idempotencia del Checkout
Cómo Empezar
Antes de usar esta API
Necesitas un Cobre Balance en Colombia
Para poder recibir dinero, debes tener una cuenta de Cobre Balance en Colombia.
Crear la Contraparte (Opcional)
Antes de crear un Movimiento de Dinero, debes crear la Contraparte con la información del pagador.
Definir la configuración del Checkout
Decide qué métodos de pago estarán disponibles, junto con el monto, fecha válida hasta, y referencia a mostrar al pagador.
Implementar Webhooks para rastrear el estado del pago
Para mantenerte informado sobre el estado de las transacciones Payin, recomendamos encarecidamente implementar Webhooks. Los Webhooks notifican a tu sistema cuando un pago se inicia, procesa, completa o falla. También suscríbete a los eventos requeridos para recibir notificaciones sobre créditos de transacciones.Ve Notificaciones y Suscripciones para más detalles.
Qué esperar después de usar esta API
Redirigir al usuario al Checkout
Redirige al pagador a la
checkout_url devuelta cuando se crea el Checkout.El usuario final completa el pago
El pagador completa el pago usando la interfaz de Checkout alojada.
Recibir fondos en tu Cobre Balance
Una vez que el pago es exitoso, los fondos son acreditados a tu Cobre Balance y se actualiza un Movimiento de Dinero.
Modified at 2026-02-03 14:08:54