---
title: "TurnoverGroups:Browse"
method: GET
path: "/v2/turnovergroups"
tags: ["TurnoverGroup"]
---

# TurnoverGroups:Browse

`GET /v2/turnovergroups`

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

## Query parameters

- `page` integer
- `merchant` object
  - `eq` string — Get results that equal the given value

## Response `200`

OK

- TurnoverGroupTurnoverGroupsOutput — A collection of turnover groups linked to a merchant.
  - `turnoverGroups` TurnoverGroupTurnoverGroupOutput[] — Collection of TurnoverGroup objects
    - `code` string — The CT-code for a turn over group.
    - `name` string — The name of the turnover group
    - `default` boolean — Is this the default turnover group?
    - `description` string, nullable — The description of the turnover group
    - `paymentDescription` string, nullable — The payment description of the turnover group. This will be displayed on your clearing records.
    - `merchant` TurnoverGroupTurnoverGroupOutputMerchant — The merchant linked to a turnover group.
      - `code` string — The merchant code (M) to which this object belongs
      - `name` string — The merchant name to which this object belongs
      - `status` string — The merchant status to which this object belongs
    - `bankAccount` TurnoverGroupTurnoverGroupOutputBankAccount — The bank account linked to a turnover group.
      - `code` string — The code of the bank account
      - `method` string — The method of the bank account
      - `iban` TurnoverGroupTurnoverGroupOutputBankAccountIban — The IBAN details of a bank account.
        - `iban` string — The IBAN of the bank account
        - `bic` string, nullable — The BIC of the bank account
        - `owner` string — The account holder of the bank account
      - `status` 'waiting' | 'checking' | 'rejected' | 'approved' | 'unknown' — The code of the bank account
    - `createdAt` string, date-time, nullable — The date and time at which this entity was created in ISO-8601 (ATOM) notation
    - `createdBy` string, nullable — The reference to an account or token whom created the entity
    - `modifiedAt` string, date-time, nullable — The date and time at which this entity was modified in ISO-8601 (ATOM) notation.
    - `modifiedBy` string, nullable — The reference to an account or token whom modified this entity
    - `deletedAt` string, date-time, nullable — The date and time at which this entity was deleted in ISO-8601 (ATOM) notation.
    - `deletedBy` string, nullable — The reference to an account or token whom deleted the entity
  - `total` integer, nullable — The total items the collection contains
  - `_links` LinkOutput[], nullable
    - `href` string, nullable — The URI to the linked resource
    - `rel` string, nullable — The name of the linked resource
    - `type` string, nullable — The (http(s)) method needed to approach the linked resource

## Other responses

- `400` — Bad request, see response body for more information
- `401` — Unauthorized. Supplied credentials are invalid
- `403` — Forbidden. Supplied credentials have no rights
- `404` — Resource not found
- `405` — Used HTTP method is not allowed
- `406` — Not acceptable. The supplied content type in the accept parameter in the header is not supported
- `410` — Indicates that this resource is no longer available for use
- `415` — Unsupported media. The supplied content type in the content-type parameter in the header is not supported
- `429` — Rate limit reached.
- `500` — An internal error occurred.
- `503` — The server is currently unable to handle your request

---

[API](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api.md) · [All operations](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pay/pay-transaction-gateway-unit-api/revisions/2bc260c7bdfc/schema)