right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (505 APIs)

API Host: https://api3.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

Create ATM

Create ATM.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

accessibility_features: ["ATAC","ATAD"]

address:

atm_type:

balance_inquiry_fee:

bank_id: gh.29.uk

branch_identification: branch_identification

cash_withdrawal_international_fee:

cash_withdrawal_national_fee:

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:

location_categories: location_categories

longitude: -77.0364

meta:

minimum_withdrawal: minimum_withdrawal

monday:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

notes: notes

opening_time:

phone:

postcode:

saturday:

services: services

site_identification: site_identification

site_name: site_name

state:

sunday:

supported_currencies: ["EUR","MXN","USD"]

supported_languages: ["es","fr","de"]

thursday:

tuesday:

wednesday:

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

JSON response body fields:

accessibility_features: ["ATAC","ATAD"]

address:

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

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

atm_type:

balance_inquiry_fee:

bank_id: gh.29.uk

branch_identification: branch_identification

cash_withdrawal_international_fee:

cash_withdrawal_national_fee:

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:

location_categories: location_categories

longitude: -77.0364

meta:

minimum_withdrawal: minimum_withdrawal

monday:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

notes: notes

opening_time:

phone:

postcode:

saturday:

services: services

site_identification: site_identification

site_name: site_name

state:

sunday:

supported_currencies: ["EUR","MXN","USD"]

supported_languages: ["es","fr","de"]

thursday:

tuesday:

type:

value: 5987953

wednesday:

attributes: attribute value in form of (name, value)

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

is_active: true

Typical Successful Response: 

								
									
{
  "id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "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":"",
  "more_info":"More information about this fee",
  "has_deposit_capability":"true",
  "supported_languages":["es","fr","de"],
  "services":["ATBP","ATBA"],
  "accessibility_features":["ATAC","ATAD"],
  "supported_currencies":["EUR","MXN","USD"],
  "notes":["String1","String2"],
  "location_categories":["ATBI","ATBE"],
  "minimum_withdrawal":"5",
  "branch_identification":"",
  "site_identification":"",
  "site_name":"",
  "cash_withdrawal_national_fee":"",
  "cash_withdrawal_international_fee":"",
  "balance_inquiry_fee":"",
  "atm_type":"",
  "phone":"",
  "attributes":[{
    "bank_id":"gh.29.uk",
    "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
    "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "type":"",
    "value":"5987953",
    "is_active":true
  }]
}
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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv5.1.0, function_name: by createAtm, operation_id: OBPv5.1.0-createAtm Tags: ATM,

Create ATM Attribute

Create ATM Attribute

The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

JSON request body fields:

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

is_active: true

JSON response body fields:

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

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

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

is_active: true

Typical Successful Response: 

								
									
{
  "bank_id":"gh.29.uk",
  "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
  "name":"ACCOUNT_MANAGEMENT_FEE",
  "type":"",
  "value":"5987953",
  "is_active":true
}
Required Roles:
  • CanCreateAtmAttribute - Please login to request this Role
  • CanCreateAtmAttributeAtAnyBank - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv5.1.0, function_name: by createAtmAttribute, operation_id: OBPv5.1.0-createAtmAttribute Tags: ATM,

Delete ATM

Delete ATM.

This will also delete all its attributes.

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteAtmAtAnyBank - Please login to request this Role
  • CanDeleteAtm - 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-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv5.1.0, function_name: by deleteAtm, operation_id: OBPv5.1.0-deleteAtm Tags: ATM,

Delete ATM Attribute

Delete ATM Attribute

Delete a Atm Attribute by its id.

Authentication is Mandatory

URL Parameters:

ATM_ATTRIBUTE_ID: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

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

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteAtmAttribute - Please login to request this Role
  • CanDeleteAtmAttributeAtAnyBank - 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: OBPv5.1.0, function_name: by deleteAtmAttribute, operation_id: OBPv5.1.0-deleteAtmAttribute Tags: ATM,

