right logo image
right logo image
Log on
⯆

API Explorer

Log off

v2.0.0 (112 APIs)

API Host: https://obp-api-sandbox.nmbbank.co.tz
Bank
Accounts
Views
Counterparties
Transactions

Get Bank

Get the bank specified by BANK_ID
Returns information about a single bank specified by BANK_ID including:

  • Short and full name of bank
  • Logo URL
  • Website

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

address:

bank_routing:

full_name: full name string

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

logo: logo url

scheme: OBP

short_name:

website: www.openbankproject.com

Typical Successful Response: 

								
									
{
  "id":"gh.29.uk",
  "short_name":"short_name ",
  "full_name":"full_name",
  "logo":"logo",
  "website":"www.openbankproject.com",
  "bank_routing":{
    "scheme":"OBP",
    "address":"gh.29.uk"
  }
}
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-30001: Bank not found. Please specify a valid value for BANK_ID.
Connector Methods:
Version: OBPv1.2.1, function_name: by bankById, operation_id: OBPv1.2.1-bankById Tags: Bank, PSD2, Old-Style,

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

Possible custom url parameters for pagination:

  • limit=NUMBER ==> default value: 50
  • offset=NUMBER ==> default value: 0

eg1:?limit=100&offset=0

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

address:

atms:

city:

country: Germany

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

latitude: 38.8951

license:

line_1:

line_2:

line_3:

location:

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

state:

Typical Successful Response: 

								
									
{
  "atms":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "name":"String",
    "address":{
      "line_1":"Osloer Straße 16/17",
      "line_2":"Wedding",
      "line_3":"",
      "city":"Berlin",
      "state":"Berlin Brandenburg",
      "postcode":"13359",
      "country":"DE"
    },
    "location":{
      "latitude":11.45,
      "longitude":11.45
    },
    "meta":{
      "license":{
        "id":"ODbL-1.0",
        "name":"Open Database License"
      }
    }
  }]
}
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.
  • No ATMs available. License may not be set.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by getAtms, operation_id: OBPv1.4.0-getAtms Tags: Bank, Old-Style,

Get Bank Products

Returns information about the financial products offered by a bank specified by BANK_ID including:

  • Name
  • Code
  • Category
  • Family
  • Super Family
  • More info URL
  • Description
  • Terms and Conditions
  • License the data under this endpoint is released under
    User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

category:

code: 125

family:

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

license:

meta:

more_info_url: www.example.com/abc

name: ACCOUNT_MANAGEMENT_FEE

products:

super_family:

Typical Successful Response: 

								
									
{
  "products":[{
    "code":"String",
    "name":"String",
    "category":"String",
    "family":"String",
    "super_family":"String",
    "more_info_url":"String",
    "meta":{
      "license":{
        "id":"ODbL-1.0",
        "name":"Open Database License"
      }
    }
  }]
}
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.
  • No products available.
  • License may not be set.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by getProducts, operation_id: OBPv1.4.0-getProducts Tags: Bank, Old-Style,

Get Banks

Get banks on this API instance
Returns a list of banks supported on this server:

  • ID used as parameter in URLs
  • Short and full name of bank
  • Logo URL
  • Website

User Authentication is Optional. The User need not be logged in.

JSON response body fields:

address:

bank_routing:

banks:

full_name: full name string

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

logo: logo url

scheme: OBP

short_name:

website: www.openbankproject.com

Typical Successful Response: 

								
									
{
  "banks":[{
    "id":"gh.29.uk",
    "short_name":"short_name ",
    "full_name":"full_name",
    "logo":"logo",
    "website":"www.openbankproject.com",
    "bank_routing":{
      "scheme":"OBP",
      "address":"gh.29.uk"
    }
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by getBanks, operation_id: OBPv1.2.1-getBanks Tags: Bank, PSD2, Old-Style,

Get Transaction Types at Bank

Get Transaction Types for the bank specified by BANK_ID:

Lists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).

  • id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.
  • bank_id : The bank that supports this TransactionType
  • short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here
  • summary : A succinct summary
  • description : A longer description
  • charge : The charge to the customer for each one of these

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

charge:

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

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

short_code:

summary:

transaction_types:

value: 5987953

Typical Successful Response: 

								
									
{
  "transaction_types":[{
    "id":{
      "value":"123"
    },
    "bank_id":"gh.29.uk",
    "short_code":"PlaceholderString",
    "summary":"PlaceholderString",
    "description":"PlaceholderString",
    "charge":{
      "currency":"EUR",
      "amount":"0"
    }
  }]
}
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: OBPv2.0.0, function_name: by getTransactionTypes, operation_id: OBPv2.0.0-getTransactionTypes Tags: Bank, Account Information Service (AIS), PSD2,