Financial Institutions

Get Financial Institutions by Role

get

http://localhost:8080https://nexus-ai-simulator-683365449922.asia-southeast1.run.app

/v1/fin-insts/{finInstRole}

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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.)

Possible values:

Responses

200

Successful response

application/json

400

Unsupported role. Reason code BE016 FI_ROLE_UNSUPPORTED.

application/json

401

Authentication failed. Applicable reason codes: AE001 AUTH_TOKEN_MISSING, AE002 AUTH_TOKEN_INVALID.

application/json

403

Authorization failed. The token is valid but its OAuth2 scopes do not grant access to this endpoint or corridor. Reason code AE004 ACCESS_DENIED.

application/json

429

Rate limit exceeded. Returned by the API gateway and carries no structured Nexus body. The Retry-After response header indicates when to retry.

500

An unhandled exception or infrastructure failure occurred. Reason code TE099 INTERNAL_ERROR. The caller may retry with exponential backoff.

application/json

get/v1/fin-insts/{finInstRole}

HTTPcURLJavaScriptPython

GET /v1/fin-insts/{finInstRole} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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"
      ]
    }
  ]
}

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

get

http://localhost:8080https://nexus-ai-simulator-683365449922.asia-southeast1.run.app

/v1/countries/{countryCode}/fin-insts/{finInstRole}

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.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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.

Possible values:

Responses

200

Successful response

application/json

400

Invalid request. Applicable reason codes: BE016 FI_ROLE_UNSUPPORTED, BE017 FI_COUNTRY_INVALID.

application/json

401

Authentication failed. Applicable reason codes: AE001 AUTH_TOKEN_MISSING, AE002 AUTH_TOKEN_INVALID.

application/json

403

Authorization failed. The token is valid but its OAuth2 scopes do not grant access to this endpoint or corridor. Reason code AE004 ACCESS_DENIED.

application/json

404

No institutions found. Reason code BE018 FI_COUNTRY_NO_INSTITUTIONS.

application/json

429

Rate limit exceeded. Returned by the API gateway and carries no structured Nexus body. The Retry-After response header indicates when to retry.

500

An unhandled exception or infrastructure failure occurred. Reason code TE099 INTERNAL_ERROR. The caller may retry with exponential backoff.

application/json

get/v1/countries/{countryCode}/fin-insts/{finInstRole}

HTTPcURLJavaScriptPython

GET /v1/countries/{countryCode}/fin-insts/{finInstRole} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "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"
    ]
  }
]

Get Financial Institution by Financial Institution ID

get

http://localhost:8080https://nexus-ai-simulator-683365449922.asia-southeast1.run.app

/v1/fin-insts/any/{finInstIdType}/{finInstId}

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

200

Successful response

application/json

400

Unsupported identifier type. Reason code BE019 FI_ID_TYPE_UNSUPPORTED.

application/json

401

Authentication failed. Applicable reason codes: AE001 AUTH_TOKEN_MISSING, AE002 AUTH_TOKEN_INVALID.

application/json

403

Authorization failed. The token is valid but its OAuth2 scopes do not grant access to this endpoint or corridor. Reason code AE004 ACCESS_DENIED.

application/json

404

No institution found for the specified financial institution ID. Reason code BE020 FI_NOT_FOUND.

application/json

429

Rate limit exceeded. Returned by the API gateway and carries no structured Nexus body. The Retry-After response header indicates when to retry.

500

An unhandled exception or infrastructure failure occurred. Reason code TE099 INTERNAL_ERROR. The caller may retry with exponential backoff.

application/json

get/v1/fin-insts/any/{finInstIdType}/{finInstId}

HTTPcURLJavaScriptPython

GET /v1/fin-insts/any/{finInstIdType}/{finInstId} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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