# Settlement

## Create Settlement

 - [POST /v2/settlements](https://almondfintechapi.redocly.app/apis/settlements/settlement/createsettlement.md): Create a new settlement with the specified execution interval and locked rate.

Important Notes:
- Specified destinationMemberId must be a valid member ID that has an active corridor. Verify availability through /v2/settlement-context endpoint.
- Rate ID must be obtained from /v2/settlement-rates endpoint first
- Settlement amount cannot exceed the corridor's maximum limit available in /v2/settlement-context API

Execution Intervals:
- IMMEDIATE: Settlement executed as soon as possible (0 hours)
- ONE_HOUR to SIX_HOURS: Settlement scheduled for future execution

Settlement States After Creation:
- S100_SCHEDULED: If execution interval is in the future
- S200_RECEIVED: If immediate execution is requested

## Get Settlements

 - [GET /v2/settlements](https://almondfintechapi.redocly.app/apis/settlements/settlement/getsettlements.md): 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

## Get Settlement

 - [GET /v2/settlements/{settlement-id}](https://almondfintechapi.redocly.app/apis/settlements/settlement/getsettlement.md): Retrieves detailed information for a specific settlement by its unique identifier.

Response includes:
- Settlement details (amounts, rates, currencies, notes)
- Current status and timestamps
- Source and destination member information