Introduction

OpenFinTech.io is an open database that comprises of standardized primary data for FinTech industry.
It contains such information as geolocation data (countries, cities, regions), organizations, currencies (national, digital, virtual, crypto), banks, digital exchangers, payment providers (PSP), payment methods, etc.
It is created for communication of cross-integrated micro-services on “one language”. This is achieved through standardization of entity identifiers that are used to exchange information among different services.

UML

UML Domain Model diagram you can find here.

Persistence

Entities are updated not more than 1 time per day.

Terms and Conditions

This OpenFinTech.io is made available under the Open Database License.
Any rights in individual contents of the database are licensed under the Database Contents License.

Contacts

For any questions, please email - info@openfintech.io
Or you can contact us at Gitter

Powered by Paymaxi

Get Started

If you use POSTMAN or similar program which can operate with swagger`s files - just download our spec and import it. Also you can try live API demo.

Overview

The OpenFinTech API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors.
API is based on JSON API standard. JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects.
JSON API requires use of the JSON API media type (application/vnd.api+json) for exchanging data.

Additional Request Headers

ACCEPT HEADER

Your requests should always include the header:

Accept: application/vnd.api+json

Authentication

To use OpenFinTech API no needed authorization.

Versioning

When we make changes to the API, we release new, dated versions. The current version is 2017-08-24. Read our API upgrades guide to see our API changelog and to learn more about backwards compatibility.

Pagination

OpenFinTech APIs to retrieve lists of banks, currencies and other resources - paginated to 100 items by default. The pagination information will be included in the list API response under the node name meta - contains information about listed objects [total - contains information about total count of listed objects, pages - count of pages], links - contain links to navigate between pages [first - link to first page, prev - link to previous page, next - link to next page, last - link to last page].
By default first page will be listed. For navigating through pages, use the page parameter (e.g. page[number], page[size]).
The page[size] parameter can be used to set the number of records that you want to receive in the response.
The page[number] parameter can be used to set needed page number.
Example of response:

{
  "meta": {
    "total": 419,
    "pages": 42
  },
  "links": {
    "first": "/v1/{path}?page[number]=1&page[size]=10",
    "prev": "/v1/{path}?page[number]=39&page[size]=10",
    "next": "/v1/{path}?page[number]=41&page[size]=10",
    "last": "/v1/{path}?page[number]=42&page[size]=10"
  }

Sorting

OpenFinTech`s API supported query parameter to sort result collection [e.g. ?sort=code]. Information about available parameters may be found in the endpoint description. Positive parameter [e.g. ?sort=code] points to ascending sorting, negative [e.g. ?sort=-code] - to descending sorting. Also, supported multiple sorting parameters [e.g. ?sort=code, -name, id, etc.]

https://api.openfintech.io/v1/countries?sort=name,-area

Filtering

Filtering provided by unique query key filter[*filtering_condition*]. Information about available parameters may be found in the endpoint description.

https://api.openfintech.io/v1/countries?filter[region]=europe

Images

OpenFinTech provides two types of images: icons and logos. To get one of those types you should to use next url pattern:

https://api.openfintech.io/v1/{path}/{id}/{icon/logo}

Also, images can be resized by adding next parameters: h={height}&w={width}. For example, you want to get organization icon with width equals to 20 pixels:

https://api.openfintech.io/v1/organizations/{id}/icon?w=20&h=20

If argument height or width is missing API returns original image with real sizes.

Errors

API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.), and codes in the 5xx range indicate an error with OpenFinTech’s servers (these are rare).

Use this page to mock OpenFinTech.io in your testing and development.

Run our mock API sample using the open source WireMock library, or in the free edition of WireMock Cloud. You'll have a working API server simulating the behavior of OpenFinTech.io, which will allow you to keep building and testing even if the actual API you isn't currently available.