# Get Settlements

Retrieves a paginated list of settlements with optional filtering and sorting.

Available Filters:
- destinationMemberId: Filter by specific destination member
- settlementStatus: Filter by settlement status (S100_SCHEDULED, S200_RECEIVED, etc.)
- createdAfter: Filter settlements created after a specific date/time

Sorting Options:
- sortField: Field to sort by (creationTime, settlementAmt, rate, etc.)
- sortDirection: ASC (ascending) or DESC (descending)

Pagination:
- page: Page number (0-based)
- size: Number of records per page (default: 10)

Response includes:
- Array of settlement records
- Pagination metadata (totalPages, totalRecords)
- Settlement details for each record

Endpoint: GET /v2/settlements
Version: 1.1.0

## Query parameters:

  - `page` (integer)
    Zero-based page number for pagination.
Use 0 for the first page, 1 for second page, etc.

  - `size` (integer)
    Number of records per page (default 10, max 100)

  - `sortDirection` (string)
    Sort direction for ordered results:
- ASC: Ascending order (A-Z, 0-9, earliest to latest)
- DESC: Descending order (Z-A, 9-0, latest to earliest)
    Enum: "ASC", "DESC"

  - `sortField` (string)
    Field to sort settlements
    Enum: "settlementAmt", "completionTime", "settlementAmtReceived", "destinationMemberId", "rate", "settlementStatus", "settlementId", "creationTime", "destinationCcy"

  - `destinationMemberId` (string)
    Filter settlements for this specific destination member.
    Example: "DEST_MEMBER_1"

  - `settlementStatus` (string)
    Filter settlements by current status
    Enum: "S100_SCHEDULED", "S200_RECEIVED", "S300_IN_PROGRESS", "S400_FIAT_WITHDRAWAL_IN_PROGRESS", "S500_TERMINATED", "S600_COMPLETED", "S700_FAILED"

  - `createdAfter` (string)
    Filter settlements created after this timestamp.
Uses ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ).
Useful for retrieving only recent settlements.
    Example: "2024-01-01T00:00:00Z"

## Response 200 fields (application/json):

  - `settlements` (array)
    Array of settlement records matching the query criteria.

  - `settlements.settlementId` (string)
    Unique settlement identifier.

  - `settlements.settlementStatus` (string)
    Current status of the settlement in the processing lifecycle.

Status Flow:
1. S100_SCHEDULED - Settlement scheduled for future execution
2. S200_RECEIVED - Settlement received and validated, ready for processing
3. S300_IN_PROGRESS - Settlement actively being processed
4. S400_FIAT_WITHDRAWAL_IN_PROGRESS - Final fiat currency withdrawal in progress

Terminal States:

5. S500_TERMINATED - Settlement cancelled or terminated
6. S600_COMPLETED - Settlement successfully completed
7. S700_FAILED - Settlement failed during processing
    Enum: "S100_SCHEDULED", "S200_RECEIVED", "S300_IN_PROGRESS", "S400_FIAT_WITHDRAWAL_IN_PROGRESS", "S500_TERMINATED", "S600_COMPLETED", "S700_FAILED"

  - `settlements.settlementAmt` (number)
    Original settlement amount in source currency.

  - `settlements.pendingAmt` (number)
    Amount still pending processing in source currency.

  - `settlements.rate` (number)
    Exchange rate applied to this settlement. This rate was locked when the settlement was created.

  - `settlements.settlementAmtReceived` (number)
    Actual amount received in destination currency. Populated when settlement is completed (S600_COMPLETED status).

  - `settlements.sourceCcy` (string)
    Source currency code (ISO 4217 3-letter format).

  - `settlements.destinationCcy` (string)
    Destination currency code (ISO 4217 3-letter format).

  - `settlements.sourceMemberId` (string)
    Source member identifier.

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

  - `settlements.notes` (string)
    Notes or description provided when creating the settlement.

  - `settlements.creationTime` (string)
    Timestamp when the settlement was created (ISO 8601 format).

  - `settlements.completionTime` (string)
    Timestamp when the settlement was completed (ISO 8601 format).

  - `settlements.dueDate` (string)
    Expected completion date/time for this settlement. Based on execution interval and processing time estimates.

  - `page` (integer)
    Current page number (0-based)

  - `size` (integer)
    Number of records per page. Default is 10, maximum is 100.

  - `totalPages` (integer)
    Total number of pages available for the current query

  - `totalRecords` (integer)
    Total number of settlement records matching the query criteria.

## Response 400 fields (application/json):

  - `code` (string)

  - `message` (string)

  - `detail` (string)