The Developer Studio /Getting Started

Getting Started

Step 1: Complete our sign up flow

To get started with the Bank of London API, you first need to complete our sign up flow. This will unlock the "Team", and "Apps and Keys" sections so you can start creating Apps and sending your first requests.

Steps to complete our sign up flow:

  1. Click ‘Sign up’ and complete our Request Access form
  2. Click the link in the email you received to verify your email address
  3. Wait for another email from us to confirm your request for access
  4. Complete registration by setting up a password and multi-factor authentication
Note

To join an existing Developer Studio team, you can ask an admin to invite you to their team. For more details read our Manage your Users and Team section, see here.

Step 2: Create your first App and Key

Create the App

In The Bank of London Developer Studio, an App links your code to services provided by The Bank of London. An App houses several API Key and secret pairs which are used to sign all requests that you make to The Bank of London's services

Steps to create an app

  1. From the Apps and keys page, click the New App button.
  2. You will have the option to name your App then click Create.
  3. You will see your new App in the Apps and keys page.
Note

To learn more about Apps and keys see here.

Generate an API key

When an App has been created then you will be able to create an API Key and Secret value. These values are used for signing a request to authenticate with The Bank of London API.

Steps to generate a new API key

  1. From the Apps and keys page, select an App and click the New Key button.
  2. Name your API Key for future reference.
  3. Your API Key and secret will be displayed.
  4. Store the API Key and secret value securely using a secret manager service by using the copy icon to easily copy each value to your clipboard.
Note

When an API Key has been created you cannot retrieve the secret again. The Bank of London has no way to retrieve or generate this key again. You will have to generate a new key if you lose the secret.

Step 3: Send your first request

We recommend you play around with Try It Now in the documentation first to familiarise yourself with the API.

Once you are comfortable with the API, you can begin integrating your code with it. Your code's first request(s) should be sent to the Sandbox. In order to send a request to the Sandbox, you will have to sign it using your private key from Step 2.

You may refer to the below hostnames depending on the environment you wish to use:

EnvironmentHostname
Liveapi.thebankoflondon.com
Sandboxsandbox-api.thebankoflondon.com

Try the Sandbox

Within The Developer Studio you can manage your API keys for both the live and sandbox environments side-by-side. An App may contain both live and sandbox API keys. Each API Key may be used with only one of the two environments. Note that this setting is permanent once the key is created, so you will need to create new keys when you wish to go live. Each App may contain several keys, so if you have more than 2 environments on your end, you may store them all within the same App.

All Banking and Management API endpoints are available on and used identically in both environments.

All Banking and Management API endpoints are available on and used identically in both environments. However, Test Data Management and Development API endpoints will only be available in the sandbox environment, and prototype endpoints may only be available on the sandbox environment until fully released.

Note

We have created and funded some accounts for you to get started with. You may use these accounts however you like for tests and demos. If you need help with these accounts, or need new accounts created or funded, just let us know.

Steps to retrieve accounts from our Sandbox environment

  1. Copy the code snippet for retrieving accounts that is supplied within this documentation. The example code snippet can be found here.
  2. Edit the code to target the request at the Sandbox environment. You can get the URL above.
  3. Edit the code to add your key and private key values into the respective variables.
  4. Sign your request using your API Key from step 2 and the message signing procedure outlined here.
  5. Send your request to The Bank of London API by running your code.
  6. This request will return a list of two accounts, which you will need an account ID from to make a payment in the next request.
Note

The code examples are available in four different languages: Node.js, Java, Rust and Python. To access these languages click the dropdown in the top right corner of the code snippet and select your language of choice.

Note

For more detailed information about this API request look at our documentation.

Steps to make a payment in our Sandbox environment

  1. Copy the code snippet for making a payment that is supplied within this documentation. The example code snippet can be found here.
  2. Edit the code to target the request at the Sandbox environment. You can get the URL above.
  3. Edit the code to add your key and private key values into the respective variables.
  4. Edit the code to replace the placeholder sender.accountId with your accountId value that you retrieved in the previous request.
  5. Edit the code to add in a sort code and account number for the recipient. You can use the sort code and account number from the second account returned in the previous request.
  6. Sign your request using your API Key from step 2 and the message signing procedure outlined here.
  7. Send your request to The Bank of London API by running your code.
Note

For more detailed information about this API request look at our documentation.

Example requests

Retrieving accounts

Making a payment

Step 4: Construct your code

Now that you have successfully sent your first request to our Sandbox environment you can begin to develop your full solution.

The Bank of London recommends an architecture based on the following to help ensure the security of your keys and your account, based on the following:

  • Store your keys securely in an industry-recognised Secrets management vault
  • Have strong user authentication and authorisation in place.
  • Do not allow end users to interact with The Bank of London API directly.
  • Protect your own apps and networks against attack.
Note

For more information on Architecture and Security see here.

Step 5: Go Live

Congratulations, your application should now be communicating with The Bank of London API. The final step is to enable Live access for your Team and start using Live API keys - these keys can be used to manage your real accounts. We aim to make this process as simple as possible, and will help guide you through everything.

The following steps are everything you need to go Live:

  1. Onboard your business to The Bank of London if you haven't already.
  2. Inform your Bank of London account manager that you want to use The Bank of London API.
  3. Sign the agreement to use The Bank of London API and complete user onboarding.
  4. Get introduced and be guided safely from sandbox to Live API access.