# Get Settlement Context

Retrieves settlement context information, providing an overview of available settlement corridors and their current capacity.

This endpoint can be used to understand the following before creating settlements.
- Which destination members they can send settlements to
- Maximum settlement amounts allowed for each corridor
- Current settlement activity and capacity constraints:

Endpoint: GET /v2/settlement-context
Version: 1.1.0

## Query parameters:

  - `destinationMemberId` (string)
    Optional filter to get context for a specific destination member only.

- If provided: Returns context for only that specific corridor
- If omitted: Returns context for all available corridors
    Example: "DEST_MEMBER_1"

## Response 200 fields (application/json):

  - `sourceMemberId` (string)
    Source member Identifier.

  - `currency` (string)
    Source currency supported by the source member for outbound settlements.

  - `corridors` (array)
    List of available corridors from the source member to various destinations.

  - `corridors.destinationMemberId` (string)
    Destination member identifier.

  - `corridors.inProgressSettlementsCount` (integer)
    Number of settlements currently in progress (not yet completed) for this corridor.

Includes settlements in states:
- S100_SCHEDULED (scheduled for future execution)
- S200_RECEIVED (received and pending)
- S300_IN_PROGRESS (actively processing)
- S400_FIAT_WITHDRAWAL_IN_PROGRESS (final withdrawal stage)

  - `corridors.settlementInProgress` (boolean)
    Boolean flag indicating whether any settlements are currently in progress for this corridor. True if inProgressSettlementsCount > 0.

  - `corridors.maxSettlementAmount` (number)
    Maximum settlement amount allowed for this corridor in source currency.

## Response 400 fields (application/json):

  - `code` (string)

  - `message` (string)

  - `detail` (string)

## Response 404 fields (application/json):

  - `code` (string)

  - `message` (string)

  - `detail` (string)