Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
AuthorisationGroup

AuthorisationGroups:List

Get a list (without pagination) of all authorisation groups. If you do not supply a merchantCode we return the authorisation groups that are available under your own merchant registration. If you supply a merchantCode you need to have access to that merchant.

get/v2/authorisationgroups/list

Query parameters

eqstring

Get results that equal the given value

neqstring

Exclude results that equal the given value.

If you are a partner you can indicate for which merchants you want to retrieve the authorization groups. If you do not supply a merchant we will return all authorization groups for your merchant.

{
  "eq": "M-1234-4321",
  "neq": "M-1234-4321"
}
eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

instring

Get results that match any of the given purposes (comma-separated)

Filter on the purpose of the authorisationgroup (e.g. all groups that can be used for an authenticationToken).

{
  "eq": "account",
  "neq": "token",
  "in": "connection, token"
}

Response

The Authorisation Groups List.

totalinteger nullable

The total items the collection contains

Example response

{
  "authorisationGroups": [
    {
      "code": "AG-1234-4321",
      "name": "Webshop developer",
      "translations": {
        "name": {
          "nl_NL": "...",
          "en_GB": "..."
        }
      }
    }
  ],
  "total": 10
}