APIs
Verificación del Solicitante de Pago API
Exponiendo la 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.
Utilizando la API
La API acepta un JSON solicitud que contiene la información del beneficiario y devuelve un resultado de verificación.
Lo Que Necesita Proporcionar
-
Información del Beneficiario:
-
Nombre (para individuos) O ID de Organización (para empresas)
-
Número de cuenta (IBAN)
-
Identificador bancario (BIC) (opcional)
-
CSM Reachability puede recuperar el BIC del IBAN si no se proporciona
-
-
-
Entidad de Procesamiento (opcional) de la institución financiera del Beneficiario
-
Identificadores de Pago (opcional):
-
Cualquier identificador que utilice para rastrear el pago en sus sistemas
-
Lo que recibirá
-
Resultado de la Verificación:
-
Éxito: Los detalles del beneficiario coinciden, no se proporcionará código de razón.
-
Fallo: Los detalles no coinciden, con un código de razón que explica por qué.
-
Cierre de Coincidencia: El nombre es similar pero no una coincidencia exacta, con el nombre correcto proporcionado.
-
Failure Reason Code s
-
PI01- La identificación de la organización no coincide con la cuenta.
-
PN01- El nombre no coincide con la cuenta.
-
PN02- El nombre es similar pero no coincide exactamente.
-
NORR- No se pudo realizar una coincidencia.
Manejo de Errores
La API proporciona respuestas de error para los siguientes problemas:
| Estado HTTP | Error | Descripción |
|---|---|---|
400 |
Error de validación de solicitud |
Cuando los detalles proporcionados son incompletos o no cumplen con el formato requerido. |
500 |
Error de servidor desconocido |
Cuando ocurre un error no anticipado. Se pueden encontrar detalles adicionales en los registros. |
503 |
No se pueden alcanzar los servicios externos. |
Cuando no se puede acceder a un servicio externo necesario para la verificación, por ejemplo, Responder,CSM Reachability |