API Explorer

value: 5987953

is_active: false

JSON response body fields:

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

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

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

is_active: false

Typical Successful Response:

								
									{
  "bank_id":"gh.29.uk",
  "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
  "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
  "name":"ACCOUNT_MANAGEMENT_FEE",
  "type":"",
  "value":"5987953",
  "is_active":false
}

Request Headers:

Response Headers:

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: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

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 a Atm Attribute by its id.

Authentication is Mandatory

URL Parameters:

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

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

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

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

Authentication is Mandatory

URL Parameters:

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

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

BANK_ID: gh.29.uk

JSON response body fields:

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

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

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

is_active: false

Typical Successful Response:

								
									{
  "bank_id":"gh.29.uk",
  "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
  "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
  "name":"ACCOUNT_MANAGEMENT_FEE",
  "type":"",
  "value":"5987953",
  "is_active":false
}

Request Headers:

Response Headers:

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

Authentication is Mandatory

URL Parameters:

ATM_ID: atme-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: atme-9a0f-4bfa-b30b-9003aa467f51

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

is_active: false

Typical Successful Response:

								
									{
  "atm_attributes":[{
    "bank_id":"gh.29.uk",
    "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
    "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "type":"",
    "value":"5987953",
    "is_active":false
  }]
}

Request Headers:

Response Headers:

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: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

accessibility_features: ["ATAC","ATAD"]

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

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

atm_type:

bank_id: gh.29.uk

branch_identification: branch_identification

closing_time: 2020-01-27

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

latitude: 38.8951

location_categories: location_categories

longitude: -77.0364

minimum_withdrawal: minimum_withdrawal

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

notes: notes

services: services

site_identification: site_identification

site_name: site_name

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

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

value: 5987953

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

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

is_active: false

Typical Successful Response:

								
									{
  "id":"atme-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":"false",
  "located_at":"",
  "more_info":"More information about this fee",
  "has_deposit_capability":"false",
  "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":"atme-9a0f-4bfa-b30b-9003aa467f51",
    "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "type":"",
    "value":"5987953",
    "is_active":false
  }]
}

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: 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"]

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

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

atm_type:

atms:

bank_id: gh.29.uk

branch_identification: branch_identification

closing_time: 2020-01-27

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

latitude: 38.8951

location_categories: location_categories

longitude: -77.0364

minimum_withdrawal: minimum_withdrawal

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

notes: notes

services: services

site_identification: site_identification

site_name: site_name

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

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

value: 5987953

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

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

is_active: false

Typical Successful Response:

								
									{
  "atms":[{
    "id":"atme-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":"false",
    "located_at":"",
    "more_info":"More information about this fee",
    "has_deposit_capability":"false",
    "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":"atme-9a0f-4bfa-b30b-9003aa467f51",
      "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
      "name":"ACCOUNT_MANAGEMENT_FEE",
      "type":"",
      "value":"5987953",
      "is_active":false
    }]
  }]
}

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-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"]

atms:

bank_id: gh.29.uk

branch_identification: branch_identification

closing_time: 2020-01-27

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

latitude: 38.8951

location_categories: location_categories

longitude: -77.0364

minimum_withdrawal: minimum_withdrawal

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

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

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

thursday:

tuesday:

wednesday:

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

Typical Successful Response:

								
									{
  "atms":[{
    "id":"atme-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":"false",
    "located_at":"",
    "more_info":"More information about this fee",
    "has_deposit_capability":"false",
    "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":""
  }]
}

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-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: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

accessibility_features: ["ATAC","ATAD"]

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

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

atm_type:

bank_id: gh.29.uk

branch_identification: branch_identification

closing_time: 2020-01-27

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

latitude: 38.8951

location_categories: location_categories

longitude: -77.0364

minimum_withdrawal: minimum_withdrawal

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

notes: notes

services: services

site_identification: site_identification

site_name: site_name

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

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

value: 5987953

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

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

is_active: false

Typical Successful Response:

								
									{
  "id":"atme-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":"false",
  "located_at":"",
  "more_info":"More information about this fee",
  "has_deposit_capability":"false",
  "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":"atme-9a0f-4bfa-b30b-9003aa467f51",
    "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "type":"",
    "value":"5987953",
    "is_active":false
  }]
}

Request Headers:

Response Headers:

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: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

accessibility_features: ["ATAC","ATAD"]

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

Typical Successful Response:

								
									{
  "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
  "accessibility_features":["ATAC","ATAD"]
}

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-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: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

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

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

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE