---
title: "Get Settlement Methods"
method: GET
path: "/v3/settlement-methods"
tags: ["Settlement Method"]
---

# Get Settlement Methods

`GET /v3/settlement-methods`

## Request

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

Returns all merchant's Settlement Methods.

## Response `200`

OK

- DataPageToSettlementMethodToObject
  - `data` union[]: The collection of items.
    - union
      - BankSettlementMethodTo
        - `active` boolean: True if the Settlement Method is active, false if it is disabled.
        - `createdAt` integer: The Unix timestamp specifying when the Settlement Method was created.
        - `id` string: The Settlement Method ID.
        - `keepMinBalance` number, required: The minimum account balance after Settlement.
        - `notificationMail` string: The e-mail address where the notifications will be sent.
        - `paymentMethodId` string
        - `settlement` SettlementMethodPayoutTo
          - `interval` PayoutIntervalTo
            - `day` integer: Determines the weekday or day of month on which Settlement should occur.
            - `type` 'daily' | 'weekly' | 'monthly': Denotes daily, weekly, or monthly Settlement.
          - `minValue` number, required: Minimum settled amount.
        - `settlementAccount` object: The account where to send money. One of BankAccountTo or CryptoAccountTo.
          - `accountNumber` string
          - `swift` string
        - `type` 'bank_payment_accounts' | 'crypto_payment_accounts', required: Type of the Settlement.
        - `updatedAt` integer: The Unix timestamp specifying the moment of the Settlement Method's last update.
        - `currency` 'CZK' | 'EUR' | 'GBP' | 'HUF' | 'PLN' | 'USD': ISO 4217 code of the payment method's fiat currency
      - CryptoSettlementMethodTo
        - `active` boolean: True if the Settlement Method is active, false if it is disabled.
        - `createdAt` integer: The Unix timestamp specifying when the Settlement Method was created.
        - `id` string: The Settlement Method ID.
        - `keepMinBalance` number, required: The minimum account balance after Settlement.
        - `notificationMail` string: The e-mail address where the notifications will be sent.
        - `paymentMethodId` string
        - `settlement` SettlementMethodPayoutTo
          - `interval` PayoutIntervalTo
            - `day` integer: Determines the weekday or day of month on which Settlement should occur.
            - `type` 'daily' | 'weekly' | 'monthly': Denotes daily, weekly, or monthly Settlement.
          - `minValue` number, required: Minimum settled amount.
        - `settlementAccount` object: The account where to send money. One of BankAccountTo or CryptoAccountTo.
          - `address` string, required
        - `type` 'bank_payment_accounts' | 'crypto_payment_accounts', required: Type of the Settlement.
        - `updatedAt` integer: The Unix timestamp specifying the moment of the Settlement Method's last update.
        - `currency` 'BTC' | 'ETH' | 'LTC' | 'POL' | 'SOL' | 'TRX' | 'USDC' | 'USDT': Well known code of the payment method's crypto asset
  - `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)