---
title: "Settlement:Forecasts"
method: GET
path: "/v2/settlements/forecasts"
tags: ["Clearing"]
---

# Settlement:Forecasts

`GET /v2/settlements/forecasts`

This API returns a forecast of the upcoming settlements. You can filter on a merchant code, so if you are a partner and you have right to that merchants you can retrieve the settlement forecast information for your merchant.

## Query parameters

- `merchant` object
  - `eq` string — Get results that equal the given value

## Response `200`

OK

- FinanceTransactionForecastsOutput
  - `forecasts` FinanceTransactionForecastOutput[] — Collection of FinanceTransaction.ForecastOutput objects or an empty array
    - `settlementDate` string, nullable
    - `merchant` FinanceTransactionMerchantOutput
      - `code` string — The merchant id of your company starting with M.
      - `name` string — The name of the merchant.
      - `contractPackage` string — The contract package of the merchant.
    - `turnoverGroup` FinanceTransactionTurnoverGroupOutput
      - `code` string — The CT-code for a turn over group.
      - `name` string — New Turnover Group for Great Cookies Inc.
    - `paymentType` object — Payment types with their values
    - `rollingReserve` AmountOutput — A monetary amount with its value in cents and currency in ISO-4217 format.
      - `value` integer — The amount value in cents
      - `currency` string — The currency in ISO-4217 format
    - `costs` AmountOutput — A monetary amount with its value in cents and currency in ISO-4217 format.
      - `value` integer — The amount value in cents
      - `currency` string — The currency in ISO-4217 format
  - `total` integer, nullable — The total items the collection contains
  - `_links` LinkOutput[], nullable
    - `href` string, nullable — The URI to the linked resource
    - `rel` string, nullable — The name of the linked resource
    - `type` string, nullable — The (http(s)) method needed to approach the linked resource

## Other responses

- `400` — Bad request, see response body for more information
- `401` — Unauthorized. Supplied credentials are invalid
- `403` — Forbidden. Supplied credentials have no rights
- `404` — Resource not found
- `405` — Used HTTP method is not allowed
- `406` — Not acceptable. The supplied content type in the accept parameter in the header is not supported
- `410` — Indicates that this resource is no longer available for use
- `415` — Unsupported media. The supplied content type in the content-type parameter in the header is not supported
- `429` — Rate limit reached.
- `500` — An internal error occurred.
- `503` — The server is currently unable to handle your request

---

[API](https://skmtc.net/pay/apis/pay-transaction-gateway-unit-api.md) · [All operations](https://skmtc.net/pay/apis/pay-transaction-gateway-unit-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pay/pay-transaction-gateway-unit-api/revisions/2bc260c7bdfc/schema)