API Explorer

v3.0.0 (164 APIs)

Anfitrión de la API: https://api3.openbankproject.com
Banco
Cuentas
Vistas
Contrapartes
Transacciones

Create ATM

Create ATM for the Bank.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

address:

bank_id: gh.29.uk

city:

closing_time: 2020-01-27

country_code: 1254

county:

friday:

has_deposit_capability: true

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

is_accessible: true

latitude: 38.8951

license:

line_1:

line_2:

line_3:

located_at:

location:

longitude: -77.0364

meta:

monday:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

opening_time:

postcode:

saturday:

state:

sunday:

thursday:

tuesday:

wednesday:

JSON response body fields:

address:

bank_id: gh.29.uk

city:

closing_time: 2020-01-27

country_code: 1254

county:

friday:

has_deposit_capability: true

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

is_accessible: true

latitude: 38.8951

license:

line_1:

line_2:

line_3:

located_at:

location:

longitude: -77.0364

meta:

monday:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

opening_time:

postcode:

saturday:

state:

sunday:

thursday:

tuesday:

wednesday:

Respuesta Exitosa Típica:

								
									
{ "id":"atm-id-123", "bank_id":"gh.29.uk", "name":"Atm by the Lake", "address":{ "line_1":"No 1 the Road", "line_2":"The Place", "line_3":"The Hill", "city":"Berlin", "county":"", "state":"Brandenburg", "postcode":"13359", "country_code":"DE" }, "location":{ "latitude":11.45, "longitude":11.45 }, "meta":{ "license":{ "id":"ODbL-1.0", "name":"Open Database License" } }, "monday":{ "opening_time":"10:00", "closing_time":"18:00" }, "tuesday":{ "opening_time":"10:00", "closing_time":"18:00" }, "wednesday":{ "opening_time":"10:00", "closing_time":"18:00" }, "thursday":{ "opening_time":"10:00", "closing_time":"18:00" }, "friday":{ "opening_time":"10:00", "closing_time":"18:00" }, "saturday":{ "opening_time":"10:00", "closing_time":"18:00" }, "sunday":{ "opening_time":"10:00", "closing_time":"18:00" }, "is_accessible":"true", "located_at":"Full service store", "more_info":"short walk to the lake from here", "has_deposit_capability":"true" }
Roles Requeridos:
  • CanCreateAtm - Please login to request this Role
  • CanCreateAtmAtAnyBank - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Version: OBPv3.0.0, function_name: by createAtm, operation_id: OBPv3.0.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

Authentication is Optional

URL Parameters:

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

BANK_ID: gh.29.uk

JSON response body fields:

address:

bank_id: gh.29.uk

city:

closing_time: 2020-01-27

country_code: 1254

county:

friday:

has_deposit_capability: true

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

is_accessible: true

latitude: 38.8951

license:

line_1:

line_2:

line_3:

located_at:

location:

longitude: -77.0364

meta:

monday:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

opening_time:

postcode:

saturday:

state:

sunday:

thursday:

tuesday:

wednesday:

Respuesta Exitosa Típica:

								
									
{ "id":"atm-id-123", "bank_id":"gh.29.uk", "name":"Atm by the Lake", "address":{ "line_1":"No 1 the Road", "line_2":"The Place", "line_3":"The Hill", "city":"Berlin", "county":"", "state":"Brandenburg", "postcode":"13359", "country_code":"DE" }, "location":{ "latitude":11.45, "longitude":11.45 }, "meta":{ "license":{ "id":"ODbL-1.0", "name":"Open Database License" } }, "monday":{ "opening_time":"10:00", "closing_time":"18:00" }, "tuesday":{ "opening_time":"10:00", "closing_time":"18:00" }, "wednesday":{ "opening_time":"10:00", "closing_time":"18:00" }, "thursday":{ "opening_time":"10:00", "closing_time":"18:00" }, "friday":{ "opening_time":"10:00", "closing_time":"18:00" }, "saturday":{ "opening_time":"10:00", "closing_time":"18:00" }, "sunday":{ "opening_time":"10:00", "closing_time":"18:00" }, "is_accessible":"true", "located_at":"Full service store", "more_info":"short walk to the lake from here", "has_deposit_capability":"true" }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Version: OBPv3.0.0, function_name: by getAtm, operation_id: OBPv3.0.0-getAtm Tags: ATM,

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

Pagination:

By default, 100 records are returned.

You can use the url query parameters limit and offset for pagination

Authentication is Optional

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

address:

bank_id: gh.29.uk

city:

closing_time: 2020-01-27

country_code: 1254

county:

friday:

has_deposit_capability: true

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

is_accessible: true

latitude: 38.8951

license:

line_1:

line_2:

line_3:

located_at:

location:

longitude: -77.0364

meta:

monday:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

opening_time:

postcode:

saturday:

state:

sunday:

thursday:

tuesday:

wednesday:

Respuesta Exitosa Típica:

								
									
{ "id":"atm-id-123", "bank_id":"gh.29.uk", "name":"Atm by the Lake", "address":{ "line_1":"No 1 the Road", "line_2":"The Place", "line_3":"The Hill", "city":"Berlin", "county":"", "state":"Brandenburg", "postcode":"13359", "country_code":"DE" }, "location":{ "latitude":11.45, "longitude":11.45 }, "meta":{ "license":{ "id":"ODbL-1.0", "name":"Open Database License" } }, "monday":{ "opening_time":"10:00", "closing_time":"18:00" }, "tuesday":{ "opening_time":"10:00", "closing_time":"18:00" }, "wednesday":{ "opening_time":"10:00", "closing_time":"18:00" }, "thursday":{ "opening_time":"10:00", "closing_time":"18:00" }, "friday":{ "opening_time":"10:00", "closing_time":"18:00" }, "saturday":{ "opening_time":"10:00", "closing_time":"18:00" }, "sunday":{ "opening_time":"10:00", "closing_time":"18:00" }, "is_accessible":"true", "located_at":"Full service store", "more_info":"short walk to the lake from here", "has_deposit_capability":"true" }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Version: OBPv3.0.0, function_name: by getAtms, operation_id: OBPv3.0.0-getAtms Tags: ATM,