right logo image
right logo image
Ingresar
⯆

API Explorer

Log off

v5.1.0 filtered by tags: User ... (545 APIs)

Anfitrión de la API: https://api.ttk.com.mk
Banco
Cuentas
Vistas
Contrapartes
Transacciones

Create Bank Level Endpoint Tag

Create Bank Level Endpoint Tag

Note: Resource Docs are cached, TTL is 3600 seconds

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

OPERATION_ID: OBPv4.0.0-getBanks

JSON request body fields:

tag_name: BankAccountTag1

JSON response body fields:

bank_id: gh.29.uk

endpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

operation_id: OBPv4.0.0-getBanks

tag_name: BankAccountTag1

Respuesta Exitosa Típica: 

								
									
{
  "bank_id":"gh.29.uk",
  "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "operation_id":"OBPv4.0.0-getBanks",
  "tag_name":"BankAccountTag1"
}
Roles Requeridos:
  • CanCreateBankLevelEndpointTag - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by createBankLevelEndpointTag, operation_id: OBPv4.0.0-createBankLevelEndpointTag Tags: API,

Create System Level Endpoint Tag

Create System Level Endpoint Tag

Note: Resource Docs are cached, TTL is 3600 seconds

Authentication is Mandatory

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON request body fields:

tag_name: BankAccountTag1

JSON response body fields:

bank_id: gh.29.uk

endpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

operation_id: OBPv4.0.0-getBanks

tag_name: BankAccountTag1

Respuesta Exitosa Típica: 

								
									
{
  "bank_id":"gh.29.uk",
  "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "operation_id":"OBPv4.0.0-getBanks",
  "tag_name":"BankAccountTag1"
}
Roles Requeridos:
  • CanCreateSystemLevelEndpointTag - 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-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by createSystemLevelEndpointTag, operation_id: OBPv4.0.0-createSystemLevelEndpointTag Tags: API,

Delete Bank Level Endpoint Tag

Delete Bank Level Endpoint Tag.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

ENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

Respuesta Exitosa Típica: 

								
									
true
Roles Requeridos:
  • CanDeleteBankLevelEndpointTag - 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by deleteBankLevelEndpointTag, operation_id: OBPv4.0.0-deleteBankLevelEndpointTag Tags: API,

Delete System Level Endpoint Tag

Delete System Level Endpoint Tag.

Authentication is Mandatory

URL Parameters:

ENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

Respuesta Exitosa Típica: 

								
									
true
Roles Requeridos:
  • CanDeleteSystemLevelEndpointTag - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by deleteSystemLevelEndpointTag, operation_id: OBPv4.0.0-deleteSystemLevelEndpointTag Tags: API,

Get API Configuration

Returns information about:

  • The default bank_id
  • Akka configuration
  • Elastic Search configuration
  • Cached functions

Authentication is Mandatory

JSON response body fields:

akka:

cache:

elastic_search:

function_name:

log_level:

metrics:

ports:

property:

require_scopes_for_all_roles:

require_scopes_for_listed_roles: false

scopes:

ttl_in_seconds:

value: 5987953

warehouse:

remote_data_secret_matched:

Respuesta Exitosa Típica: 

								
									
{
  "akka":{
    "ports":[{
      "property":"default",
      "value":"8080"
    }],
    "log_level":"Debug",
    "remote_data_secret_matched":true
  },
  "elastic_search":{
    "metrics":[{
      "property":"String",
      "value":"Mapper"
    }],
    "warehouse":[{
      "property":"String",
      "value":"ElasticSearch"
    }]
  },
  "cache":[{
    "function_name":"getBanks",
    "ttl_in_seconds":5
  }],
  "scopes":{
    "require_scopes_for_all_roles":true,
    "require_scopes_for_listed_roles":["CanCreateUserAuthContextUpdate"]
  }
}
Roles Requeridos:
  • CanGetConfig - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.1.0, function_name: by config, operation_id: OBPv3.1.0-config Tags: API,

Get API Info (root)

Returns information about:

  • API version
  • Hosted by information
  • Hosted at information
  • Energy source information
  • Git Commit

Authentication is Optional

JSON response body fields:

connector: connector

email: felixsmith@example.com

energy_source:

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

hosted_at:

hosted_by:

hostname: hostname

local_identity_provider: local_identity_provider

organisation:

organisation_website:

phone:

resource_docs_requires_role: resource_docs_requires_role

version:

version_status:

Respuesta Exitosa Típica: 

								
									
