Register
API Explorer 936 endpoints
https://obp-api-sandbox.nmbbank.co.tz

Create Routing Scheme

POST /obp/v7.0.0/routing-schemes

OBPv7.0.0-createRoutingScheme Roles: CanCreateRoutingScheme Routing-Scheme

Register a new routing scheme.

Scheme names follow the convention <COUNTRY>.<LOCAL_SCHEME> — uppercase ISO 3166-1 alpha-2 country code, a dot, then an uppercase local scheme name (e.g. TZ.MSISDN, TZ.BILL_CONTROL_NUMBER).

Globally-unique schemes IBAN, BIC, OBP are accepted unprefixed; their country MUST be the literal INT.

Categories: ACCOUNT, BANK, BRANCH, IDENTITY, BILL, UTILITY. The category constrains which OBP fields may carry a routing of this scheme.

address_pattern is a regex used to validate addresses presented in this scheme. example_address MUST match the pattern.

Authentication is Required.

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

JSON request body fields (8)
address_pattern
address_pattern
category
country
Germany
description
Description of the object. Maximum length is 2000. It can be any characters here.
example_address
example_address
scheme
OBP
downstream_rails
downstream_rails
status
JSON response body fields (11)
address_pattern
address_pattern
category
country
Germany
created_at
created_at
created_by_user_id
description
Description of the object. Maximum length is 2000. It can be any characters here.
downstream_rails
downstream_rails
example_address
example_address
scheme
OBP
status
updated_at
updated_at
Example request body 
{
  "scheme": "TZ.MSISDN",
  "country": "TZ",
  "category": "ACCOUNT",
  "address_pattern": "^255[0-9]{9}$",
  "example_address": "255778300336",
  "description": "Tanzanian mobile number, E.164 without leading +.",
  "downstream_rails": [
    "TIPS",
    "MNO_DIRECT"
  ],
  "status": "ACTIVE"
}
Example success response 
{
  "scheme": "TZ.MSISDN",
  "country": "TZ",
  "category": "ACCOUNT",
  "address_pattern": "^255[0-9]{9}$",
  "example_address": "255778300336",
  "description": "Tanzanian mobile number, E.164 without leading +.",
  "downstream_rails": [
    "TIPS",
    "MNO_DIRECT"
  ],
  "status": "ACTIVE",
  "created_by_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "created_at": "2026-10-21T01:45:41Z",
  "updated_at": "2026-10-21T01:45:41Z"
}
Possible errors (12)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-30516: Invalid Routing Scheme name. Must match ^(?:IBAN|BIC|OBP|[A-Z]{2}(?:\.[A-Z][A-Z0-9_]*)+)$ — either an allow-listed global scheme (IBAN, BIC, OBP) or a country-qualified name like TZ.MSISDN.
  • OBP-30517: Routing Scheme country prefix does not match the country field.
  • OBP-30518: Invalid Routing Scheme category. Allowed values are: ACCOUNT, BANK, BRANCH, IDENTITY, BILL, UTILITY.
  • OBP-30519: Invalid Routing Scheme status. Allowed values are: ACTIVE, RESERVED, DEPRECATED, RETIRED.
  • OBP-30520: Invalid Routing Scheme address_pattern. The value must be a valid regular expression.
  • OBP-30521: Routing Scheme example_address does not match address_pattern.
  • OBP-30515: Routing Scheme already exists. Please specify a different value for scheme.
  • OBP-30522: Could not create Routing Scheme.
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 createRoutingScheme