API Explorer

v1 (490 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create ATM

Create ATM.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

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":"5", "name":"TESOBE" } }, "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":"no-example-provided", "more_info":"no-example-provided", "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":"no-example-provided", "site_identification":"no-example-provided", "site_name":"no-example-provided", "cash_withdrawal_national_fee":"no-example-provided", "cash_withdrawal_international_fee":"no-example-provided", "balance_inquiry_fee":"no-example-provided" }
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: OBPv4.0.0, function_name: by createAtm, operation_id: OBPv4.0.0-createAtm Tags: ATM, New-Style,

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:

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":"5", "name":"TESOBE" } }, "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":"no-example-provided", "more_info":"no-example-provided", "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":"no-example-provided", "site_identification":"no-example-provided", "site_name":"no-example-provided", "cash_withdrawal_national_fee":"no-example-provided", "cash_withdrawal_international_fee":"no-example-provided", "balance_inquiry_fee":"no-example-provided" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Version: OBPv4.0.0, function_name: by getAtm, operation_id: OBPv4.0.0-getAtm Tags: ATM, New-Style,

Get Bank ATMS

Get Bank ATMS.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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":"5", "name":"TESOBE" } }, "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":"no-example-provided", "more_info":"no-example-provided", "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":"no-example-provided", "site_identification":"no-example-provided", "site_name":"no-example-provided", "cash_withdrawal_national_fee":"no-example-provided", "cash_withdrawal_international_fee":"no-example-provided", "balance_inquiry_fee":"no-example-provided" }] }
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.
Version: OBPv4.0.0, function_name: by getAtms, operation_id: OBPv4.0.0-getAtms Tags: ATM, New-Style,

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:

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":"5", "name":"TESOBE" } }, "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":"no-example-provided", "more_info":"no-example-provided", "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":"no-example-provided", "site_identification":"no-example-provided", "site_name":"no-example-provided", "cash_withdrawal_national_fee":"no-example-provided", "cash_withdrawal_international_fee":"no-example-provided", "balance_inquiry_fee":"no-example-provided" }
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: OBPv4.0.0, function_name: by updateAtm, operation_id: OBPv4.0.0-updateAtm Tags: ATM, New-Style,

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:

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.
Version: OBPv4.0.0, function_name: by updateAtmAccessibilityFeatures, operation_id: OBPv4.0.0-updateAtmAccessibilityFeatures Tags: ATM, New-Style,

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:

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.
Version: OBPv4.0.0, function_name: by updateAtmLocationCategories, operation_id: OBPv4.0.0-updateAtmLocationCategories Tags: ATM, New-Style,

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, New-Style,

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:

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, New-Style,

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:

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.
Version: OBPv4.0.0, function_name: by updateAtmSupportedCurrencies, operation_id: OBPv4.0.0-updateAtmSupportedCurrencies Tags: ATM, New-Style,

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:

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.
Version: OBPv4.0.0, function_name: by updateAtmSupportedLanguages, operation_id: OBPv4.0.0-updateAtmSupportedLanguages Tags: ATM, New-Style,