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

Counterparties

In OBP, there are two types of Counterparty:

  • Explicit Counterparties are created by calling an OBP endpoint - mainly for the purpose of creating a payment or variable recurring payments (VRPs) via Transaction Requests.

  • Implicit Counterparties (or "Other Accounts") are generated automatically from transactions - mainly for the purpose of tagging or adding other metadata.

Counterparties always bound to a "View" on an Account. In this way, different managers of an account can use different sets of beneficiaries.

Counterparties can be thought of the other side of of a transaction i.e. the other account or other party.

Common fields in a Counterparty are:

  • id : A UUID which references it.

  • name : the human readable name (e.g. Piano teacher)

  • description : the human readable name (e.g. Piano teacher)

  • currency : account currency (e.g. EUR, GBP, USD, ...)

  • other_bank_routing_scheme : eg: 'OBP', 'BIC', 'bankCode' etc

  • other_bank_routing_address : eg: gh.29.uk - it must be a valid example of the scheme and may be validated for existance.

  • other_account_routing_scheme : eg: 'OBP', 'IBAN', 'AccountNumber' etc.

  • other_account_routing_address : eg: 1d65db7c-a7b2-4839-af41-95 - a valid example of the scheme which may be validated for existance.

The above fields describe how the backend can route payments to the counterparty.

Alternative routings might be useful as well:

  • other_account_secondary_routing_scheme : An alternative routing scheme

  • other_account_secondary_routing_address : If it is an IBAN value, it should be unique for each counterparty.

  • other_branch_routing_scheme : eg: OBP or other branch scheme

  • other_branch_routing_address : eg: `branch-id-123. Unlikely to be used in sandbox mode.

In order to send payments to a counterparty:

  • is_beneficiary : must be set to true

If the backend wants to transmit other information we can use:

  • bespoke: A list of key-value pairs can be added to the counterparty.

Note: In order to add a Counterparty to a View, the view must have the canAddCounterparty permission

Counterparties may have Limits have setup for them which constrain payments made to them through Variable Recurring Payments (VRP).