v1

latestOpenAPI 3.1.02026-07-242325051.4 MB

TurnoverGroup

TurnoverGroups:List

Retrieve a simple list of all turnover groups. You can supply a merchant code to retrieve the turnovergroups for that merchant. If no merchant code is provided, the turnover groups associated with your own merchant registration will be returned.

get/v2/turnovergroups/list

Query parameters

eqstring

Get results that equal the given value

Provides filtering based on merchant code.

{
  "eq": "M-1234-4321"
}

Response

totalinteger nullable

The total items the collection contains

Example response

{
  "turnoverGroups": [
    {
      "code": "CT-1234-4321",
      "name": "E-Commerce"
    }
  ],
  "total": 10
}