Get ATM Attribute By ATM_ATTRIBUTE_ID

Get ATM Attribute By ATM_ATTRIBUTE_ID

Authentication is Mandatory

URL Parameters:

ATM_ATTRIBUTE_ID: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

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

BANK_ID: gh.29.uk

JSON response body fields:

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

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

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

is_active: true

Typical Successful Response: 

								
									
{
  "bank_id":"gh.29.uk",
  "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
  "name":"ACCOUNT_MANAGEMENT_FEE",
  "type":"",
  "value":"5987953",
  "is_active":true
}
Required Roles:
  • CanGetAtmAttribute - Please login to request this Role
  • CanGetAtmAttributeAtAnyBank - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv5.1.0, function_name: by getAtmAttribute, operation_id: OBPv5.1.0-getAtmAttribute Tags: ATM,

Get ATM Attributes

Get ATM Attributes

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

JSON response body fields:

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

atm_attributes: atm_attributes

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

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

is_active: true

Typical Successful Response: 

								
									
{
  "atm_attributes":[{
    "bank_id":"gh.29.uk",
    "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
    "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "type":"",
    "value":"5987953",
    "is_active":true
  }]
}
Required Roles:
  • CanGetAtmAttribute - Please login to request this Role
  • CanGetAtmAttributeAtAnyBank - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv5.1.0, function_name: by getAtmAttributes, operation_id: OBPv5.1.0-getAtmAttributes 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
  • ATM Attributes

Authentication is Optional

URL Parameters:

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

BANK_ID: gh.29.uk

JSON response body fields:

accessibility_features: ["ATAC","ATAD"]

address:

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

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

atm_type:

balance_inquiry_fee:

bank_id: gh.29.uk

branch_identification: branch_identification

cash_withdrawal_international_fee:

cash_withdrawal_national_fee:

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:

location_categories: location_categories

longitude: -77.0364

meta:

minimum_withdrawal: minimum_withdrawal

monday:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

notes: notes

opening_time:

phone:

postcode:

saturday:

services: services

site_identification: site_identification

site_name: site_name

state:

sunday:

supported_currencies: ["EUR","MXN","USD"]

supported_languages: ["es","fr","de"]

thursday:

tuesday:

type:

value: 5987953

wednesday:

attributes: attribute value in form of (name, value)

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

is_active: true

Typical Successful Response: 

								
									
{
  "id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "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":"",
  "more_info":"More information about this fee",
  "has_deposit_capability":"true",
  "supported_languages":["es","fr","de"],
  "services":["ATBP","ATBA"],
  "accessibility_features":["ATAC","ATAD"],
  "supported_currencies":["EUR","MXN","USD"],
  "notes":["String1","String2"],
  "location_categories":["ATBI","ATBE"],
  "minimum_withdrawal":"5",
  "branch_identification":"",
  "site_identification":"",
  "site_name":"",
  "cash_withdrawal_national_fee":"",
  "cash_withdrawal_international_fee":"",
  "balance_inquiry_fee":"",
  "atm_type":"",
  "phone":"",
  "attributes":[{
    "bank_id":"gh.29.uk",
    "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
    "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "type":"",
    "value":"5987953",
    "is_active":true
  }]
}
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: OBPv5.1.0, function_name: by getAtm, operation_id: OBPv5.1.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:

accessibility_features: ["ATAC","ATAD"]

address:

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

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

atm_type:

atms:

balance_inquiry_fee:

bank_id: gh.29.uk

branch_identification: branch_identification

cash_withdrawal_international_fee:

cash_withdrawal_national_fee:

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:

location_categories: location_categories

longitude: -77.0364

meta:

minimum_withdrawal: minimum_withdrawal

monday:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

notes: notes

opening_time:

phone:

postcode:

saturday:

services: services

site_identification: site_identification

site_name: site_name

state:

