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

# Clearings:Settlements

`GET /v2/clearings/settlements`

A Pay. clearing contains multiple clearing lines. This API returns the clearing grouped by settlements, including the clearing lines. 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. You can also filter on settlement code and clearing id.

## Query parameters

- `page` integer
- `limit` integer
- `merchant` object
  - `eq` string — Get results that equal the given value
- `clearingId` object
  - `eq` string — Filter on the exact clearing id.
- `settlementCode` object
  - `eq` string — Filter on the exact settlement code.
- `settlementDate` object
  - `eq` string — Filter on the exact payment date.
  - `gt` string — Filter on payment date greater than the given value.
  - `gte` string — Filter on payment date greater than or equal to the given value.
  - `lt` string — Filter on payment date less than the given value.
  - `lte` string — Filter on payment date less than or equal to 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

- ClearingSettlementsOutput — 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
  - `settlements` ClearingSettlementOutput[] — Collection of Clearing.SettlementOutput objects or an empty array
    - `code` string
    - `description` string
    - `settlementDate` string, date-time, nullable
    - `confirmationDate` string, date-time, nullable
    - `amount` 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
    - `baseAccountIban` string
    - `clearingAccount` ClearingSettlementOutputClearingAccount
      - `method` string
      - `iban` ClearingSettlementOutputClearingAccountIban
        - `iban` string
        - `bic` string, nullable
        - `owner` string
    - `clearings` ClearingSettlementOutputClearing[] — Collection of Clearing.SettlementsOutput.Clearing objects or an empty array
      - `clearingId` string
      - `clearingLines` ClearingSettlementOutputClearingClearingLine[] — Collection of Clearing.ClearingLine objects or an empty array
        - `code` string
        - `clearingDate` string, date-time
        - `settlementDate` string, date-time, nullable
        - `valueDate` string, date-time, nullable
        - `state` string
        - `turnoverGroup` ClearingTurnoverGroupOutput
          - `code` string
          - `name` string
        - `clearingLineType` ClearingPaymentProfileOutput
          - `id` integer
          - `name` string
          - `direction` 'CREDIT' | 'DEBIT'
          - `paymentType` 'SALE' | 'CHARGEBACK' | 'REFUND' | 'PAYMENT' | 'PAYOUT' | 'CLEARING' | 'DEPOSIT' | 'FUNDING' | 'WITHDRAW' | 'INVOICE' | 'REVERSAL' | 'ROLLBACK' | 'PROCESSING' | 'SERVICE' | 'TEST' | 'null', nullable
          - `collecting` boolean
        - `amount` 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
        - `merchant` ClearingMerchantOutput
          - `code` string
          - `name` string
          - `contractPackage` string, nullable
        - `transactions` integer
        - `uniquePayers` integer
  - `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)