--- title: "Get banks v2" method: GET path: "/v2/banks" tags: ["Banks v2"] --- # Get banks v2 `GET /v2/banks` The `GET /v2/banks` endpoint retrieves a list of connected banks matching the parameters specified. ## Query parameters - `page` integer - `perPage` integer - `sort` 'COUNTRY' | 'STANDARD' | 'RANK' | 'NAME' - `memberId` string - `tppId` string - `ids` string[] - `search` string - `bankGroup` string - `bankSubGroup` string - `bankCode` string - `openBankingStandards` string[] - `countries` string[] - `bics` string[] - `supportedLocalInstruments` string[] - `supportsAccountList` boolean - `supportsAccountDetails` boolean - `supportsAccountBalance` boolean - `supportsTransactionList` boolean - `supportsTransactionDetails` boolean - `supportsStandingOrderList` boolean - `supportsTransactionsDateFilter` boolean - `requiresOneStepPayment` boolean - `supportsSinglePayment` boolean - `supportsScheduledPayment` boolean - `supportsStandingOrder` boolean - `supportsReturnRefundAccount` boolean - `supportsReturnRefundAccountHolderName` boolean - `supportsFundsConfirmation` boolean - `supportsVariableRecurringPayment` boolean ## Response `200` Successful response - GetBanksV2Response - `banks` BankV2[] — This field contains information for each bank matching the request criteria. - `id` string — The Token.io bank identifier. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long." - `name` string — The commonly recognised name of the bank. - `logoUri` string — The URI of the location of the square bank avatar icon. - `bankGroup` string — The name of the banking group in which this bank holds membership. - `bankSubGroup` string — The name of the sub-banking group in which this bank holds membership. - `countries` string[] — A list of two-letter country code in upper case (ISO 3166-1 alpha-2), in which this bank operates. - `openBankingStandard` 'Invalid_Standard' | 'UK_Open_Banking_Standard' | 'Starling_Bank_API' | 'PolishApi' | 'STET_PSD2_API' | 'Citi_Handlowy_PSD2_API' | 'NextGenPsd2' | 'Slovak_Banking_API_Standard' | 'Czech_Open_Banking_Standard' | 'American_Express_PSD2_API' | 'Budapest_Bank_API' — Specifies the API standard adopted by the bank. - `initialEmbeddedAuthFields` RequiredField — Contains information used in embedded authentication flows. These are optional credential request fields. - `type` 'FIELD' | 'PASSWORD' | 'CHOICE_FIELD', required — The `type` determines how the field is presented to the user. - `id` string, required — The ID used when passing the value of this field to Token.io. - `displayName` string, required — The name of the requested field displayed to the user. - `additionalInformation` string — Additional information about this field. - `options` string[] — A list of options for the user to select from. For example, it can be an SCA method choice (SMS message, phone call etc.), or confirm/decline options for a confirmation page. The customer sends one of the values back to Token.io with the corresponding id. - `mandatoryFields` MandatoryFieldsv2Inner[] — Contains the fields required by the bank, which the TPP must populate in the token request, where applicable. - `products` string[] — The products this mandatory fields entry applies to. - `fieldPaths` string[] — The paths to the mandatory fields for this entry. - `paymentTypes` string[] — The types of payments (International/Domestic) this mandatory fields entry applies to. - `localInstruments` string[] — The local instruments this mandatory fields entry applies to. - `maintenanceWindow` Maintenance[] — Details of the bank's planned or unplanned maintenance window. - `startTime` string — The start time of the maintenance window (in ISO 8601 format). - `endTime` string — The end time of the maintenance window (in ISO 8601 format). - `type` 'INVALID' | 'NO_DOWNTIME_EXPECTED' | 'DOWNTIME_EXPECTED' | 'OUTAGE' — The bank status: - `productType` 'INVALID' | 'AIS' | 'SIP' — The bank product: - `scaMethods` ScaMethods[] - `fieldsFormatInformation` FieldsFormatInformation[] — Contains bank-dependent formatting constraints indicating allowable characters, if any. - `constraint` string — The regex specifying allowed characters. See https://regexr.com/3cr6fhttps://regexr.com/3cr6f for more details. - `v2Name` string — The name of the field in the Token.io `requestpayload` with bank-imposed formatting constraints. - `v2Path` string — The `object.field` path indicating the constrained field's position in the Token.io `requestPayload`. - `supportedLocalInstruments` string[] — Payment methods/rails supported by the bank. - `operationalTime` string — Specifies the bank’s days and hours of operation in a normal week. Does not take into account bank-specific public holidays, which may or may not be considered out-of-operation time. - `transactionHistoryLimit` integer — Defines the number of transaction history records allowed per page, -1 (unlimited) or a positive integer (record limit). - `supportsAccountList` boolean — The bank connection supports fetching accounts. - `supportsAccountDetails` boolean — The bank connection supports fetching account details. - `supportsAccountBalance` boolean — The bank connection supports fetching account balances. - `supportsTransactionList` boolean — The bank connection supports fetching transactions. - `supportsTransactionDetails` boolean — The bank connection supports fetching transaction details. - `supportsStandingOrderList` boolean — The bank connection supports the fetching standing orders. - `supportsTransactionsDateFilter` boolean — The bank connection supports feting transactions using a date filter. - `requiresOneStepPayment` boolean — The bank connection only supports immediate redemption of transfers. - `supportsSinglePayment` boolean — The bank connection supports single immediate payments. - `supportsScheduledPayment` boolean — The bank connection supports future dated scheduled payments. - `supportsSendPayment` boolean — The bank connection supports payment initiation. - `supportsReceivePayment` boolean — The bank connection supports the receipt of payments. - `supportsStandingOrder` boolean — The bank connection supports recurring payments/standing orders. - `supportsReturnRefundAccount` boolean — The bank connection supports requesting of refund accounts. - `supportsFundsConfirmation` boolean — The bank connection supports confirmation of available funds. - `supportsVariableRecurringPayment` boolean — The bank connection supports variable recurring payments. - `paging` Paging — Contains the page information for response content. - `page` integer — The index of the current page. - `pageCount` integer — The number of records per page. - `perPage` integer — The number of total pages. - `totalCount` integer — The number of total records. - `rank` integer — Sorts banks by rank. - `bankSubGroup` string — Filters for banks that are part of the bank sub-group specified. ## Other responses - `400` — The client specified an invalid argument - `403` — Permission to access this endpoint is denied - `500` — An unexpected or internal server error - `501` — The operation was not implemented - `503` — Service is unavailable - `504` — Gateway has timed out --- [API](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps.md) · [All operations](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/token/token-io-s-open-banking-api-for-tpps/versions/5e8d6d2c24a1/schema)