APIs
FPAD EPC VOP Responder API
Exposing the OpenAPI Specification Endpoint
| The below should only ever be configured in development/test environments |
By default, the OpenAPI specification UI endpoint is not enabled in the application. This can be enabled by setting the following properties in the application configuration:
springdoc.api-docs.enabled = true
spring.web.resources.static-locations = "classpath:/static/"
With the above properties set, the OpenAPI specification will be accessible by hitting the /swagger-ui/index.html path of the running application.
Using the API
This API allows FPAD EPC VOP, acting as RVM, to send an account identification number (IBAN) and a payee name to the Responding PSP managing the account, in order to get a matching result of the payee name with those associated with the provided account
What FPAD EPC VOP will send
-
Requester Information
-
Bank identifier (BIC)
-
Request ID
-
Request PSP Timestamp
-
-
Payee Information:
-
Bank identifier (BIC)
-
Name (for individuals) OR Organization ID (for businesses)
-
Account number (IBAN)
-
Unstructured Remittance Information
-
What FPAD EPC VOP expects back
-
Response PSP timestamp
-
Request ID
-
Verification Result:
-
Success: The payee details match
-
Failure: The details don’t match
-
Close Match: The name is similar but not an exact match, with the correct name provided
-
Not Applicable: Verification check was not possible
-
Error Handling
The API provides error responses for the following issues:
| HTTP Status | Error | Description |
|---|---|---|
400 |
Request validation error |
When the provided details are incomplete or do not meet the required format |
500 |
Server error |
When an unanticipated error occurs or when an external service necessary for verification cannot be reached e.g. Account Management. Additional details can be found in the logs |
Account Management API
Implementing the API
The API must be implemented in order for Responder to perform its verification. Please refer to the Account Management feature page for more context on how the information provided by this API will be used.
Once implemented, refer to Getting Started on how to configure the connection details in the Responder configuration file.