sunday:

supported_currencies: ["EUR","MXN","USD"]

supported_languages: ["es","fr","de"]

thursday:

tuesday:

type:

value: 5987953

wednesday:

attributes: attribute value in form of (name, value)

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

is_active: true

Typical Successful Response: 

								
									
{
  "atms":[{
    "id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
    "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":"",
    "more_info":"More information about this fee",
    "has_deposit_capability":"true",
    "supported_languages":["es","fr","de"],
    "services":["ATBP","ATBA"],
    "accessibility_features":["ATAC","ATAD"],
    "supported_currencies":["EUR","MXN","USD"],
    "notes":["String1","String2"],
    "location_categories":["ATBI","ATBE"],
    "minimum_withdrawal":"5",
    "branch_identification":"",
    "site_identification":"",
    "site_name":"",
    "cash_withdrawal_national_fee":"",
    "cash_withdrawal_international_fee":"",
    "balance_inquiry_fee":"",
    "atm_type":"",
    "phone":"",
    "attributes":[{
      "bank_id":"gh.29.uk",
      "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
      "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
      "name":"ACCOUNT_MANAGEMENT_FEE",
      "type":"",
      "value":"5987953",
      "is_active":true
    }]
  }]
}
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-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by getAtms, operation_id: OBPv5.1.0-getAtms Tags: ATM,

Head Bank ATMS

Head Bank ATMS.

Authentication is Optional

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

accessibility_features: ["ATAC","ATAD"]

address:

atms:

balance_inquiry_fee:

bank_id: gh.29.uk

branch_identification: branch_identification

cash_withdrawal_international_fee:

cash_withdrawal_national_fee:

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:

location_categories: location_categories

longitude: -77.0364

meta:

minimum_withdrawal: minimum_withdrawal

monday:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

notes: notes

opening_time:

postcode:

saturday:

services: services

site_identification: site_identification

site_name: site_name

state:

sunday:

supported_currencies: ["EUR","MXN","USD"]

supported_languages: ["es","fr","de"]

thursday:

tuesday:

wednesday:

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

Typical Successful Response: 

								
									
{
  "atms":[{
    "id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
    "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":"",
    "more_info":"More information about this fee",
    "has_deposit_capability":"true",
    "supported_languages":["es","fr","de"],
    "services":["ATBP","ATBA"],
    "accessibility_features":["ATAC","ATAD"],
    "supported_currencies":["EUR","MXN","USD"],
    "notes":["String1","String2"],
    "location_categories":["ATBI","ATBE"],
    "minimum_withdrawal":"5",
    "branch_identification":"",
    "site_identification":"",
    "site_name":"",
    "cash_withdrawal_national_fee":"",
    "cash_withdrawal_international_fee":"",
    "balance_inquiry_fee":""
  }]
}
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-50000: Unknown Error.
Connector Methods:
Version: OBPv5.0.0, function_name: by headAtms, operation_id: OBPv5.0.0-headAtms Tags: ATM,

UPDATE ATM

Update ATM.

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

JSON response body fields:

accessibility_features: ["ATAC","ATAD"]

address:

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

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

atm_type:

balance_inquiry_fee:

bank_id: gh.29.uk

branch_identification: branch_identification

cash_withdrawal_international_fee:

cash_withdrawal_national_fee:

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:

location_categories: location_categories

longitude: -77.0364

meta:

minimum_withdrawal: minimum_withdrawal

monday:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

notes: notes

opening_time:

phone:

postcode:

saturday:

services: services

site_identification: site_identification

site_name: site_name

state:

sunday:

supported_currencies: ["EUR","MXN","USD"]

supported_languages: ["es","fr","de"]

thursday:

tuesday:

type:

value: 5987953

wednesday:

attributes: attribute value in form of (name, value)

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

is_active: true

Typical Successful Response: 

								
									
