Skip to main content

Getting Started

Quick guide about how to start to use Provider API.


In current version of API we're using API Key based authorization flow. Every request should include next headers:

client_id: YOUR_CLIENT_ID
client_secret: YOUR_CLIENT_SECRET


fetch('', {
method: 'POST',
headers: {
client_id: YOUR_CLIENT_ID
client_secret: YOUR_CLIENT_SECRET
body: {
// ...

To get your CLIENT_ID and CLIENT_SECRET you need to contact

Rates and Limits

coming soon

For more informations, please check this article.


Provider API mostly following Open Banking specification, because of historical reasons. Instance names and routes usually the same as we have in OB spec, but not for 100%. As a product we're supporting not only UK banks, and that's why this specification can't fully cover all needs of all banks, so we're have some differences.


Different banks using different flows and API methods for the same actions. Because of that, to unify all operations, Provider API use standartized flows below. Sometimes it might look overcomplicated, but it's the price that we should pay to have single API for all banks.

Here's the list of general flow overviews, but if you looking for more detailed docs, please follow to specific topic.


Single immediate payment