OpenFinTech.io
Introduction [OpenFinTech.io](https://openfintech.io) is an open database that comprises of standardized primary data for FinTech industry. It contains such…
Finance & banking#openapi#financial
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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+jsonAuthentication
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,-areaFiltering
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]=europeImages
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=20If 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…
Endpoints 18
Countries
- GETList of countries
/countries?page[number]=0&page[size]=0&filter[region]=africa&filter[sub_region]=northern_africa&sort=nameReturns all available countries. - GETCountry by ID
/countries/:idReturns country with specific ID.
Currencies
- GETList of currencies
/currencies?page[number]=0&page[size]=0&filter[search]=string&filter[code_iso_alpha3]=string&filter[code_iso_numeric3]=0&filter[code_estandards_alpha]=string&filter[currency_type]=national&filter[category]=electronic&sort=nameReturns all available currencies. - GETCurrency by ID
/currencies/:idReturns currency with specific ID.
Organizations
- GETList of organizations
/organizations?page[number]=0&page[size]=0&filter[search]=string&filter[name]=string&filter[code]=string&filter[status]=active&filter[industries]=string&sort=nameThis endpoint retrievs the list of organizations present in the system. The data displays general, public information, without reference to the type of… - GETOrganization by ID
/organizations/:idReturns organization with specific ID.
Exchangers
- GETList of exchangers
/exchangers?page[number]=0&page[size]=0&filter[name]=string&filter[status]=active&sort=nameReturns list of exchange markets. Each object contains general information about exchanger such as name and status, also information about rates export and… - GETExchanger by ID
/exchangers/:idReturns exchanger with specific ID.
Banks
- GETList of banks
/banks?page[number]=0&page[size]=0&filter[sort_code]=string&filter[code]=string&filter[status]=active&sort=nameReturns list of banks. Each object contains general information about bank such as name and status, also information about bank details and related link to… - GETBank by ID
/banks/:idReturns bank with specific ID.
Payment methods
- GETList of payment methods
/payment-methods?page[number]=0&page[size]=0&filter[search]=string&filter[name]=string&filter[code]=string&filter[processor_name]=string&filter[category]=card&sort=nameReturns list of payment methods. Each object contains information about payment method such as name and category, also related link to payment method issuer… - GETPayment method by ID
/payment-methods/:idReturns payment method with specific ID.
Deposit methods
- GETList of deposit methods
/deposit-methods?page[number]=0&page[size]=0&filter[search]=string&filter[name]=string&filter[code]=string&filter[processor_name]=string&filter[category]=card&sort=nameReturns list of deposit methods. Each object contains information about deposit method such as name and category, also related link to deposit method issuer… - GETDeposit method by ID
/deposit-methods/:idReturns deposit method with specific ID.
Payment providers
- GETList of payment providers
/payment-providers?page[number]=0&page[size]=0&filter[search]=string&filter[name]=string&filter[code]=string&filter[types]=distributor&filter[sales_channels]=e_commerce&filter[features]=e_commerce&sort=nameA payment service provider (PSP) offers shops online services for accepting electronic payments by a variety of payment methods.<br> Endpoint returns list of… - GETPayment provider by ID
/payment-providers/:idReturns payment provider with specific ID.
Merchant industries
- GETList of merchant industries
/merchant-industries?page[number]=0&page[size]=0&filter[name]=stringReturns all available merchant fields of activity. - GETMerchant industry by ID
/merchant-industries/:idReturns merchant industry with specific ID.
API details
- Base URL
https://api.openfintech.io/v1- Authentication
- None declared in the description
- Operations
- 18 operations on 18 pathsGET 18
- Main resources
- Banks 2Countries 2Currencies 2Deposit methods 2Exchangers 2Merchant industries 2Organizations 2Payment methods 2Payment providers 2
- Response formats
application/vnd.api+json- Description format
- Swagger 2.0, API version
2017-08-24 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the OpenFinTech.io in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the OpenFinTech.io collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “List of countries” (GET /countries?page[number]=0&page[size]=0&filter[region]=africa&filter[sub_region]=northern_africa&sort=name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the OpenFinTech.io?
Introduction [OpenFinTech.io](https://openfintech.io) is an open database that comprises of standardized primary data for FinTech industry. It contains such… It is listed under Finance & banking and has 18 endpoints.
Who publishes the OpenFinTech.io?
It is listed from Openfintech's public API description (an OpenAPI document), not published by Openfintech on Swastik Codes. Anyone who controls openfintech.io can claim the profile by adding a DNS TXT record.
What is the base URL of the OpenFinTech.io?
Requests go to https://api.openfintech.io/v1. Endpoint paths are added to this base URL.
How do I authenticate with the OpenFinTech.io?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the OpenFinTech.io have?
18 operations on 18 paths (18 GET). The largest groups are Banks, Countries, Currencies, Deposit methods.
Is forking the OpenFinTech.io free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.