getFinancialInstitutions
getFinancialInstitutions
getFinancialInstitutions is one of the non-transaction-based operations (back-end operations) offered by QPAY Checkout Page and QMORE Checkout Seamless. This operation is used to query possible and supported financial institutions of a certain payment method. Currently this operation is used for payment method TrustPay only. Please note that the returned list of banks is limited to banks that support online transactions.
The required order of the parameter values when computing the fingerprint for QPAY Checkout Page is:
customerId
, shopId
, toolkitPassword
, secret
, command
, language
, paymentType
, transactionType
, bankCountry
.
The required order of the parameter values when computing the fingerprint for QMORE Checkout Seamless is:
customerId
, shopId
, password
, secret
, language
, paymentType
, transactionType
, bankCountry
.
Additional required request parameters
Parameter | Data type | Short description |
---|---|---|
Enumeration / list. |
Payment type to retrieve supported financial institutions. |
Additional optional request parameters
The following additional optional request parameters are used to sort the list of returned financial institutions according to bank country and/or transaction type.
Parameter | Data type | Short description |
---|---|---|
bankCountry |
Comma-separated list of customer country codes. |
List of country codes for customer countries the financial institutions is located. |
transactionType |
|
Transaction type supported by the relevant payment method for financial institutions. |
Additional response parameters
The following parameters are used in addition to the response parameters needed for all non-transaction-based operations.
Within the additional response parameters there are some parameters which will occur more than once. Therefore we use the letters {n} placeholder for digits.
Parameter | Data type | Short description |
---|---|---|
financialInstitutions |
Numeric. |
Number of containing financial institutions. |
financialInstitution.{n}.id |
Alphanumeric. |
Unique ID of a financial institution. |
financialInstitution.{n}.name |
Alphanumeric. |
Financial institution name. |
financialInstitution.{n}.country |
Alphanumeric with a fixed length of 2 characters. |
Financial institution’s country. |
financialInstitution.{n}.online |
|
Online transaction supported by the payment method for the financial institution. |
financialInstitution.{n}.offline |
|
Offline transaction supported by payment method for the financial institution. |
financialInstitution.{n}.currency |
Alphanumeric with a fixed length of 3 characters. |
Currency code of amount. |
financialInstitution
only transactionType
ONLINE must be used since otherwise the transaction will be declined by the financial service provider.