---
title: "Fetch a Settlement"
method: GET
path: "/settlements/{settlement_id}"
tags: ["Settlements"]
---

# Fetch a Settlement

`GET /settlements/{settlement_id}`

Retrieve the details of an existing `Settlement`.

## Headers

- `Finix-Version` string

## Response `200`

A single `Settlement`

- Settlement
  - `id` string — The ID of the resource.
  - `created_at` string, date-time — Timestamp of when the object was created.
  - `updated_at` string, date-time — Timestamp of when the object was last updated.
  - `application` string — ID of the `Application` the resource was created under.
  - `currency` 'CAD' | 'USD' — ISO 4217 3-letter currency code.
  - `destination` string, nullable — ID of the `Payment Instrument` where funds will be sent.
  - `funds_flow` string, nullable — Details how funds will be dispersed in the `Funding Transfer` (usually `null`).
  - `identity` string — The ID of the `Identity` used to create the `Settlement` resource.
  - `is_exception` boolean — Returns `true` if the `Settlement` contains items that were removed from a previous `Settlement`.
  - `merchant_id` string — The ID of the `Merchant` used to create the `Settlement` resource.
  - `net_amount` integer — The amount in cents that will be deposited into the merchant's bank account.
  - `payment_type` string, nullable — The type of `Payment Instrument` used in the `Funding Transfer` (or the original payment).
  - `payout_profile_id` string — The ID of the `Payout Profile` that was used to generate the `Settlement`.
  - `processor` string — The name of the processor.
  - `status` 'APPROVED' | 'AWAITING_APPROVAL' — The status of the `Settlement`. Merchants only receive payouts when `Settlements` are `APPROVED`. For more information, see [Payouts](/guides/payouts/).
  - `tags` Tags, nullable — Include up to 50 `key: value` pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual `values` is 500. (For example, `order_number: 25`, `item_type: produce`, `department: sales`)
  - `total_amount` integer — The total amount of the `Settlement` in cents.
  - `total_fee` integer — The sum of the fees in the `Settlement`.
  - `total_fees` integer — The sum of the fees in the `Settlement`, including subscription billing fees.
  - `type` 'MERCHANT_REVENUE' | 'PLATFORM_FEE' | 'PARTNER_FEE' | 'NOOP' | 'MERCHANT' | 'APPLICATION' | 'PLATFORM' — The type of `Settlement`.
  - `_links` object — For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.
    - `application` object — Link to the `Application` the resource was created under.
      - `href` string
    - `credits` object — Link to the credits associated with the `Settlement`.
      - `href` string
    - `debits` object — Link to the debits associated with the `Settlement`.
      - `href` string
    - `disputes` object — Link to the `Dispute` resources associated with the `Settlement`.
      - `href` string
    - `fees` object — Link to the `Fee` resources associated with the `Settlement`.
      - `href` string
    - `funding_transfers` object — Link to the settlement funding `Transfer` resources associated with the `Settlement`.
      - `href` string
    - `identity` object — Link to the `Identity` the resource was created under.
      - `href` string
    - `reversals` object — Link to the reversals associated with the `Settlement`.
      - `href` string
    - `self` object — Link to the resource that was used in the request.
      - `href` string
    - `transfers` object — Link to the transfers associated with the `Settlement`.
      - `href` string

## Other responses

- `401` — Unauthorized. Authentication is required and has failed or has not been provided.
- `403` — Forbidden. The client is authenticated but does not have permission to access the resource.
- `404` — Not Found. The requested resource could not be found on the server.
- `406` — Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.

---

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