API Explorer

								
									{
  "id":"123",
  "bank_id":"gh.29.uk",
  "name":"OBP",
  "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:

CanCreateAtm - Please login to request this Role
CanCreateAtmAtAnyBank - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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

Connector Methods:

Version: OBPv2.2.0, function_name: by createAtm, operation_id: OBPv2.2.0-createAtm Tags: ATM,

Get Bank ATM

Returns information about ATM for a single bank specified by BANK_ID and ATM_ID including:

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

User Authentication is Optional. The User need not be logged in.

URL Parameters:

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

address:

city:

country: Germany

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

state:

Typical Successful Response:

								
									{
  "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.
OBP-30009: ATM not found. Please specify a valid value for ATM_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv2.1.0, function_name: by getAtm, operation_id: OBPv2.1.0-getAtm Tags: ATM, Old-Style,

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

v2.2.0 (220 APIs)

Create ATM

Get Bank ATM