---
title: "Clearings:Browse"
method: GET
path: "/v2/clearings"
tags: ["Clearing"]
---

# Clearings:Browse

`GET /v2/clearings`

This API returns a summary of the clearings. You can filter on a merchant code, so if you are a partner and you have right to that merchants you can retrieve the clearing information for your merchant.

## Query parameters

- `page` integer
- `limit` integer
- `merchant` object
  - `eq` string — Get results that equal the given value
- `turnoverGroup` object
  - `eq` string — Filter on the exact turnover group code.
  - `neq` string — Filter out the specified turnover group code.

## Response `200`

OK

- ClearingClearingsOutput — The PDF is not ready yet, so we return a 425 response with a message. I'm not sure if this is needed but 425 was missing from the DEFAULT_AUTHENTICATED_RESPONSES
  - `clearings` ClearingClearingOutput[] — Collection of Clearing.ClearingOutput objects or an empty array
    - `id` string
    - `period` string
    - `periodType` 'day' | 'week' | 'month'
    - `clearingDate` string, date-time
    - `status` 'OPEN' | 'FAILED' | 'PAID'
    - `merchant` ClearingMerchantOutput
      - `code` string
      - `name` string
      - `contractPackage` string, nullable
    - `turnoverGroups` ClearingTurnoverGroupOutput[]
      - `code` string
      - `name` string
    - `paymentType` object
    - `rollingReserve` AmountOutput — A monetary amount with its value in cents and currency in ISO-4217 format.
      - `value` integer — The amount value in cents
      - `currency` string — The currency in ISO-4217 format
    - `costs` AmountOutput — A monetary amount with its value in cents and currency in ISO-4217 format.
      - `value` integer — The amount value in cents
      - `currency` string — The currency in ISO-4217 format
  - `count` integer — The amount of items the collection contains
  - `pages` integer — The amount of pages available
  - `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.net/pay/apis/pay-transaction-gateway-unit-api.md) · [All operations](https://skmtc.net/pay/apis/pay-transaction-gateway-unit-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pay/pay-transaction-gateway-unit-api/revisions/2bc260c7bdfc/schema)