--- title: "Retrieve a settlement" method: GET path: "/settlement/{id}" tags: ["Settlements"] --- # Retrieve a settlement `GET /settlement/{id}` Retrieve a single settlement by its ID. **Required scope:** settlement:read ## Path parameters - `id` string, uuid, required ## Response `200` Successful response with a settlement - Settlement - `id` string, uuid, required — Unique identifier for the settlement. - `created_at` string, date-time, required — Timestamp when the settlement was created. Always present. - `updated_at` string, date-time, nullable, required — Timestamp when the settlement was last updated, or `null` when it has never been updated. - `name` string, required — Human-readable name of the settlement (its batch reference). - `description` string, required — Human-readable description of the settlement. - `status` 'IN_TRANSIT' | 'SUCCEEDED' | 'FAILED', required — Current status of the settlement. - `total_amount` Money, required — The money type is a data structure used to represent a monetary value in a specific currency. It includes both the amount and the currency type to accurately define the value of money in various contexts, such as financial transactions, pricing, and accounting. - `amount` string — Represents the numerical value of the money. The amount should be a string formatted to include up to two decimal places to accurately represent cents or subunits of currency. For example, "123.45" represents one hundred twenty-three units and forty-five subunits of the currency. - `currency` string — Indicates the type of currency associated with the amount. This should follow standard currency codes (ISO 4217), such as "USD" for US Dollar, "EUR" for Euro, or "JPY" for Japanese Yen, to specify which currency the amount is denominated in. - `number_of_items` integer, required — Number of transactions included in the settlement. - `destination` object, required — Where the settled funds are sent. - `type` 'IBAN', required — Type of destination. - `details` object — Details specific to the destination type. - `iban` string — Destination IBAN. Omitted when empty. ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `412` — Pre condition failed - `429` — Too Many Requests - `500` — Internal Server Error --- [API](https://skmtc.net/easypay/apis/easypay-payments-api.md) · [All operations](https://skmtc.net/easypay/apis/easypay-payments-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/easypay/easypay-payments-api/versions/cdf25a9ad7b2/schema)