API Explorer 936 endpoints

Get Bank Supported Routing Schemes

GET /obp/v7.0.0/banks/BANK_ID/supported-routing-schemes

OBPv7.0.0-getBankSupportedRoutingSchemes No role required Routing-SchemeBank

Returns the subset of routing schemes the bank's adapter routes for, with optional per-bank notes (e.g. cutoff times, downstream rail caveats).

Use this to gate UI options: a transaction-request creation form should list payee-type choices based on what this bank supports, not the global registry.

Authentication is Required.

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 (4)
bank_id
gh.29.uk
scheme
OBP
supported_routing_schemes
supported_routing_schemes
bank_notes
bank_notes
Example success response
{
  "bank_id": "bank.tz",
  "supported_routing_schemes": [
    {
      "scheme": "TZ.MSISDN",
      "bank_notes": "Routed via the instant-payment rail (TIPS)."
    }
  ]
}
Possible errors (3)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 getBankSupportedRoutingSchemes