Banks v2

This endpoint filters and fetches the list of Token.io-connected banks, gets information on specific banks, and initiates authorization with user-selected banks using Payments v2.

Get banks v2

The GET /v2/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.
perPage	integer <int32> Default: 200 The number of records per page. Example: perPage=10
sort	string Default: "NAME" The key to sort the result. This can be `NAME` (Bank's name), `STANDARD` (OpenBankingStandard), `RANK`, or `COUNTRY`. Enum: "COUNTRY" "STANDARD" "RANK" "NAME" Example: sort=COUNTRY
memberId	string The Token.io-assigned member id of the TPP.
tppId	string Filters for banks for which the TPP represented by this `tppId` has access.
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.
search	string Filters for banks with a name or identifiers containing this search string. Example: search=hsbc
bankGroup	string Filters for banks that are members 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
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.
openBankingStandards	Array of strings Filters for banks that are accessed through any of the listed standards. Items Enum: "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" "Token" Example: openBankingStandards=UK_Open_Banking_Standard
countries	Array of strings Filters for banks that are located in the countries specified by this list of two-letter country code in upper case (ISO 3166-1 alpha-2).
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
supportedLocalInstruments	Array of strings Filters for banks that support any of the listed payment networks. Example: supportedLocalInstruments=SEPA&supportedLocalInstruments=SEPA_INSTANT&supportedLocalInstruments=FASTER_PAYMENTS
supportsAccountList	boolean <boolean> Filters for banks that support fetching accounts.
supportsAccountDetails	boolean <boolean> Filters for banks that support fetching account details.
supportsAccountBalance	boolean <boolean> Filters for banks that support fetching account balances.
supportsTransactionList	boolean <boolean> Filters for banks that support fetching transactions.
supportsTransactionDetails	boolean <boolean> Filters for banks that support fetching transaction details.
supportsStandingOrderList	boolean <boolean> Filters for banks that support the fetching standing orders.
supportsTransactionsDateFilter	boolean <boolean> Filters for banks that support feting transactions using a date filter.
requiresOneStepPayment	boolean <boolean> Filters for banks that only support immediate redemption of transfers.
supportsSinglePayment	boolean <boolean> Filters for banks that support single immediate payments. Example: supportsSinglePayment=true
supportsScheduledPayment	boolean <boolean> Filters for banks that support future dated scheduled payments.
supportsStandingOrder	boolean <boolean> Filters for banks that support recurring payments/standing orders.
supportsReturnRefundAccount	boolean <boolean> Filters for the banks that support request of refund account.
supportsReturnRefundAccountHolderName	boolean <boolean> Filters for banks that support returning the refund account holder name.
supportsFundsConfirmation	boolean <boolean> Filters for the banks that support confirmation of available funds.
supportsVariableRecurringPayment	boolean <boolean> Filters for banks that support variable recurring payments.

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

500

An unexpected or internal server error

501

The operation was not implemented

503

Service is unavailable

504

Gateway has timed out

get/v2/banks

Request samples

Response samples

application/json

{"banks": [{"id": "ob-modelo",
"bic": "BOFIIE2D",
"name": "GoldBank",
"logoUri": "https://example.com/path/full.png",
"bankGroup": "XYZ-Bank-Group",
"bankSubGroup": "Sub-XYZ-Bank-Group",
"countries": ["DE",
"IT"
],
"openBankingStandard": "UK_Open_Banking_Standard",
"initialEmbeddedAuthFields": {"type": "FIELD",
"id": "67891234",
"displayName": "Password:",
"additionalInformation": "This field is required.",
"options": ["string"
]
},
"mandatoryFields": [{"products": ["SIP"
],
"fieldPaths": ["initiation.debtor"
],
"paymentTypes": ["International"
],
"localInstruments": ["SEPA"
]
}
],
"maintenanceWindow": [{"startTime": "2023-05-03T12:28:20.466Z",
"endTime": "2023-05-03T12:40:25.47Z",
"type": "OUTAGE",
"productType": "SIP"
}
],
"fieldsFormatInformation": [{"constraint": "^[A-Za-z0-9?:()./,'+\\-\\s]*$",
"name": "description",
"path": "credentials.credentials1"
}
],
"supportedLocalInstruments": ["SEPA",
"SEPA_INSTANT",
"FASTER_PAYMENTS"
],
"operationalTime": "MON to FRI, 00:00 to 24:00 GMT+1",
"transactionHistoryLimit": 65,
"supportsAccountList": true,
"supportsAccountDetails": true,
"supportsAccountBalance": true,
"supportsTransactionList": true,
"supportsTransactionDetails": true,
"supportsStandingOrderList": true,
"supportsTransactionsDateFilter": true,
"requiresOneStepPayment": true,
"supportsSinglePayment": true,
"supportsScheduledPayment": true,
"supportsSendPayment": false,
"supportsReceivePayment": false,
"supportsStandingOrder": true,
"supportsReturnRefundAccount": true,
"supportsFundsConfirmation": true,
"supportsVariableRecurringPayment": true
}
],
"paging": {"page": 15,
"pageCount": 80,
"perPage": 32,
"totalCount": 2500
},
"rank": [1,
2,
100
],
"bankSubGroup": ["CMM Grand",
"Banque Populaire",
"La Banque"
]
}

➔ Next to Sub-TPPs