API Explorer

								
									{
  "id":"gh.29.uk",
  "short_name":"short_name ",
  "full_name":"full_name",
  "logo":"logo",
  "website":"www.openbankproject.com",
  "bank_routing":{
    "scheme":"Bank_ID",
    "address":"gh.29.uk"
  }
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.

Connector Methods:

obp.getBankLegacy

Version: OBPv1.2.1, function_name: by bankById, operation_id: OBPv1.2.1-bankById Tags: Bank, PSD2,

Get Bank ATMS

Returns information about ATMs for a single bank specified by BANK_ID including:

Address
Geo Location
License the data under this endpoint is released under

Possible custom url parameters for pagination:

limit=NUMBER ==> default value: 50
offset=NUMBER ==> default value: 0

eg1:?limit=100&offset=0

sort_direction=ASC/DESC ==> default value: DESC.

eg2:?limit=100&offset=0&sort_direction=ASC

Authentication is Optional

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

country: country
latitude: 38.8951
longitude: -77.0364
name: ACCOUNT_MANAGEMENT_FEE

Typical Successful Response:

								
									{
  "atms":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "name":"String",
    "address":{
      "line_1":"Osloer Straße 16/17",
      "line_2":"Wedding",
      "line_3":"",
      "city":"Berlin",
      "state":"Berlin Brandenburg",
      "postcode":"13359",
      "country":"DE"
    },
    "location":{
      "latitude":11.45,
      "longitude":11.45
    },
    "meta":{
      "license":{
        "id":"ODbL-1.0",
        "name":"Open Database License"
      }
    }
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
No ATMs available. License may not be set.
OBP-50000: Unknown Error.

Connector Methods:

obp.getBankLegacy

Version: OBPv1.4.0, function_name: by getAtms, operation_id: OBPv1.4.0-getAtms Tags: Bank,

Get Bank Products

Returns information about the financial products offered by a bank specified by BANK_ID including:

Name
Code
Category
Family
Super Family
More info URL
Description
Terms and Conditions
License the data under this endpoint is released under
Authentication is Optional

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

[code](/glossary#Transaction Requests.Transaction Request Refund Reason Code): 125
name: ACCOUNT_MANAGEMENT_FEE

Typical Successful Response:

								
									{
  "products":[{
    "code":"String",
    "name":"String",
    "category":"String",
    "family":"String",
    "super_family":"String",
    "more_info_url":"String",
    "meta":{
      "license":{
        "id":"ODbL-1.0",
        "name":"Open Database License"
      }
    }
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
No products available.
License may not be set.
OBP-50000: Unknown Error.

Connector Methods:

obp.getBankLegacy

Version: OBPv1.4.0, function_name: by getProducts, operation_id: OBPv1.4.0-getProducts Tags: Bank,

Get Banks

Get banks on this API instance
Returns a list of banks supported on this server:

ID used as parameter in URLs
Short and full name of bank
Logo URL
Website

Authentication is Optional

JSON response body fields:

Typical Successful Response:

								
									{
  "banks":[{
    "id":"gh.29.uk",
    "short_name":"short_name ",
    "full_name":"full_name",
    "logo":"logo",
    "website":"www.openbankproject.com",
    "bank_routing":{
      "scheme":"Bank_ID",
      "address":"gh.29.uk"
    }
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

obp.getBanksLegacy

Version: OBPv1.2.1, function_name: by getBanks, operation_id: OBPv1.2.1-getBanks Tags: Bank, PSD2,

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.
API_Explorer Commit

Featured APIs

API Explorer

v1.4.0 (87 APIs)

Get Bank

Get Bank ATMS

Get Bank Products

Get Banks