Banks v1

These endpoints filter and fetch the list of Token.io-connected banks, get information on specific banks, and initiate authorization with user-selected banks.

Get banks v1

The GET /banks endpoint retrieves a list of Token.io-integrated banks matching the parameters specified.

SecurityBearer or BasicAuth

Request

query Parameters

page	integer <int32> The index of the page currently being retrieved. Example: page=1
perPage	integer <int32> The number of records per page. Example: perPage=175
sort	string Default: "name" The key to sort the result. This can be `name` (i.e., bank name), `provider`, or `country`. Example: sort=country
memberId	string The Token.io-assigned member id of the TPP. Example: memberId=m:nP4w3u5y8ddrxDJkjimgSX9e4fZ:5zKtXEAq
ids	Array of strings Filters for banks with a `bankId` (case-insensitive) matching any of the ids listed, up to a maximum of 1000. Only exact (full string) matches are returned. Example: ids=goldbank&ids=opalbank&ids=platinumbank
search	string Filters for banks with a name or identifiers containing this search string. Example: search=hsbc
tppId	string Filters for banks for which the TPP represented by this `tppId` has access. Example: tppId=4h27g823-g73s-07v3-l49s-prte94bf21v
providers	Array of strings Filters for banks that are accessed through any of the listed providers. Example: providers=Token.io
bankCode	string Filters for banks with a BIC (or BLZ, if German) that matches this `bankCode`. The BIC must have a string length of 8 or 11. The BLZ must have a string length of 8. Example: bankCode=NBAGDE3E
countries	Array of strings Filters for banks that are located in the countries specified by this list of two-letter country codes in upper case (ISO 3166-1 alpha-2). Example: countries=IT&countries=DE&countries=RO
bank_features.supports_send_payment.value	boolean <boolean> Default: false Filters for banks that support payment initiation. Example: bank_features.supports_send_payment.value=false
bank_features.supports_receive_payment.value	boolean <boolean> Default: false Filters for banks that support receiving payments. Example: bank_features.supports_receive_payment.value=false
bank_features.supports_balance.value	boolean <boolean> Default: false Filters for the banks that support retrieving balances. Example: bank_features.supports_balance.value=false
bank_features.supports_scheduled_payment.value	boolean <boolean> Default: false Filters for banks that support future dated scheduled payments. Example: bank_features.supports_scheduled_payment.value=false
bank_features.supports_standing_order.value	boolean <boolean> Default: false Filters for banks that support recurring payments/standing orders. Example: bank_features.supports_standing_order.value=false
bank_features.requires_one_step_payment.value	boolean <boolean> Default: false Filters for banks that only support immediate redemption of transfers. Example: bank_features.requires_one_step_payment.value=false
bank_features.supports_funds_confirmation.value	boolean <boolean> Default: false Filters for the banks that support confirmation of available funds. Example: bank_features.supports_funds_confirmation.value=false
bank_features.supports_return_refund_account.value	boolean <boolean> Default: false Filters for the banks that support request of refund account. Example: bank_features.supports_return_refund_account.value=false
bank_features.supports_transactions_date_filter.value	boolean <boolean> Default: false Filters for banks that support retrieving transactions by date filter. Example: bank_features.supports_transactions_date_filter.value=false
bank_features.supports_account_information.value	boolean <boolean> Default: false Filters for banks that support retrieval of account information. Example: bank_features.supports_account_information.value=false
bank_features.supports_single_payment.value	boolean <boolean> Default: false Filters for banks that support single immediate payments. Example: bank_features.supports_single_payment.value=false
bank_features.supports_variable_recurring_payment.value	boolean <boolean> Default: false Filters for banks that support variable recurring payments. Example: bank_features.supports_variable_recurring_payment.value=false
bics	Array of strings Filters for banks whose BIC matches any of the listed BICs (case-insensitive), up to a maximum of 1000. Example: bics=BKENGB2L, BNPAFRPH, NBAGDE3E
supportedPaymentNetworks	Array of strings Filters for banks that support any of the listed payment networks.
bankGroup	string Filters for banks that are part of the bank group specified. Example: bankGroup=HSBC&bankGroup=Coop
bankSubGroup	string Filters for banks that are part of the bank sub-group specified. Example: bankSubGroup=CMM Grand&bankSubGroup=Banque Populaire&bankSubGroup=La Banque

Responses

200

Successful response

400

The client specified an invalid argument

401

The authorization information is missing or invalid

403

Permission to access this endpoint is denied

404

The requested entity, such as a payment, was not found

429

Too many requests

500

An unexpected or internal server error

501

The operation was not implemented

503

Service is unavailable

504

Gateway has timed out

get/banks

Request samples

Response samples

application/json

