# Get settlement

Retrieves details for the specified <a href="https://docs.solidgate.com/finance/financial-reports/settlements/" target="_blank">settlement</a>. This endpoint requires an account-level API key.

Endpoint: POST /settlements/get
Version: 2.0.0
Security: bearerAuth

## Request fields (application/json):

  - `id` (string, required)
    Unique settlement identifier.
    Example: sttl_01KM4X2H8KQWE5T6Y7R2M4N0BX

## Response 200 fields (application/json):

  - `id` (string, required)
    Unique settlement identifier.
    Example: sttl_01KM4X2H8KQWE5T6Y7R2M4N0BX

  - `provider_settlement_id` (string)
    Settlement identifier assigned by the payment provider.
    Example: po_1SiOtvARglNY93qrC4v49DbH

  - `provider` (string, required)
    Payment provider the settlement originates from.
    Example: ADYEN

  - `legal_entity_id` (string, required)
    Identifier of the legal entity that receives the settlement.
    Example: le_01JZ9F3H8KQWE5T6Y7R2M4N0BX

  - `amount` (integer, required)
    Settlement amount in minor units.
    Example: 150000

  - `currency` (string, required)
    Settlement currency in ISO 4217 alphabetic code.
    Example: USD

  - `settlement_date` (string, required)
    Date when the settlement was processed.
    Example: 2026-01-04

  - `period_from` (string)
    Start date of the transaction date range included in the settlement.
    Example: 2026-01-02

  - `period_to` (string)
    End date of the transaction date range included in the settlement.
    Example: 2026-01-04

  - `created_at` (string, required)
    Date and time when the settlement was created.
    Example: 2026-01-05T10:00:00.000000Z

  - `updated_at` (string, required)
    Date and time when the settlement was last updated.
    Example: 2026-01-05T12:00:00.000000Z

  - `files` (array, required)
    Downloadable files attached to the settlement.
    Example: [{"type":"SETTLEMENT","status":"SUCCEEDED","download_url":"https://storage.example.com/settlements/settlement.csv?signature=abc123"}]

  - `files.type` (string, required)
    Type of downloadable file attached to the settlement.
    Enum: "SETTLEMENT", "FINANCIAL_ENTRIES"

  - `files.status` (string, required)
    Generation status of the file.
    Enum: "PROCESSING", "SUCCEEDED", "FAILED"

  - `files.download_url` (string)
    Short-lived pre-signed URL for downloading the file. Present only when the file status is SUCCEEDED.
    Example: https://storage.example.com/settlements/settlement.csv?signature=abc123

## Response 400 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "VALIDATION"

  - `message` (string, required)
    Message describing the error.
    Example: One or more fields failed validation due to constraints

  - `context` (object, required)
    Additional context about the validation error, including specific constraints.
    Example: {"constraints":{"email":{"type":"TYPE","message":"The 'email' field must be a valid email address"},"age":{"type":"MIN","message":"The 'age' field must be a number greater than or equal to 18"}}}

## Response 401 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "UNAUTHENTICATED"

  - `message` (string, required)
    Message describing the error.
    Example: Credentials are invalid or missing

## Response 403 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "PERMISSION_DENIED"

  - `message` (string, required)
    Message describing the error.
    Example: Permission denied

## Response 404 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "NOT_FOUND"

  - `message` (string, required)
    Message describing the error. The entity varies by endpoint.
    Example: The requested resource could not be found

## Response 429 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "RATE_LIMIT"

  - `message` (string, required)
    Message describing the error.
    Example: Rate limit exhausted

  - `context` (object)
    Additional context about the error.

  - `context.next_try_at` (string)
    Timestamp indicating when to retry the request.
    Example: 2024-12-31T23:59:59.000000Z