Guía de inicio

Este portal ofrece documentación detallada sobre la implementación de las APIs de Open Banking desarrolladas por Redeban, orientadas a la iniciación y envío de pagos a través de proveedores externos de servicios de pago (TPP, por sus siglas en inglés).

Redeban ha adoptado el estándar del Reino Unido, denominado Open Banking Implementation Entity (OBIE) para el desarrollo de sus APIs. La plataforma de Redeban ha sido diseñada para proporcionar una infraestructura integral, robusta y de fácil implementación, permitiendo a los TPPs realizar una iniciación y envío de pagos a través de múltiples bancos integrados en la misma.

Es posible probar las APIs utilizando herramientas estándar ampliamente reconocidas para el acceso a las APIs. Para obtener instrucciones detalladas sobre cómo realizar las pruebas, consulta la sección 'Pasos a seguir para probar las APIs' en esta misma página. Debe tener presente que para acceder a las cuentas de prueba y recibir información relevante, soporte y notificaciones, es necesario completar el proceso de registro.

Las APIs de Redeban pueden consultarse aquí.

¿Cómo probar las APIs de Redeban en el entorno de pruebas?

Prerrequisitos para realizar las pruebas

1. Es necesario contar con un SSA (Software Statement Assertion) de Redeban, el cual se obtiene al registrarse en el directorio de participantes de Open Banking en el entorno de pruebas.
2. Redeban proporcionará los certificados de red y de firma X.509 correspondientes al registro. Para ello, se deberán enviar dos CSR (Certificate Signing Request), uno para cada certificado previamente mencionado como parte del proceso de registro. Estos serán firmados por Redeban utilizando sus propios certificados raíz e intermedios privados.

• El certificado de red es utilizado por el TPP para conectarse a la API mediante una conexión segura TLS (MTLS) con todas las APIs.
• El certificado de firma es utilizado por el TPP para enviar una firma JWS (JSON Web Signature) separada con cada solicitud de API.

Pasos a seguir para probar las APIs

1. Descargar el perfil del cliente y la cuenta de prueba para probar las APIs desde el portal de desarrolladores.
2. Registrar la aplicación utilizando la API Dynamic Client Registration API conforme a las especificaciones establecidas por OBIE en el Reino Unido.
3. Consumir las APIs de iniciación de pagos del ambiente de pruebas para configurar una solicitud de consentimiento de pago con el banco.
4. Utilizar la URL de autorización del ambiente de pruebas, mencionada en la sección ‘ URL de endpoints de autorización de OpenID Connect (OIDC) ’ que encuentra más abajo en esta misma página, para autorizar la solicitud de consentimiento de pago. Consulte la hoja de cuentas de prueba para seleccionar el perfil del cliente correspondiente para la prueba.
5. Después de completar los pasos anteriores, podrá realizar pruebas con las APIs de envío de pagos. Antes de comenzar, consulte la sección ‘Puntos a tener en cuenta al probar las APIs’.
6. Consute los datos de prueba desde este enlace.

Puntos a tener en cuenta al probar las APIs

1. El conjunto de APIs de iniciación y envío de pagos se pueden probar utilizando herramientas como Postman, SOAP, etc.
2. Los participantes deberán presentar una cadena de certificados completa para consumir las APIs como el certificado intermedio junto con el certificado final.
3. Para consumir las APIs de iniciación de pagos, es necesario descargar las cuentas de prueba registrándose e ingresando al portal del desarrollador Redeban.
4. Los clientes y sus aplicaciones deben ser creados a través de la API de "Dynamic Client Registration ".
5. Las pantallas del cliente (inicio de sesión, selección de cuenta, etc.) que se muestran durante el proceso de autorización en el ambiente de pruebas, no son representativas de las pantallas reales que se presentan a los clientes en producción. El diseño, el texto y la información complementaria son solo indicativos.
6. Protocolos soportados por las APIs en el entorno de pruebas:

• El método de autenticación del endpoint OAuth2/OIDC, que es compatible con el método de seguridad FAPI 2, utiliza los métodos MTLS y private_key_jwt.
• La firma del payload de la API sigue el formato JWS.

¿Cómo acceder a las APIs de Redeban en producción?

Pasos a seguir para acceder las APIs en producción

1. Inscribirse como TPP en el directorio de participantes de Open Banking de Redeban.
2. Recibir el SSA de Redeban, firmado de manera cifrada, que corresponde al registro como TPP.
3. Redeban proporcionará los certificados de red y de firma X.509 correspondientes al registro. Para ello, se deberán enviar dos CSR (Certificate Signing Request), uno para cada certificado previamente mencionado como parte del proceso de registro. Estos serán firmados por Redeban utilizando sus propios certificados raíz e intermedios privados
4. Integrar la aplicación en la plataforma mediante laDynamic Client Registration API.
5. El TPP deberá presentar una cadena de certificados completa para consumir las APIs, como el certificado intermedio junto con el certificado final.
6. Consultar los endpoints de “.well-known” en la sección denominada ‘Direcciones URL .well-known de OpenID Connect (OIDC)’ de esta página para obtener detalles sobre las URLs y los claims soportados por las APIs de Open Banking de Redeban.
7. Protocolos soportados por las APIs en el ambiente de producción:

• El método de autenticación del endpoint OAuth2/OIDC, que es compatible con el método de seguridad FAPI 2, utiliza los métodos MTLS y private_key_jwt.
• La firma del payload de la API sigue el formato JWS.

Entidades Bancarias soportadas

La plataforma de APIs de Redeban es compatible y está conectada con la mayoría de los bancos en Colombia para realizar pagos. Cada endpoint de las APIs que utiliza el TPP debe incluir el Bank ID como parámetro en la ruta de la URL al iniciar solicitudes de token de acceso, autorización bancaria y pagos en la plataforma de Redeban. La lista de bancos admitidos y sus correspondientes 'Bank ID' se encuentra aquí.

Direcciones URL .well-known de OpenID Connect (OIDC)

El endpoint Conocido OIDC proporciona información de metadatos del servidor de Autorización de la Plataforma API de Redeban. Esto ayuda a los participantes a obtener información importante sobre los parámetros OIDC soportados por la plataforma API de Redeban para integrarse con el servidor de autorización.

El ejemplo incluye la URL del endpoint del token, la URL del end point PAR, los algoritmos criptográficos admitidos, el nombre del emisor, la URL de autorización, etc.

Tenga en cuenta que las URL de endpoint conocidas son específicas del banco y del entorno (Sandbox, producción).

Para obtener más información general sobre estándares conocidos, consulte [RFC 8414] :

Sandbox

Production

TBD

URL de endpoints de autorización de OpenID Connect (OIDC)

Esta sección proporciona detalles de la URL del servidor de autorización específica para cada entorno y banco admitidos.

Sandbox

Production

TBD