v5.1.0 filtered by tag: Branch (4 APIs)
Anfitrión de la API: https://obp-api-sandbox.nmbbank.co.tz
Banco
Cuentas
Vistas
Contrapartes
Transacciones
Create Branch
Create Branch for the Bank.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
bank_id: gh.29.uk
city:
closing_time: 2020-01-27
country_code: 1254
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_accessible: false
latitude: 38.8951
longitude: -77.0364
meta:
more_info: More information about this fee
name: ACCOUNT_MANAGEMENT_FEE
scheme: scheme value
JSON response body fields:
bank_id: gh.29.uk
city:
closing_time: 2020-01-27
country_code: 1254
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_accessible: false
latitude: 38.8951
longitude: -77.0364
meta:
more_info: More information about this fee
name: ACCOUNT_MANAGEMENT_FEE
scheme: scheme value
Respuesta Exitosa Típica:
{
"id":"branch-id-123",
"bank_id":"bank-id-123",
"name":"Branch by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"String",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":10.0,
"longitude":10.0
},
"meta":{
"license":{
"id":"ODbL-1.0",
"name":"Open Database License"
}
},
"lobby":{
"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"
}]
},
"drive_up":{
"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"
}
},
"branch_routing":{
"scheme":"OBP",
"address":"123abc"
},
"is_accessible":"true",
"accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
"branch_type":"Full service store",
"more_info":"short walk to the lake from here",
"phone_number":"+381631954907"
}
Roles Requeridos:
-
CanCreateBranch
- Please login to request this Role
-
CanCreateBranchAtAnyBank
- 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-30209: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv3.0.0,
function_name: by createBranch, operation_id: OBPv3.0.0-createBranch
Tags: Branch,
Delete Branch
Respuesta Exitosa Típica:
Roles Requeridos:
-
CanDeleteBranch
- Please login to request this Role
-
CanDeleteBranchAtAnyBank
- 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-30218: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv3.1.0,
function_name: by deleteBranch, operation_id: OBPv3.1.0-deleteBranch
Tags: Branch,
Get Branch
Returns information about a single Branch specified by BANK_ID and BRANCH_ID including:
- Name
- Address
- Geo Location
- License the data under this endpoint is released under.
Authentication is Optional
URL Parameters:
BANK_ID: gh.29.uk
BRANCH_ID: DERBY6
JSON response body fields:
bank_id: gh.29.uk
city:
closing_time: 2020-01-27
country_code: 1254
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_accessible: false
latitude: 38.8951
longitude: -77.0364
meta:
more_info: More information about this fee
name: ACCOUNT_MANAGEMENT_FEE
scheme: scheme value
Respuesta Exitosa Típica:
{
"id":"branch-id-123",
"bank_id":"bank-id-123",
"name":"Branch by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"String",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":10.0,
"longitude":10.0
},
"meta":{
"license":{
"id":"ODbL-1.0",
"name":"Open Database License"
}
},
"lobby":{
"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"
}]
},
"drive_up":{
"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"
}
},
"branch_routing":{
"scheme":"OBP",
"address":"123abc"
},
"is_accessible":"true",
"accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
"branch_type":"Full service store",
"more_info":"short walk to the lake from here",
"phone_number":"+381631954907"
}
Validaciones:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Posibles Errores:
- OBP-300010: Branch not found. Please specify a valid value for BRANCH_ID. Or License may not be set. meta.license.id and meta.license.name can not be empty
- OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.0.0,
function_name: by getBranch, operation_id: OBPv3.0.0-getBranch
Tags: Branch, Bank,
Get Branches for a Bank
Returns information about branches for a single bank specified by BANK_ID including:
- Name
- Address
- Geo Location
- License the data under this endpoint is released under
- Structured opening hours
- Accessible flag
- Branch Type
- More Info
Pagination:
By default, 50 records are returned.
You can use the url query parameters limit and offset for pagination
You can also use the follow url query parameters:
-
city - string, find Branches those in this city, optional
-
withinMetersOf - number, find Branches within given meters distance, optional
- nearLatitude - number, a position of latitude value, cooperate with withMetersOf do query filter, optional
- nearLongitude - number, a position of longitude value, cooperate with withMetersOf do query filter, optional
note: withinMetersOf, nearLatitude and nearLongitude either all empty or all have value.
Authentication is Optional
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
bank_id: gh.29.uk
city:
closing_time: 2020-01-27
country_code: 1254
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_accessible: false
latitude: 38.8951
longitude: -77.0364
meta:
more_info: More information about this fee
name: ACCOUNT_MANAGEMENT_FEE
scheme: scheme value
Respuesta Exitosa Típica:
{
"branches":[{
"id":"branch-id-123",
"bank_id":"bank-id-123",
"name":"Branch by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"String",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":10.0,
"longitude":10.0
},
"meta":{
"license":{
"id":"ODbL-1.0",
"name":"Open Database License"
}
},
"lobby":{
"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"
}]
},
"drive_up":{
"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"
}
},
"branch_routing":{
"scheme":"OBP",
"address":"123abc"
},
"is_accessible":"true",
"accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
"branch_type":"Full service store",
"more_info":"short walk to the lake from here",
"phone_number":"+381631954907"
}]
}
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-32001: No branches available. License may not be set.
- OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.0.0,
function_name: by getBranches, operation_id: OBPv3.0.0-getBranches
Tags: Branch, Bank,