---
title: "Settlement: Index"
method: GET
path: "/settlements"
tags: ["Settlements"]
---

# Settlement: Index

`GET /settlements`

Retrieves a paginated list of settlements from most-recent to least-recent. Pagination
can be configured with `page` and `per_page` parameters.

## Query parameters

- `start_time` string, date-time
- `end_time` string, date-time
- `per_page` integer
- `page` integer

## Response `200`

200 response

- SettlementList
  - `resource` string, required — Resource type name for this list, always "list".
  - `data` Settlement[], required — Array of settlement objects for this page.
    - `id` string, required — A unique 25-character alphanumeric resource identifier.
    - `resource` 'settlement', required — Resource type name, always "settlement".
    - `reference` string, required — Human-readable reference code for this settlement.
    - `status` 'pending' | 'paid' | 'cancelled' | 'bounced' | 'suspended', required
    - `merchant_name` string, required — Name of the merchant associated with this settlement.
    - `company_name` string, nullable, required — Legal company name of the merchant, or null if not set.
    - `cycle` string, required — Settlement cycle identifier (e.g. the week or month period covered).
    - `transaction_amount_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `currency` 'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND', required — 3-letter ISO currency code.
    - `fee_amount_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `fee_tax_amount_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `settlement_amount_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `fx_currency` 'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND', required — 3-letter ISO currency code.
    - `fx_conversion_rate` string, required — Exchange rate applied for FX conversion.
    - `fx_conversion_amount_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `bank_transfer_fee_amount_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `remittance_amount_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `cutoff_time` string, date-time, required — Cutoff timestamp for transactions included in this settlement.
    - `created_at` string, date-time, required — Timestamp when this settlement record was created.
    - `download` object, required
      - `csv` string, nullable, required — URL to download this settlement in CSV format, or null if unavailable.
      - `xls` string, nullable, required — URL to download this settlement in XLS format, or null if unavailable.
  - `start_time` string, date-time, required — Start of the time range for records in this response.
  - `end_time` string, date-time, required — End of the time range for records in this response.
  - `total` integer, required — Total number of records matching the query.
  - `page` integer, required — Current page number.
  - `per_page` integer, required — Number of results per page.
  - `last_page` integer, required — Last available page number.

---

[API](https://skmtc.net/komoju/apis/komoju-api.md) · [All operations](https://skmtc.net/komoju/apis/komoju-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/komoju/komoju-api/versions/65483c40ba32/schema)