Financial Institutions

Get Financial Institutions by Role

get

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

Path parameters

finInstRolestring · enumrequired

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

Options: psp, fxp, sap, any

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://localhost:3000/fin-insts/{finInstRole}'

200

200

{
  "finInsts": [
    {
      "name": "DBS Bank Ltd",
      "finInstId": {
        "BICFI": [
          "DBSSSGSG"
        ],
        "LEI": "ATUEL7OJR5057F2PV266",
        "otherId": []
      },
      "countryCode": "SG",
      "roles": [
        "psp",
        "fxp"
      ]
    },
    {
      "name": "United Overseas Bank Limited",
      "finInstId": {
        "BICFI": [
          "UOBVSGS"
        ],
        "LEI": "AR3L4Z0XCMCQS27SE236",
        "otherId": []
      },
      "countryCode": "SG",
      "roles": [
        "psp"
      ]
    },
    {
      "name": "Bank Central Asia",
      "finInstId": {
        "BICFI": [
          "BBBUIDJA"
        ],
        "LEI": null,
        "otherId": null
      },
      "countryCode": "ID",
      "roles": [
        "psp",
        "sap"
      ]
    },
    {
      "name": "Bank of the Philippine Islands",
      "finInstId": {
        "BICFI": [
          "BOPIPHMM"
        ],
        "LEI": null,
        "otherId": null
      },
      "countryCode": "PH",
      "roles": [
        "psp"
      ]
    },
    {
      "name": "Kasikornbank Public Company Limited",
      "finInstId": {
        "BICFI": [
          "KASITHBK"
        ],
        "LEI": null,
        "otherId": null
      },
      "countryCode": "TH",
      "roles": [
        "psp",
        "fxp",
        "sap"
      ]
    },
    {
      "name": "FXP-A",
      "finInstId": {
        "BICFI": [
          "STNXGBAA"
        ],
        "LEI": null,
        "otherId": null
      },
      "countryCode": "TH",
      "roles": [
        "fxp"
      ]
    }
  ]
}

Successful response

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

get

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.

Path parameters

countryCodestringrequired

The ISO 3166 alpha-2 country code

Example: SG

finInstRolestring · enumrequired

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.

Options: psp, fxp, sap, any

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://localhost:3000/countries/{countryCode}/fin-insts/{finInstRole}'

200

404

200

[
  {
    "name": "DBS Bank Ltd",
    "finInstId": {
      "BICFI": [
        "DBSSSGSG"
      ],
      "LEI": "ATUEL7OJR5057F2PV266",
      "otherId": []
    },
    "countryCode": "SG",
    "roles": [
      "psp",
      "sap"
    ]
  },
  {
    "name": "United Overseas Bank Limited",
    "finInstId": {
      "BICFI": [
        "UOBVSGS"
      ],
      "LEI": "AR3L4Z0XCMCQS27SE236",
      "otherId": []
    },
    "countryCode": "SG",
    "roles": [
      "psp"
    ]
  }
]

Successful response

Get Financial Institution by Financial Institution ID

get

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

Path parameters

finInstIdTypestringrequired

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

Example: BICFI

finInstIdstringrequired

The financial institution ID value.

Example: DBSSSGSG

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://localhost:3000/fin-insts/any/{finInstIdType}/{finInstId}'

200

404

200

{
  "name": "DBS Bank Ltd",
  "finInstId": {
    "BICFI": [
      "DBSSSGSG"
    ],
    "LEI": "ATUEL7OJR5057F2PV266",
    "otherId": []
  },
  "countryCode": "SG",
  "roles": [
    "psp",
    "sap"
  ]
}

Successful response