GET /service/providers

List of providers

Lists all providers (i.e. banks). Providers can be filtered by country, access scope or id. In order to limit the response to a reasonable amount of entries at least a country or id filter must be given. If desired, providers can be enabled/disabled in administration integration menu.

Query Parameters

country CountryCode[]
One or more country code(s) to filter payment providers by.
Example: [DE, AT]
scope TenantService[]
Possible values: [account_owner, account_info, account_transactions, payments, risk_scoring]
Access scope(s) to filter payment providers by
Example: [payments, account_info]
id ProviderId[]

One or more IDs to filter payment providers by. Provider IDs are case-sensitive.

locale Locale

Desired language of payment provider names (if translated). For specific countries where multiple languages are spoken the provider name might be translated, otherwise the default name is returned.

Responses

• 200
• 401

---

Found payment provider

application/json

Schema

Example (from schema)

---

Schema

• Array [
id ProviderId

Unique payment provider (bank) id

name string

Payment provider / bank official name (returned in selected local language if available)

status ProviderStatus

Possible values: [active, disabled]

List of statuses a payment provider can have: active - disabled.

iconUrl string

Provider logo image in 320x320px format. Logo images are available in two formats 160x160 and 320x320 pixels. By default the 320x320 icon is returned. The 160x160 version can be retrieved by replacing the /w320 asset folder with /w160. For instance: https://assets.fliqa.io/images/providers/w320/at/generali.png -> https://assets.fliqa.io/images/providers/w160/at/generali.png

country CountryCode

Provider country code (ISO 3166 alpha-2 codes)

scopes TenantService[]

Possible values: [account_owner, account_info, account_transactions, payments, risk_scoring]

List of payment and account services, provider is supporting.

bic string

SWIFT BIC code if available.

• ]

[
  {
    "id": "string",
    "name": "Generali Bank AG",
    "status": "active",
    "iconUrl": "https://assets.fliqa.io/images/providers/w320/at/generali.png",
    "country": "AT",
    "scopes": [
      "payments",
      "accountInfo"
    ],
    "bic": "BGENATWW"
  }
]

Unauthorized

application/json

Schema

Example (from schema)

Example

---

Schema

errorMessage string required

Description of error

errorCode ErrorCode required

Possible values: [invalid_parameter, unauthorized, forbidden, not_found, not_allowed, bad_request, other]

Error code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}

errorSubCode ErrorSubCode

Possible values: [api_key_secret_header_must_be_provided, authorization_header_must_be_provided, access_not_allowed, domain_not_allowed, access_token_expired, invalid_access_scope, not_authorized, phone_or_email_not_registered, phone_number_start_with_plus_and_country, phone_number_invalid, email_invalid, email_or_phone_number_required, invalid_pin, could_not_interpret_numbers_after_plus, supplied_string_not_phone_number, string_supplied_too_short_to_be_phone_number, string_supplied_too_long_to_be_phone_number, string_supplied_was_too_long_to_parse, unspecified]

Error sub code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}#{errorSubCode}

documentationUrl uri

Link to documentation if available, typically https://documentation.fliqa.io/api/errors/{errorCode}

requestId RequestId

Unique request id

resourceId ResourceId

Unique resource id

{
  "errorMessage": "string",
  "errorCode": "unauthorized",
  "errorSubCode": "phone_or_email_not_registered",
  "documentationUrl": "string",
  "requestId": "554099e7d0b648d7b96bc31c148425b8",
  "resourceId": "9c14c6f2f0ee4a54a280be3c18ec1dba"
}

{
  "errorCode": "unauthorized",
  "errorMessage": "Not authorized",
  "documentationUrl": "https://documentation.fliqa.io/api/errors/unauthorized"
}

Loading...