APIs

FPAD EPC VOP Responder API

OpenAPI Especificación

verification-of-payee-responder-api:fpad-epcvop-responder-api-1. 0.adoc

Exponiendo el OpenAPI Especificación del Endpoint

Lo siguiente solo debe configurarse en entornos de desarrollo/prueba.

Por defecto, el OpenAPI El endpoint de especificación de la interfaz de usuario no está habilitado en la aplicación. Esto puede habilitarse configurando las siguientes propiedades en la configuración de la aplicación:

springdoc.api-docs.enabled = true

spring.web.resources.static-locations = "classpath:/static/"

Con las propiedades anteriores establecidas, el OpenAPI la especificación será accesible al presionar el /swagger-ui/index.html ruta de la aplicación en ejecución.

Usando la API

Este API permite que FPAD EPC VOP, actuando como RVM, envíe un número de identificación de cuenta (IBAN) y un nombre del beneficiario al PSP Respondedor que gestiona la cuenta, con el fin de obtener un resultado coincidente del nombre del beneficiario con aquellos asociados a la cuenta proporcionada.

Qué enviará FPAD EPC VOP

  • Información del Solicitante

    • Identificador bancario (BIC)

    • ID de solicitud

    • Solicite la marca de tiempo PSP

  • Información del Beneficiario:

    • Identificador bancario (BIC)

    • Nombre (para individuos) O ID de Organización (para empresas)

    • Número de cuenta (IBAN)

    • Información de Remesas No Estructurada

Lo que FPAD EPC VOP espera recibir

  • Marca de tiempo de respuesta PSP

  • ID de solicitud

  • Resultado de la verificación:

    • Éxito: Los detalles del beneficiario coinciden

    • Fallo: Los detalles no coinciden

    • Coincidencia Cercana: El nombre es similar pero no una coincidencia exacta, con el nombre correcto proporcionado.

    • No aplicable: No fue posible realizar la verificación.

Manejo de Errores

The API proporciona respuestas de error para los siguientes problemas:

Estado HTTP Error Descripción

400

Error de validación de la solicitud

Cuando los detalles proporcionados son incompletos o no cumplen con el formato requerido.

500

Error del servidor

Cuando ocurre un error no anticipado o cuando no se puede acceder a un servicio externo necesario para la verificación, por ejemplo, la Gestión de Cuentas. Se pueden encontrar detalles adicionales en los registros.

Gestión de Cuentas API

OpenAPI Especificación

Gestión de Cuentas API

Implementando la API

La API debe ser implementado para que Responder realice su verificación. Por favor, consulte la Gestión de Cuentas página de características para obtener más contexto sobre cómo la información proporcionada por esto API se utilizará.

Una vez implementado, consulte Introducción sobre cómo configurar los detalles de conexión en el archivo de configuración del Responder.

Lo que enviará el Respondedor

Número de cuenta del beneficiario (IBAN)

Lo que el Responder espera recibir de vuelta

Todos los campos que no están marcados como [REQUIRED] son opcionales.

  • Información del Beneficiario:

    • [REQUIRED] Nombre(s)- Puede haber múltiples nombres para cuentas conjuntas.

    • [REQUIRED] Nombre Tipo

    • Entidad de Procesamiento

    • Identificador bancario (BIC)

    • Tipo de Cuenta

    • Dirección Postal

    • Detalles de contacto

    • ID de Organización (LEI)