Esta especificación describe el conjunto de APIs que componen el flujo de pagos de la plataforma de Redeban Open Finance.
El flujo de pagos tiene dos componentes
- Iniciación de pagos (domestic payment consents): creación, autorización y recuperación del Consentimiento.
- Envío de pagos (domestic payments): confirmación de fondos en el banco, creación del pago y recuperación de su estado.
La integración empieza cuando el TPP invoca las APIs de iniciación de pagos para crear el consentimiento y obtener la autorización del cliente y del banco. Una vez autorizado, el TPP usa las APIs de envío de pagos para iniciar la transacción con el Banco registrado, reutilizando el mismo payload de detalles de pago definido en el consentimiento.
Notas clave
- Los bancos registrados son los integrados en la plataforma de Open Finance de Redeban para realizar pagos mediante las APIs.
- Cualquier operación sobre las APIs de envío de pagos no modifica el estado del recurso de consentimiento.
¿Para quién es esta documentación?
| Audiencia | Qué hace en este flujo |
|---|---|
| TPP (Proveedor Externo) | Crea el consentimiento, obtiene la autorización del cliente y envía el pago. |
| Banco registrado | Ejecuta la SCA, autoriza el consentimiento y procesa el pago. Ver la API Back Channel. |
Pasos del flujo de consumo de las APIs
La siguiente tabla resume el recorrido de extremo a extremo. Cada paso se detalla más abajo y cuenta con ejemplos ejecutables en Ejemplos de consumo de las APIs.
| # | Paso | Quién | Resultado |
|---|---|---|---|
| 1 | Solicitud de iniciación de pago | Cliente → TPP | El cliente pide un pago desde la app del TPP. |
| 2 | Token de credenciales de cliente | TPP | Token de acceso vía CCG (scope=payments). |
| 3 | Crear el consentimiento | TPP | Se obtiene un Consent ID. |
| 4 | Autorizar el consentimiento | Cliente + Banco | SCA y autorización; consentimiento autorizado o rechazado. |
| 5 | Token para consumir APIs del banco | TPP | Token de acceso vía ACG. |
| 6 | Crear y enviar el pago | TPP | Se obtiene un Payment ID. |
1. Solicitud de iniciación de pago
El flujo comienza cuando el cliente le solicita al TPP realizar un pago usando su aplicación.
2. Configurar el token de credenciales del cliente
Para configurar la solicitud de pago, el TPP obtiene un token de acceso mediante el flujo de credenciales de cliente (CCG), en un contexto seguro del lado del servidor entre el TPP y la plataforma de Redeban. El claim scope debe ir como payments.
Cuando el token de acceso expire, el TPP solicita uno nuevo con el payload correspondiente.
3. Configurar la solicitud de consentimiento de la orden de pago
El TPP inicia el proceso de iniciación de pagos registrando su intención de pagar en nombre del cliente. Al crear exitosamente el recurso del consentimiento, recibe un Consent ID como evidencia de su intención, con el que puede recuperar el estado del consentimiento.
4. Autorizar el consentimiento
El TPP solicita al cliente realizar la SCA para autorizar el consentimiento con el Banco registrado. Para ello redirige al cliente a la plataforma de Redeban, que coordina la SCA y el flujo de autorización con el banco. La redirección incluye el Consent ID generado, lo que permite correlacionar la solicitud de pago con el consentimiento.
En el consentimiento se debe asociar la cuenta del cliente (DebtorAccount). Hay dos escenarios:
| Escenario | Tipo de consentimiento | Comportamiento |
|---|---|---|
| Sin cuenta proporcionada | consentimiento explícito | Tras la SCA, se muestra al cliente la pantalla del consentimiento con las cuentas disponibles para que seleccione la(s) cuenta(s) de pago. Tras la confirmación, Redeban marca el consentimiento como autorizado o rechazado y el TPP recibe un código de autorización para solicitar un token de corta duración con el que consumir las APIs de envío de pagos. |
| Con cuenta proporcionada | consentimiento implícito | La página de SCA del banco muestra la cuenta indicada junto con los detalles del consentimiento. Tras la confirmación, Redeban marca el consentimiento como autorizado o rechazado y el TPP recibe un código de autorización para solicitar un token de corta duración con el que consumir las APIs de envío de pagos. |
Ejemplo del código de autorización (code) enviado en la URL de redirección:
https://{URL_redirección}?code=HGdwkztThJ-qd318PZS0xxZ3mY8fQnQIAjMNLc&state=eyJhbGci&iss=https%3A%2F%2Fredebanopenfinance.co5. Obtener el token de acceso para consumir APIs del banco
Para acceder a las APIs de envío de pagos (domestic payments), el TPP obtiene el token de acceso mediante el flujo de código de autorización (ACG), en un contexto seguro del lado del servidor entre el TPP y la plataforma de Redeban.
6. Crear el envío de una orden de pago
Con el token requerido, el TPP consume las APIs de envío de pagos para iniciar el procesamiento con el Banco registrado.
Cada token se usa una sola vez para enviar un pago. Tras el envío exitoso del pago, el TPP recibe un Payment ID con el que recupera el estado del pago.
➡️ Siguiente: Ejemplos de consumo de las APIs — solicitudes cURL y respuestas para cada paso.