{
  "id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "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":"",
  "more_info":"More information about this fee",
  "has_deposit_capability":"true",
  "supported_languages":["es","fr","de"],
  "services":["ATBP","ATBA"],
  "accessibility_features":["ATAC","ATAD"],
  "supported_currencies":["EUR","MXN","USD"],
  "notes":["String1","String2"],
  "location_categories":["ATBI","ATBE"],
  "minimum_withdrawal":"5",
  "branch_identification":"",
  "site_identification":"",
  "site_name":"",
  "cash_withdrawal_national_fee":"",
  "cash_withdrawal_international_fee":"",
  "balance_inquiry_fee":"",
  "atm_type":"",
  "phone":"",
  "attributes":[{
    "bank_id":"gh.29.uk",
    "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
    "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "type":"",
    "value":"5987953",
    "is_active":true
  }]
}
Required Roles:
  • CanUpdateAtm - Please login to request this Role
  • CanUpdateAtmAtAnyBank - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv5.1.0, function_name: by updateAtm, operation_id: OBPv5.1.0-updateAtm Tags: ATM,

Update ATM Accessibility Features

Update ATM Accessibility Features.

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

JSON response body fields:

accessibility_features: ["ATAC","ATAD"]

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

Typical Successful Response: 

								
									
{
  "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "accessibility_features":["ATAC","ATAD"]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateAtmAccessibilityFeatures, operation_id: OBPv4.0.0-updateAtmAccessibilityFeatures Tags: ATM,

Update ATM Attribute

Update ATM Attribute.

Update an ATM Attribute by its id.

Authentication is Mandatory

URL Parameters:

ATM_ATTRIBUTE_ID: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

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

BANK_ID: gh.29.uk

JSON response body fields:

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

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

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

is_active: true

Typical Successful Response: 

								
									
{
  "bank_id":"gh.29.uk",
  "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
  "name":"ACCOUNT_MANAGEMENT_FEE",
  "type":"",
  "value":"5987953",
  "is_active":true
}
Required Roles:
  • CanUpdateAtmAttribute - Please login to request this Role
  • CanUpdateAtmAttributeAtAnyBank - 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: OBPv5.1.0, function_name: by updateAtmAttribute, operation_id: OBPv5.1.0-updateAtmAttribute Tags: ATM,

Update ATM Location Categories

Update ATM Location Categories.

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

JSON response body fields:

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

location_categories: location_categories

Typical Successful Response: 

								
									
{
  "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "location_categories":["ATBI","ATBE"]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateAtmLocationCategories, operation_id: OBPv4.0.0-updateAtmLocationCategories Tags: ATM,

Update ATM Notes

Update ATM Notes.

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

JSON response body fields:

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

notes: notes

Typical Successful Response: 

								
									
{
  "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "notes":["String1","String2"]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateAtmNotes, operation_id: OBPv4.0.0-updateAtmNotes Tags: ATM,

Update ATM Services

Update ATM Services.

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

JSON response body fields:

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

services: services

Typical Successful Response: 

								
									
{
  "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "services":["ATBP","ATBA"]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateAtmServices, operation_id: OBPv4.0.0-updateAtmServices Tags: ATM,

Update ATM Supported Currencies

Update ATM Supported Currencies.

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

JSON response body fields:

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

supported_currencies: ["EUR","MXN","USD"]

Typical Successful Response: 

								
									
{
  "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "supported_currencies":["EUR","MXN","USD"]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateAtmSupportedCurrencies, operation_id: OBPv4.0.0-updateAtmSupportedCurrencies Tags: ATM,

Update ATM Supported Languages

Update ATM Supported Languages.

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

JSON response body fields:

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

supported_languages: ["es","fr","de"]

Typical Successful Response: 

								
									
{
  "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "supported_languages":["es","fr","de"]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateAtmSupportedLanguages, operation_id: OBPv4.0.0-updateAtmSupportedLanguages Tags: ATM,