API response body

{
  "institutions": [
    {
      "institution_id": "cashnow",
      "display_name": "CashNow - Personal Loan & Instant Loan",
      "account_types": [
        "loan"
      ],
      "account_ids": [
        "default"
      ],
      "currency": "KES"
    },
    {
      "institution_id": "mpesa",
      "display_name": "M-Pesa",
      "account_types": [
        "depository"
      ],
      "account_ids": [
        "default"
      ],
      "currency": "KES"
    },
    {
      "institution_id": "okash",
      "display_name": "OKash",
      "account_types": [
        "loan"
      ],
      "account_ids": [
        "default"
      ],
      "currency": "KES"
    }
  ]
}

Fields

institution[].institution_id

The unique identifier for the institution with which the user has an account.

institution[].account_types[]

A list of all the account types known to be associated with the institution.

institution[].account_ids[]

A list of all the account ids known to be associated with the institution for the given user_uuid. It is possible that a user has multiple accounts (e.g. a savings and a checking), in which case Pngme attempts to extract the distinct account_id of each account.

Read more about Account Types.

The presence of a field here does not guarantee that the specific user has an account of this type open with the institution.
Rather, this is a master lookup reference of account types known to be associated with the institution, and for which Pngme can generally extract data.

See the Balance records and Transaction records.

institutions[].display_name

An intelligible name for the institution.

institutions[].currency

Currency is tricky! This default currency field is extracted as the most common currency observed among all transactions of a given account.

Pngme attempts to extract a currency field for each and every balance and transaction record. Not all balance and transaction records, however, have an extractable currency field. In these cases, it is helpful to use this default.