---
title: "List merchant Settlements"
method: GET
path: "/v3/settlements"
tags: ["Settlement"]
---

# List merchant Settlements

`GET /v3/settlements`

## Request

- Base URL: `https://confirmo.net/api`
- URL: `https://confirmo.net/api/v3/settlements`
- Auth: HTTP bearer

Returns list of merchant's Settlements filtered by specific parameters.

## Query parameters

- `limit` integer, required
- `offset` integer, required
- `order` 'createdAt,asc' | 'createdAt,desc' | 'amount,asc' | 'amount,desc', required
- `searchString` string
- `statuses` string[]
- `createdAtFrom` string
- `createdAtTo` string
- `currency` 'BTC' | 'CZK' | 'ETH' | 'EUR' | 'GBP' | 'HUF' | 'LTC' | 'PLN' | 'POL' | 'SOL' | 'TRX' | 'USD' | 'USDC' | 'USDT': The currency in which the Settlement will be paid out. Merchant gets paid in this currency, when it is assigned to an invoice as settlement currency

## Response `200`

OK

- DataPageToSettlementTo
  - `data` SettlementTo[]: The collection of items.
    - `account` string: The IBAN or crypto address
    - `amount` number: The amount to be paid out.
    - `balanceFromPreviousPeriod` number: The balance that has been transferred from the previous Settlement.
    - `balanceToNextPeriod` number: The balance to be transferred to the next Settlement.
    - `correctionTransactionIds` string[]: The Settlement's correction transactions IDs.
    - `correctionTransactionSum` number: The sum of correction transactions made by admin.
    - `createdAt` integer: The timestamp when the Settlement was created.
    - `cryptoWithdrawalAmountSum` number: The sum of the Settlement's Crypto Withdrawal amounts.
    - `cryptoWithdrawalFeeSum` number: The sum of the Settlement's Crypto Withdrawal fees.
    - `cryptoWithdrawalIds` string[]: The Settlement's Crypto Withdrawal IDs.
    - `currency` 'BTC' | 'CZK' | 'ETH' | 'EUR' | 'GBP' | 'HUF' | 'LTC' | 'PLN' | 'POL' | 'SOL' | 'TRX' | 'USD' | 'USDC' | 'USDT': The currency in which the Settlement will be paid out. Merchant gets paid in this currency, when it is assigned to an invoice as settlement currency
    - `fee` number: The Settlement fee.
    - `id` string: The Settlement ID.
    - `invoiceAmountSum` number: The sum of Settlement's Invoices amounts.
    - `invoiceFeeSum` number: The sum of Settlement's Invoice fees.
    - `invoiceIds` string[]: The Settlement's Invoices IDs.
    - `keepMinBalance` number: The minimum account balance after Settlement.
    - `osTransactionAmountSum` number: The sum of transactions created via Payout API.
    - `osTransactionFeeSum` number: The sum of fees of transactions created via Payout API.
    - `overpaymentAmountSum` number: The sum of Settlement's accepted invoice overpayments.
    - `overpaymentFeeSum` number: The sum of fees of Settlement's accepted invoice overpayments.
    - `payoutIds` string[]: The Settlement's Payouts IDs.
    - `status` 'blocked_overlimit' | 'pending' | 'on_hold' | 'sending' | 'sent' | 'failed' | 'canceled': The Settlement status.
    - `statusReason` string: The reason why the Settlement sending failed.
    - `substatus` string
  - `limit` integer: The number of returned items.
  - `offset` integer: The number of skipped items.
  - `order` string: The sort column and the order of returned items.
  - `query` string: The searched string in items.
  - `totalCount` integer: The total number of items owned by the merchant.

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `409`: Conflict

---

[API](https://skmtc.dev/confirmo/apis/confirmo-api.md) - [All operations](https://skmtc.dev/confirmo/apis/confirmo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/confirmo/apis/confirmo-api/revisions/09bef7db3dd1?raw)