---
title: "Clearings:Records"
method: GET
path: "/v2/clearings/{identifier}/records"
tags: ["Clearing"]
---

# Clearings:Records

`GET /v2/clearings/{identifier}/records`

Retrieve the transactions that are in a clearing. You can filter on the clearing ID or the settlement code. Note that you need to have access to the merchant to retrieve the transactions if you request the transactions for a clearing ID or settlement code from one of your sub-merchants.

## Path parameters

- `identifier` string, required

## Query parameters

- `page` integer
- `limit` integer

## Response `200`

OK

- ClearingClearingRecordsOutput — 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
  - `clearingRecords` ClearingClearingRecordOutput[] — Collection of Clearing.ClearingRecordOutput objects or an empty array
    - `reportingId` string
    - `settlementCode` string
    - `clearingId` string
    - `orderId` string, nullable
    - `description` string
    - `reference` string, nullable
    - `currencyAmount` 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
    - `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
    - `paymentMethod` PaymentMethodOutput — A payment method including its id.
      - `id` integer — The identifier for the payment method
      - `name` string — The name for the payment method
    - `paymentProfile` 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
    - `turnoverGroup` ClearingTurnoverGroupOutput
      - `code` string
      - `name` string
    - `merchant` ClearingClearingRecordOutputMerchant
      - `code` string
      - `name` string
    - `transactionDate` string, date-time
  - `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)