v1

latestOpenAPI 3.0.32026-07-248079274.0 KB

Pay by Bank

Get a list of support banks

If you would like to create your own UI for account selection this can be used to retrieve a list of banks Acquired.com currently support. This includes names, logos and support services.

get/aspsps

Query parameters

offsetinteger

The record to start the response on.

limitinteger

A limit on the scope of values returned in the response.

filterstring

Filter the parameters that you want to return within the response.

auth_type'redirect'

The type of authentication flow supported by the ASPSP.

bicstring

Example:ABCGBXXX

Search the ASPSP list by the Bank Identifier Code to limit the results.

currency'aed' | 'aud' | 'cad' | 'chf' | 'cny' | 'dkk' | 'eur' | 'gbp' | 'hkd' | 'jpy' | 'mxn' | 'sek' | 'usd' | 'zar'

Example:gbp

Filter by the required currency.

countrystring

Example:gb

Filter the list of ASPSPs that support your required country.

schemestring

Example:faster_payment

Filter the list of ASPSPs that support your required payment scheme.

Headers

Company-Idstring uuid

Unique ID assigned by Acquired.com for your company.

Response

List of available ASPSPs.

Example response

{
  "meta": {
    "links": [
      {
        "rel": "first",
        "href": "/v1/path?offset=0",
        "title": "first page"
      }
    ]
  },
  "data": [
    {
      "logo_url": "https://images.acquired.com/aspsps/logos/example_bank.svg",
      "icon_url": "https://images.acquired.com/aspsps/icons/example_bank.svg",
      "display_name": "OB Example Bank",
      "auth_type": "redirect",
      "country": "gb",
      "bic_code": "ABCGBXXX",
      "devisions": [
        "retail"
      ],
      "supported_currencies": [
        "gbp"
      ],
      "supported_services": [
        "single_immediate_payment"
      ],
      "supported_formats": [
        "sort_code_account_number"
      ],
      "supported_schemes": [
        "faster_payment"
      ]
    }
  ]
}