APIs
FPAD Responder API
Using the API
This API allows FPAD, 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 the a matching result of the payee name with those associated with the provided account
What FPAD will send
-
Requester Information
-
Bank identifier (BIC)
-
PSU reference ID
-
PSP reference ID
-
PSP timestamp
-
-
Payee Information:
-
Bank identifier (BIC)
-
Name (for individuals) OR Organization ID (for businesses)
-
Account number (IBAN)
-
What FPAD expects back
-
Response PSP timestamp
-
Requester Information
-
Bank identifier (BIC)
-
PSP reference ID
-
-
Payee Information:
-
Account number (IBAN)
-
-
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
-
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.