Financial Institutions

Get Financial Institutions by Role

Returns a list of financial institutions available in Nexus, for the specified role, for all countries.

GEThttp://localhost:3000/fin-insts/{finInstRole}

Path parameters

finInstRole*enum

The type of financial institution (PSPs, FXPs, SAPs). If set to any, all financial institutions in Nexus will be returned. (Results will be paged.)

pspfxpsapany

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/fin-insts/{finInstRole}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get Financial Institutions (PSPs, FXPs, SAPs or all) in a specified country

Returns a list of financial institutions (PSPs, FXPs, SAPs or all) operating in the specified country, who are connected to an IPS that is a member of Nexus. The list also includes those PSPs who are not members of Nexus. The data can be used (for example) to populate a drop-down list of PSPs (rather than requiring the Sender to enter a BIC directly). If {finInstRole} is set to any or left blank, all PSPs, FXPs and SAPs are returned.

GEThttp://localhost:3000/countries/{countryCode}/fin-insts/{finInstRole}

Path parameters

countryCode*string

The ISO 3166 alpha-2 country code

Example: "SG"

finInstRole*enum

The type of financial institution (PSPs, FXPs or SAPs). If omitted or set to any, all PSPs, FXPs and SAPS in that country will be returned.

pspfxpsapany

Response

200404

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/countries/{countryCode}/fin-insts/{finInstRole}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

404

{
  "message": "text"
}

Get Financial Institution by Financial Institution ID

Returns a Financial Institution (including PSP, FXP and SAP) based on a specified type of financial institution ID.

GEThttp://localhost:3000/fin-insts/any/{finInstIdType}/{finInstId}

Path parameters

finInstIdType*string

The type of financial institution ID (e.g., BICFI, LEI, otherId OR internalId (for Nexus's internal pspId)).

Example: "BICFI"

finInstId*string

The financial institution ID value.

Example: "DBSSSGSG"

Response

200404

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/fin-insts/any/{finInstIdType}/{finInstId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

404

{
  "message": "text"
}