---
title: "Clearing:AllLines"
method: GET
path: "/clearinglines"
tags: ["Merchants"]
---

# Clearing:AllLines

`GET /clearinglines`

A Pay. clearing contains multiple clearing lines. This API returns all clearing lines for a specified period. If you are a partner and you have rights to your merchants you can retrieve the clearing lines also for your merchants

## Query parameters

- `limit` integer
- `page` integer
- `date` object
  - `eq` string, date — Get results that equal the given value
  - `gt` string, date — Get results that are greater than the given value
  - `gte` string, date — Get results that are greater than or equal to the given value
  - `lt` string, date — Get results that are less than the given value
  - `lte` string, date — Get results that are less than or equal to the given value
- `processedDate` object
  - `eq` string, date — Get results that equal the given value
  - `gt` string, date — Get results that are greater than the given value
  - `gte` string, date — Get results that are greater than or equal to the given value
  - `lt` string, date — Get results that are less than the given value
  - `lte` string, date — Get results that are less than or equal to the given value
- `merchant` object
  - `eq` string — Get results that equal the given value
  - `neq` string — Get results that do not equal the given value
- `clearingLineType` object
  - `eq` integer — Get results that equal the given value
- `turnoverGroup` object
  - `eq` integer — Get results that equal the given value
- `state` object
  - `eq` integer — Get results that equal the given value
- `clearingID` object
  - `eq` integer — Get results that equal the given value

## Response `200`

Ok.

- object
  - `total` integer, required
  - `count` integer, required
  - `clearingLines` ClearingLine[], required
    - `code` string, required
    - `merchant` object, required
      - `code` Code, required — unresolved $ref
      - `contractPackage` string, required
    - `turnoverGroup` object, nullable, required
      - `code` string, required
      - `name` string, required
    - `clearingLineType` object, nullable, required
      - `id` integer, required
      - `name` string, required
    - `unitType` object, nullable, required
      - `id` integer, required
      - `name` string, required
    - `amount` Amount, required
      - `value` integer, required — The amount in cents.
      - `currency` string — The currency in ISO-4217 format.
    - `valueDate` string, date, nullable, required
    - `clearingDate` string, date, nullable, required
    - `settlementDate` string, date, nullable, required
    - `processedDate` string, date, nullable, required
    - `state` 'PROCESSED' | 'CLEARED' | 'SETTLED', required
    - `clearingID` string, nullable, required
  - `_links` object, required
    - `first` object
      - `href` Href — unresolved $ref
    - `previous` object
      - `href` Href — unresolved $ref
    - `next` object
      - `href` Href — unresolved $ref
    - `last` object
      - `href` Href — unresolved $ref
    - `self` object
      - `href` Href — unresolved $ref
      - `rel` Rel — unresolved $ref
      - `type` Type — unresolved $ref

## Other responses

- `401` — Unauthorized. Supplied credentials are invalid
- `403` — Forbidden. Supplied credentials have no rights
- `405` — Used HTTP method is not allowed
- `406` — Not acceptable. The supplied content type in the accept parameter in the header is not supported
- `429` — Rate limit reached.
- `500` — An internal error occurred

---

[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)