{
  "version":"String",
  "version_status":"String",
  "git_commit":"String",
  "connector":"String",
  "hostname":"String",
  "local_identity_provider":"String",
  "hosted_by":{
    "organisation":"String",
    "email":"String",
    "phone":"String",
    "organisation_website":"String"
  },
  "hosted_at":{
    "organisation":"Amazon",
    "organisation_website":"https://aws.amazon.com/"
  },
  "energy_source":{
    "organisation":"Stromio",
    "organisation_website":"https://www.stromio.de/"
  },
  "resource_docs_requires_role":false
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
  • no connector set
Métodos de conector::
Version: OBPv5.1.0, function_name: by root, operation_id: OBPv5.1.0-root Tags: API,

Get Adapter Info

Get basic information about the Adapter.

Authentication is Optional

Authentication is Mandatory

JSON response body fields:

backend_messages: backend_messages

date: 2020-01-27

errorCode: errorCode

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

name: ACCOUNT_MANAGEMENT_FEE

source:

status:

text:

total_duration: total_duration

version:

duration: 5.123

Respuesta Exitosa Típica: 

								
									
{
  "name":"ACCOUNT_MANAGEMENT_FEE",
  "version":"",
  "git_commit":"59623811dd8a41f6ffe67be46954eee11913dc28",
  "date":"2020-01-27",
  "total_duration":"5.123",
  "backend_messages":[{
    "source":"",
    "status":"",
    "errorCode":"",
    "text":"",
    "duration":"5.123"
  }]
}
Roles Requeridos:
  • CanGetAdapterInfo - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv5.0.0, function_name: by getAdapterInfo, operation_id: OBPv5.0.0-getAdapterInfo Tags: API,

Get Adapter Info for a bank

Get basic information about the Adapter listening on behalf of this bank.

Authentication is Optional

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

date: 2020-01-27

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

name: ACCOUNT_MANAGEMENT_FEE

version:

Respuesta Exitosa Típica: 

								
									
{
  "name":"String",
  "version":"String",
  "git_commit":"String",
  "date":"2013-01-21T23:08:00Z"
}
Roles Requeridos:
  • CanGetAdapterInfoAtOneBank - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.0.0, function_name: by getAdapterInfoForBank, operation_id: OBPv3.0.0-getAdapterInfoForBank Tags: API,

Get Bank Level Endpoint Tags

Get Bank Level Endpoint Tags.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

bank_id: gh.29.uk

endpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

operation_id: OBPv4.0.0-getBanks

tag_name: BankAccountTag1

Respuesta Exitosa Típica: 

								
									
[{
  "bank_id":"gh.29.uk",
  "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "operation_id":"OBPv4.0.0-getBanks",
  "tag_name":"BankAccountTag1"
}]
Roles Requeridos:
  • CanGetBankLevelEndpointTag - 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getBankLevelEndpointTags, operation_id: OBPv4.0.0-getBankLevelEndpointTags Tags: API,

Get Connector Status (Loopback)

This endpoint makes a call to the Connector to check the backend transport (e.g. Kafka) is reachable.

Currently this is only implemented for Kafka based connectors.

For Kafka based connectors, this endpoint writes a message to Kafka and reads it again.

In the future, this endpoint may also return information about database connections etc.

Authentication is Mandatory

JSON response body fields:

connector_version:

duration_time: 60

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

Respuesta Exitosa Típica: 

								
									
{
  "connector_version":"kafka_vSept2018",
  "git_commit":"f0acd4be14cdcb94be3433ec95c1ad65228812a0",
  "duration_time":"10 ms"
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Métodos de conector::
Version: OBPv3.1.0, function_name: by getObpConnectorLoopback, operation_id: OBPv3.1.0-getObpConnectorLoopback Tags: API,

Get JSON Web Key (JWK)

Get the server's public JSON Web Key (JWK) set and certificate chain.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.

Authentication is Optional

JSON response body fields:

e:

kid:

kty:

n:

use:

Respuesta Exitosa Típica: 

								
									
{
  "kty":"RSA",
  "e":"AQAB",
  "use":"sig",
  "kid":"fr6-BxXH5gikFeZ2O6rGk0LUmJpukeswASN_TMW8U_s",
  "n":"hrB0OWqg6AeNU3WCnhheG18R5EbQtdNYGOaSeylTjkj2lZr0_vkhNVYvase-CroxO4HOT06InxTYwLnmJiyv2cZxReuoVjTlk--olGu-9MZooiFiqWez0JzndyKxQ27OiAjFsMh0P04kaUXeHKhXRfiU7K2FqBshR1UlnWe7iHLkq2p9rrGjxQc7ff0w-Uc0f-8PWg36Y2Od7s65493iVQwnI13egqMaSvgB1s8_dgm08noEjhr8C5m1aKmr5oipWEPNi-SBV2VNuiCLR1IEPuXq0tOwwZfv31t34KPO-2H2bbaWmzGJy9mMOGqoNrbXyGiUZoyeHRELaNtm1GilyQ"
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.1.0, function_name: by getServerJWK, operation_id: OBPv3.1.0-getServerJWK Tags: API, Account Information Service (AIS), PSD2,

Get JSON Web Key (JWK) URIs

Get the OAuth2 server's public JSON Web Key (JWK) URIs.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.

Authentication is Optional

JSON response body fields:

jwks_uri:

jwks_uris:

Respuesta Exitosa Típica: 

								
									
{
  "jwks_uris":[{
    "jwks_uri":"https://www.googleapis.com/oauth2/v3/certs"
  }]
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.1.0, function_name: by getOAuth2ServerJWKsURIs, operation_id: OBPv3.1.0-getOAuth2ServerJWKsURIs Tags: API,

Get Mapper Database Info

Get basic information about the Mapper Database.

Authentication is Mandatory

JSON response body fields:

date: 2020-01-27

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

name: ACCOUNT_MANAGEMENT_FEE

version:

Respuesta Exitosa Típica: 

								
									
{
  "name":"String",
  "version":"String",
  "git_commit":"String",
  "date":"2013-01-21T23:08:00Z"
}
Roles Requeridos:
  • CanGetDatabaseInfo - 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-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv4.0.0, function_name: by getMapperDatabaseInfo, operation_id: OBPv4.0.0-getMapperDatabaseInfo Tags: API,

Get Rate Limiting Info

Get information about the Rate Limiting setup on this OBP Instance such as:

Is rate limiting enabled and active?
What backend is used to keep track of the API calls (e.g. REDIS).

Note: Rate limiting can be set at the Consumer level and also for anonymous calls.

See the consumer rate limits / call limits endpoints.

Authentication is Mandatory

JSON response body fields:

enabled: false

is_active: false

service_available:

technology: technology1

Respuesta Exitosa Típica: 

								
									
{
  "enabled":true,
  "technology":"REDIS",
  "service_available":true,
  "is_active":true
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Métodos de conector::
Version: OBPv3.1.0, function_name: by getRateLimitingInfo, operation_id: OBPv3.1.0-getRateLimitingInfo Tags: API, Rate-Limits,

Get Suggested Session Timeout

Returns information about:

  • Suggested session timeout in case of a user inactivity

Authentication is Optional

JSON response body fields:

timeout_in_seconds: timeout_in_seconds

Respuesta Exitosa Típica: 

								
									
{
  "timeout_in_seconds":"300"
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv5.1.0, function_name: by suggestedSessionTimeout, operation_id: OBPv5.1.0-suggestedSessionTimeout Tags: API,

Get System Level Endpoint Tags

Get System Level Endpoint Tags.

Authentication is Mandatory

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

bank_id: gh.29.uk

endpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

operation_id: OBPv4.0.0-getBanks

tag_name: BankAccountTag1

Respuesta Exitosa Típica: 

								
									
[{
  "bank_id":"gh.29.uk",
  "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "operation_id":"OBPv4.0.0-getBanks",
  "tag_name":"BankAccountTag1"
}]
Roles Requeridos:
  • CanGetSystemLevelEndpointTag - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getSystemLevelEndpointTags, operation_id: OBPv4.0.0-getSystemLevelEndpointTags Tags: API,

Get the Call Context of a current call

Get the Call Context of the current call.

Authentication is Mandatory

JSON response body fields:

Respuesta Exitosa Típica:
Roles Requeridos:
  • CanGetCallContext - 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-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv4.0.0, function_name: by getCallContext, operation_id: OBPv4.0.0-getCallContext Tags: API,

Update Bank Level Endpoint Tag

Update Endpoint Tag, you can only update the tag_name here, operation_id can not be updated.

Note: Resource Docs are cached, TTL is 3600 seconds

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

ENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

bank_id: gh.29.uk

endpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

operation_id: OBPv4.0.0-getBanks

tag_name: BankAccountTag1

Respuesta Exitosa Típica: 

								
									
{
  "bank_id":"gh.29.uk",
  "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "operation_id":"OBPv4.0.0-getBanks",
  "tag_name":"BankAccountTag1"
}
Roles Requeridos:
  • CanUpdateBankLevelEndpointTag - 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-30099: Invalid ENDPOINT_TAG_ID. Please specify a valid value for ENDPOINT_TAG_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by updateBankLevelEndpointTag, operation_id: OBPv4.0.0-updateBankLevelEndpointTag Tags: API,

Update System Level Endpoint Tag

Update System Level Endpoint Tag, you can only update the tag_name here, operation_id can not be updated.

Note: Resource Docs are cached, TTL is 3600 seconds

Authentication is Mandatory

URL Parameters:

ENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

bank_id: gh.29.uk

endpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

operation_id: OBPv4.0.0-getBanks

tag_name: BankAccountTag1

Respuesta Exitosa Típica: 

								
									
{
  "bank_id":"gh.29.uk",
  "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "operation_id":"OBPv4.0.0-getBanks",
  "tag_name":"BankAccountTag1"
}
Roles Requeridos:
  • CanUpdateSystemLevelEndpointTag - 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-20006: User is missing one or more roles:
  • OBP-30099: Invalid ENDPOINT_TAG_ID. Please specify a valid value for ENDPOINT_TAG_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by updateSystemLevelEndpointTag, operation_id: OBPv4.0.0-updateSystemLevelEndpointTag Tags: API,

Verify Request and Sign Response of a current call

Verify Request and Sign Response of a current call.

Authentication is Mandatory

JSON response body fields:

Respuesta Exitosa Típica:
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by verifyRequestSignResponse, operation_id: OBPv4.0.0-verifyRequestSignResponse Tags: API,

Waiting For Godot

Waiting For Godot

Uses query parameter "sleep" in milliseconds.
For instance: .../waiting-for-godot?sleep=50 means postpone response in 50 milliseconds.

Authentication is Optional

JSON response body fields:

sleep_in_milliseconds: sleep_in_milliseconds

Respuesta Exitosa Típica: 

								
									
{
  "sleep_in_milliseconds":50
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
  • no connector set
Métodos de conector::
Version: OBPv5.1.0, function_name: by waitingForGodot, operation_id: OBPv5.1.0-waitingForGodot Tags: API,

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: false

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

is_accessible: false

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: atme-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: false

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

is_accessible: false

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: false

Respuesta Exitosa Típica: 

								
									
{
  "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
  }]
}
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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
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: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON request body fields:

name: ACCOUNT_MANAGEMENT_FEE

type:

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

type:

value: 5987953

is_active: false

Respuesta Exitosa Típica: 

								
									
{
  "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
}
Roles Requeridos:
  • CanCreateAtmAttribute - Please login to request this Role
  • CanCreateAtmAttributeAtAnyBank - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
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:

Respuesta Exitosa Típica:
Roles Requeridos:
  • CanDeleteAtmAtAnyBank - Please login to request this Role
  • CanDeleteAtm - 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-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
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: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

Respuesta Exitosa Típica:
Roles Requeridos:
  • CanDeleteAtmAttribute - Please login to request this Role
  • CanDeleteAtmAttributeAtAnyBank - 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.
Métodos de conector::
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: 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

type:

value: 5987953

is_active: false

Respuesta Exitosa Típica: 

								
									
{
  "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
}
Roles Requeridos:
  • CanGetAtmAttribute - Please login to request this Role
  • CanGetAtmAttributeAtAnyBank - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
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: 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

type:

value: 5987953

is_active: false

Respuesta Exitosa Típica: 

								
									
{
  "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
  }]
}
Roles Requeridos:
  • CanGetAtmAttribute - Please login to request this Role
  • CanGetAtmAttributeAtAnyBank - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
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"]

address:

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

atm_id: atme-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: false

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

is_accessible: false

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: false

Respuesta Exitosa Típica: 

								
									
{
  "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
  }]
}
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.
Métodos de conector::
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: atme-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: false

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

is_accessible: false

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: false

Respuesta Exitosa Típica: 

								
									
{
  "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
    }]
  }]
}
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-50000: Unknown Error.
Métodos de conector::
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: false

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

is_accessible: false

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

Respuesta Exitosa Típica: 

								
									
{
  "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":""
  }]
}
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-50000: Unknown Error.
Métodos de conector::
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"]

address:

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

atm_id: atme-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: false

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

is_accessible: false

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: false

Respuesta Exitosa Típica: 

								
									
{
  "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
  }]
}
Roles Requeridos:
  • CanUpdateAtm - Please login to request this Role
  • CanUpdateAtmAtAnyBank - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
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

Respuesta Exitosa Típica: 

								
									
{
  "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
  "accessibility_features":["ATAC","ATAD"]
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
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

type:

value: 5987953

is_active: false

Respuesta Exitosa Típica: 

								
									
{
  "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
}