APIs de Redeban
En esta sección encontrará el catálogo de APIs disponibles para la integración con Redeban Open Finance, organizadas según el tipo de participante que las consume: Entidad Bancaria o Tercero Receptor de Pagos (TPP).
Cada API incluye una breve descripción funcional, la API asociada, el método HTTP requerido, el endpoint que debe consumirse y un ejemplo de uso en ambiente preproductivo.
Los endpoints se presentan usando las variables {APIBaseUrl} y {AuthBaseUrl}. La variable {APIBaseUrl} corresponde al endpoint base utilizado para consumir los recursos expuestos por la plataforma, como enrolamiento, generación de tokens, consentimientos, Back Channel, PAR y pagos. La variable {AuthBaseUrl} se utiliza únicamente para endpoints de redirección, como el envío del usuario hacia el autenticador del banco o la redirección hacia el TPP después de finalizar la autenticación.
También encontrará la información de los ambientes disponibles, junto con sus endpoints base de API y redirección. Finalmente, se incluye el listado de bancos registrados y su disponibilidad según el ambiente correspondiente.
Catálogo de APIs a consumir por parte de la Entidad
Esta tabla contiene las APIs que debe consumir una Entidad Bancaria para registrarse en la plataforma, obtener tokens de autenticación, gestionar consentimientos mediante Back Channel y redireccionar al TPP una vez finalizado el proceso de autenticación del usuario.
| Nombre API | Descripción del recurso | API asociada | Método del recurso | Endpoint | Ejemplo en ambiente preproductivo |
|---|---|---|---|---|---|
| Enrolamiento de la Entidad | Permite registrar dinámicamente a la entidad bancaria para el consumo de las APIs. | Dynamic Client Registration API | POST | {APIBaseUrl}/register/v1 | https://api.stage.redebanopenfinance.com/register/v1 |
| Obtener el token CCG para consumo APIs Back Channel | Permite obtener el token CCG requerido para consumir las APIs Back Channel. | Authorization Server Security API | POST | {APIBaseUrl}/{Bank}/token.oauth2/v1 | https://api.stage.redebanopenfinance.com/{Bank}/token.oauth2/v1 |
| Obtener el consentimiento usando el Back Channel | Permite consultar la información de un consentimiento mediante el canal Back Channel. | Back Channel API | GET | {APIBaseUrl}/{Bank}/back-channel-auth/v1/{ConsentId} | https://api.stage.redebanopenfinance.com/{Bank}/back-channel-auth/v1/{ConsentId} |
| Actualizar el consentimiento con información bancaria | Permite actualizar el consentimiento con la información bancaria correspondiente. | Back Channel API | PUT | {APIBaseUrl}/{Bank}/back-channel-auth/v1/{ConsentId} | https://api.stage.redebanopenfinance.com/{Bank}/back-channel-auth/v1/{ConsentId} |
| Redirección hacia el TPP una vez finalizada la autenticación | Permite redireccionar al TPP después de finalizar la autenticación SCA. | Authorization Server Security API | GET | {AuthBaseUrl}/{Bank}/authorization.sca.oauth2 | https://auth.stage.redebanopenfinance.com/{Bank}/authorization.sca.oauth2 |
Para los endpoints de la Entidad Bancaria, use {APIBaseUrl} como base general para las operaciones de enrolamiento, generación de tokens y consumo de recursos Back Channel.
Use {AuthBaseUrl} únicamente para endpoints de redirección, como la redirección hacia el TPP una vez finalizada la autenticación SCA.
Catálogo de APIs a consumir por parte del Tercero
Esta tabla contiene las APIs que debe consumir un Tercero Receptor de Pagos (TPP) para registrarse en la plataforma, crear y consultar consentimientos, iniciar el flujo de autorización, obtener tokens y enviar o consultar pagos domésticos.
| Nombre API | Descripción del recurso | API asociada | Método del recurso | Endpoint | Ejemplo en Stage |
|---|---|---|---|---|---|
| Enrolamiento del TPP | Permite registrar dinámicamente al TPP para el consumo de las APIs. | Dynamic Client Registration API | POST | {APIBaseUrl}/register/v1 | https://api.stage.redebanopenfinance.com/register/v1 |
| Obtener el token CCG para creación del consentimiento | Permite obtener el token CCG requerido para crear el consentimiento. | Authorization Server Security API | POST | {APIBaseUrl}/{Bank}/token.oauth2/v1 | https://api.stage.redebanopenfinance.com/{Bank}/token.oauth2/v1 |
| Crear consentimiento | Permite crear un consentimiento de pago doméstico. | Domestic Payment Consent API | POST | {APIBaseUrl}/{Bank}/domestic-payment-consents/v1 | https://api.stage.redebanopenfinance.com/{Bank}/domestic-payment-consents/v1 |
| Obtener consentimiento | Permite consultar la información de un consentimiento de pago doméstico. | Domestic Payment Consent API | GET | {APIBaseUrl}/{Bank}/domestic-payment-consents/v1/{ConsentId} | https://api.stage.redebanopenfinance.com/{Bank}/domestic-payment-consents/v1/{ConsentId} |
| PAR Request | Permite enviar una solicitud PAR para iniciar el flujo de autorización. | Authorization Server Security API | POST | {APIBaseUrl}/{Bank}/par.oauth2/v1 | https://api.stage.redebanopenfinance.com/{Bank}/par.oauth2/v1 |
| Redirección hacia el autenticador del banco | Permite redireccionar al usuario hacia el autenticador del banco. | Authorization Server Security API | GET | {AuthBaseUrl}/{Bank}/authorization.oauth2 | https://auth.stage.redebanopenfinance.com/{Bank}/authorization.oauth2 |
| Obtener el token ACG para el envío del pago | Permite obtener el token ACG requerido para enviar el pago. | Authorization Server Security API | POST | {APIBaseUrl}/{Bank}/token.oauth2/v1 | https://api.stage.redebanopenfinance.com/{Bank}/token.oauth2/v1 |
| Envío del pago | Permite enviar o iniciar el pago doméstico asociado al consentimiento. | Domestic Payments API | POST | {APIBaseUrl}/{Bank}/domestic-payments/v1 | https://api.stage.redebanopenfinance.com/{Bank}/domestic-payments/v1 |
| Obtener información del pago | Permite consultar la información de un pago doméstico previamente enviado. | Domestic Payments API | GET | {APIBaseUrl}/{Bank}/domestic-payments/v1/{DomesticPaymentId} | https://api.stage.redebanopenfinance.com/{Bank}/domestic-payments/v1/{DomesticPaymentId} |
Para los endpoints del TPP, use {APIBaseUrl} como base general para las operaciones de registro, generación de tokens, creación y consulta de consentimientos, solicitud PAR, envío de pagos y consulta de pagos.
Use {AuthBaseUrl} únicamente para el endpoint de redirección hacia el autenticador del banco, correspondiente al flujo en el que el usuario es enviado a autenticarse con su entidad bancaria.
Ambientes
En la siguiente tabla encontrará los endpoints base disponibles por ambiente. Estos valores deben usarse para reemplazar la variable {BaseUrl} definida en los catálogos de APIs anteriores.
Use el endpoint de tipo API para consumir recursos funcionales, como consentimientos, pagos o Back Channel. Use el endpoint de tipo Auth para operaciones relacionadas con redirecciones OAuth.
| Ambiente | Endpoint API | Endpoint Auth |
|---|---|---|
| Producción | https://api.redebanopenfinance.com | https://auth.redebanopenfinance.com |
| Producción Sandbox | https://api.snd.redebanopenfinance.com | https://auth.snd.redebanopenfinance.com |
| Preproducción | https://api.stage.redebanopenfinance.com | https://auth.stage.redebanopenfinance.com |
| Preproducción Sandbox | https://api.sen.redebanopenfinance.com | https://auth.sen.redebanopenfinance.com |
Bancos Registrados
En esta sección se listan los bancos disponibles para integración en los ambientes definidos anteriormente. El identificador del banco debe utilizarse en los endpoints que incluyen variables como {Bank} o {BankId}, según corresponda.
| Nombre del banco | ID del banco | Estado actual en ambiente de producción |
|---|---|---|
| Banco ABC | B001 | TBC |
| Banco XYZ | X001 | TBC |
| Banco EFG | E001 | TBC |