API reference · Accounts & ledger

Financial Institutions

GET/fiSearch financial institutions
GET/fi/country/{countryCode}List every financial institution in a country
GET/fi/{reference}Fetch a financial institution by reference
GET/fi/{reference}/credentialsFetch a financial institution's API credentials

GET Search financial institutions

GET /fi

Searches financial institutions, optionally filtered by country, type, and status.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Query parameters

Name	Default
`country`	Optional
`type`	Optional
`status`	Optional
`page`	0
`size`	20

Example

Response: Page<FinancialInstitutionResponse>

curl -X GET "https://api.bridgemoni.com/fi?country=value&type=value&status=value&page=0&size=20" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "content": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "legalName": "Ada Obi",
        "tradingName": "Ada Obi",
        "institutionType": "COMMERCIAL_BANK",
        "countryCode": "NG",
        "financialInstitutionCode": "financial institution code",
        "alias": "Ada Obi",
        "regulatoryLicenseType": "regulatory license type",
        "swiftBic": "swift bic",
        "status": "PENDING",
        "clientId": "cli_7f3k2m9",
        "creationDateTime": "2027-03-14T14:30:01",
        "lastUpdatedDateTime": "2027-03-14T14:30:01"
      }
    ],
    "totalElements": 128,
    "totalPages": 7,
    "size": 20,
    "number": 0,
    "first": true,
    "last": false,
    "numberOfElements": 20
  },
  "description": "Search financial institutions"
}

Responses

Status	When
`200`	Financial institutions fetched successfully

GET List every financial institution in a country

GET /fi/country/{countryCode}

Returns every financial institution registered in the given country as a single list, with no paging - for populating a bank picker, where a page boundary in the middle of the alphabet is not useful. Institutions of every type and every status are included, deactivated ones among them, so a caller that only wants the ones it can transact with should filter on status or use GET /fi, which pages and filters. Ordered by legal name.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`countryCode`

Example

Response: List<FinancialInstitutionResponse>

curl -X GET "https://api.bridgemoni.com/fi/country/BRG-001" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "legalName": "Ada Obi",
      "tradingName": "Ada Obi",
      "institutionType": "COMMERCIAL_BANK",
      "countryCode": "NG",
      "financialInstitutionCode": "financial institution code",
      "alias": "Ada Obi",
      "regulatoryLicenseType": "regulatory license type",
      "swiftBic": "swift bic",
      "status": "PENDING",
      "clientId": "cli_7f3k2m9",
      "creationDateTime": "2027-03-14T14:30:01",
      "lastUpdatedDateTime": "2027-03-14T14:30:01"
    }
  ],
  "description": "List every financial institution in a country"
}

Responses

Status	When
`200`	Financial institutions fetched successfully. An empty list when the country has none - an unknown country code is not an error here, only an empty answer
`400`	The country code is not a valid ISO 3166-1 alpha-2 code

GET Fetch a financial institution by reference

GET /fi/{reference}

Fetches a financial institution by its reference.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: FinancialInstitutionResponse

curl -X GET "https://api.bridgemoni.com/fi/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "legalName": "Ada Obi",
    "tradingName": "Ada Obi",
    "institutionType": "COMMERCIAL_BANK",
    "countryCode": "NG",
    "financialInstitutionCode": "financial institution code",
    "alias": "Ada Obi",
    "regulatoryLicenseType": "regulatory license type",
    "swiftBic": "swift bic",
    "status": "PENDING",
    "clientId": "cli_7f3k2m9",
    "creationDateTime": "2027-03-14T14:30:01",
    "lastUpdatedDateTime": "2027-03-14T14:30:01"
  },
  "description": "Fetch a financial institution by reference"
}

Responses

Status	When
`200`	Financial institution fetched successfully
`404`	No financial institution exists for the given reference

GET Fetch a financial institution's API credentials

GET /fi/{reference}/credentials

Fetches the client_id/client_secret pair this financial institution uses for its own API integrations. Provisioned asynchronously right after creation - may not be available immediately.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: FinancialInstitutionCredentialsResponse

curl -X GET "https://api.bridgemoni.com/fi/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/credentials" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "financialInstitutionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "clientId": "cli_7f3k2m9",
    "clientSecret": "sk_live_REPLACE_ME"
  },
  "description": "Fetch a financial institution's API credentials"
}

Responses

Status	When
`200`	Credentials fetched successfully
`404`	No financial institution exists for the given reference, or credentials have not been provisioned yet

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors