---
title: "Settlement: Show"
method: GET
path: "/settlements/{id}"
tags: ["Settlements"]
---

# Settlement: Show

`GET /settlements/{id}`

Retrieves a single settlement by its `id`, including a breakdown of payments, refunds,
fees, corrections, and disbursements.

## Path parameters

- `id` string, required — A unique 25-character alphanumeric resource identifier.

## Response `200`

200 response

- SettlementShow
  - `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.
  - `payments` object, required
    - `captured_amount_total_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `processing_fees_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `total_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
  - `refunds` object, required
    - `refunded_amount_total_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `refund_processing_fees_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `refunded_customer_fees_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `total_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
  - `platform_model` object
    - `fund_transfer_total_cents` integer — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `payment_share_total_cents` integer — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `payment_share_refund_total_cents` integer — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `platform_fee_total_cents` integer — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `platform_fee_refund_total_cents` integer — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `submerchant_management_fees_cents` integer — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `total_cents` integer — Amount in the lowest denomination of the currency (e.g. cents for USD).
  - `corrections` object, required
    - `total_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
  - `komoju_card_charges` object, required
    - `total_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
  - `disbursements` object, required
    - `disbursement_amount_total_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `disbursement_fee_total_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `total_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
  - `misc` object, required
    - `clearings_total_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `komoju_card_discount_total_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `chargeback_fixed_fee_total_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `other_fee_adjustments_total_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).
    - `total_cents` integer, required — Amount in the lowest denomination of the currency (e.g. cents for USD).

---

[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)