{"banks": [{"bankGroup": "XYZ-Bank-Group",
"bic": "BOFIIE2D",
"countries": ["DE",
"IT",
"GB"
],
"credentialFields": {"fields": [{"description": "User authentication",
"displayName": "Client ID",
"flickerCode": "FLICKERCODE",
"id": "clientId",
"image": "YWJAeXoyWhAeXohteQ",
"options": ["SMS",
"Phone call"
],
"type": "PASSWORD"
}
]
},
"fieldsFormatInformation": [{"constraint": "^[A-Za-z0-9?:()./,'+\\-\\s]*$",
"name": "description",
"path": "credentials.credentials1"
}
],
"fullLogoUri": "https://s3-us-west-2.amazonaws.com/tokenio-assets/1.0.0/logos/gold/gold_full.png",
"id": "ob-modelo",
"identifier": "BLZ",
"logoUri": "https://s3-us-west-2.amazonaws.com/tokenio-assets/1.0.0/logos/gold/gold_square.png",
"mandatoryFields": {"access": {"domestic": {"fields": ["access_body.instructions.access_destinations.customer_data.legal_names",
"access_body.instructions.source.bic",
"access_body.instructions.source.account_identifier"
],
"PolishApiFields": "access_body.instructions.metadata.provider_access_metadata.polish_api_access_metadata.delivery_mode",
"StetFields": "access_body.instructions.metadata.provider_access_metadata.stet_access_metadata.beneficiary.creditor_agent"
},
"international": {"fields": ["access_body.instructions.access_destinations.customer_data.legal_names",
"access_body.instructions.source.bic",
"access_body.instructions.source.account_identifier"
],
"PolishApiFields": "access_body.instructions.metadata.provider_access_metadata.polish_api_access_metadata.delivery_mode",
"StetFields": "access_body.instructions.metadata.provider_access_metadata.stet_access_metadata.beneficiary.creditor_agent"
}
},
"standingOrder": {"domestic": {"fields": ["standing_order_body.instructions.transfer_destinations.customer_data.legal_names",
"standing_order_body.instructions.source.bic",
"standing_order_body.instructions.source.account_identifier"
],
"PolishApiFields": "standing_order_body.instructions.metadata.provider_transfer_metadata.polish_api_transfer_metadata.delivery_mode",
"StetFields": "standing_order_body.instructions.metadata.provider_transfer_metadata.stet_transfer_metadata.beneficiary.creditor_agent"
},
"international": {"fields": ["standing_order_body.instructions.transfer_destinations.customer_data.legal_names",
"standing_order_body.instructions.source.bic",
"standing_order_body.instructions.source.account_identifier"
],
"PolishApiFields": "standing_order_body.instructions.metadata.provider_transfer_metadata.polish_api_transfer_metadata.delivery_mode",
"StetFields": "standing_order_body.instructions.metadata.provider_transfer_metadata.polish_api_transfer_metadata.delivery_mode"
}
},
"transfer": {"domestic": {"fields": ["transfer_body.instructions.transfer_destinations.customer_data.legal_names",
"transfer_body.instructions.source.bic",
"transfer_body.instructions.source.account_identifier"
],
"PolishApiFields": "transfer_body.instructions.metadata.provider_transfer_metadata.polish_api_transfer_metadata.delivery_mode",
"StetFields": "transfer_body.instructions.metadata.provider_transfer_metadata.stet_transfer_metadata.beneficiary.creditor_agent"
},
"international": {"fields": ["transfer_body.instructions.transfer_destinations.customer_data.legal_names",
"transfer_body.instructions.source.bic",
"transfer_body.instructions.source.account_identifier"
],
"PolishApiFields": "transfer_body.instructions.metadata.provider_transfer_metadata.polish_api_transfer_metadata.delivery_mode",
"StetFields": "transfer_body.instructions.metadata.provider_transfer_metadata.stet_transfer_metadata.beneficiary.creditor_agent"
}
}
},
"maintenanceWindow": [{"startTime": "2023-05-03T12:28:20.466Z",
"endTime": "2023-05-03T12:40:25.47Z",
"type": "OUTAGE",
"productType": "SIP"
}
],
"name": "Gold Bank",
"openBankingStandard": "UK_Open_Banking_Standard",
"operationalTime": "MON to FRI, 00:00 to 24:00 GMT+1",
"provider": "Token.io",
"requiresExternalAuth": false,
"requiresOneStepPayment": false,
"supportedTransferDestinationTypes": ["SWIFT",
"FASTER_PAYMENTS",
"SEPA"
],
"supportsBalance": false,
"supportsFundsConfirmation": false,
"supportsAccountInformation": false,
"supportsReceivePayment": false,
"supportsReturnRefundAccount": false,
"supportsScheduledPayment": false,
"supportsSendPayment": false,
"supportsStandingOrder": false,
"supportsTransactionsDateFilter": false,
"supportsSinglePayment": false,
"supportsVariableRecurringPayment": false,
"transactionHistoryLimit": 65
}
],
"paging": {"page": 15,
"pageCount": 80,
"perPage": 32,
"totalCount": 2500
},
"rank": [1,
2,
100
],
"bankSubGroup": ["CMM Grand",
"Banque Populaire",
"La Banque"
]
}

Get bank countries

The GET /banks/countries endpoint retrieves the list of countries that have Token.io-integrated banks which match the parameters specified.