Version 1.0 Pilot
  1. Home
  2. Filter Values API

Filter Values API

Bank of England

The Filter Values API is used to retrieve the Codes and Names of Resources e.g. Account Statuses that will be used in API responses and query parameters. This API will expose two query parameters:

  • resourceName:

    • Type of resource (eg: accountSubTypes)
    • This is a mandatory parameter and will suppot the "eq" operator only as per the BoE RTGS Filtering Standards.

  • parentValue:

    • Parent type associated to the resource type (eg: "SETT" which is an account type and can be used to limit the account sub types)
    • This is an optional and is not required in all scenarios. However, if it is required and is not provided or vice versa, a HTTP 400 (Bad Request) will be returned along with the appropriate error message. If the provided parameter values are valid, a HTTP 200 (Success) will be returned along with the response body containing the following fields:

filter diagram

 

The Resources exposed as part of the Filter Values API are:

filter resources

 

Additionally, see the table below to understand the type of parent value that should be provided to fetch a set of resources associated to it

filter values api

Supported Developer Toolkit:

Bank of England RTGS APIs will be supported by Swift Microgateway and Swift SDK.Both solutions, provided by Swift, offer access to the APIs. Bank of England hosts a reference implementation based on Swift Microgateway and we can help you start with the API connectivity using this option.

If you are already a user of any of these solutions, just download the API Specification and follow the Swift recommended steps to import it into your implementation.