# List settlements

API to fetch first party payouts (settlements) with enhanced v1 response format.

Endpoint: GET /v1/collections/settlements
Version: 1.0.0
Security: Bearer

## Query parameters:

  - `id` (string)
    Filter settlements by specific settlement ID
    Example: "63dd59dd-88be-41a2-a246-2f6724209422"

  - `type` (string)
    Settlement type
    Enum: "FIAT", "CRYPTO"

  - `status` (string)
    Settlement status
    Enum: "PENDING", "PROCESSING", "COMPLETED", "FAILED", "CANCELLED"

  - `since` (string)
    ISO 8601 timestamp after settlement was created
    Example: "2025-06-17T12:00:00Z"

  - `until` (string)
    ISO 8601 timestamp before settlement was created
    Example: "2025-06-17T12:00:00Z"

  - `page` (integer)
    Page number (starts at 1)
    Example: 1

  - `size` (integer)
    Number of settlements per page
    Example: 10

## Response 200 fields (application/json):

  - `content` (array)

  - `content.id` (string, required)
    Unique identifier for the settlement
    Example: "63dd59dd-88be-41a2-a246-2f6724209422"

  - `content.type` (string, required)
    Settlement type
    Enum: "FIAT", "CRYPTO"

  - `content.currency` (string, required)
    Currency code for the settlement
    Example: "USD"

  - `content.gross_amount` (string, required)
    Total settlement amount before fees
    Example: "50.00"

  - `content.settlement_amount` (string, required)
    Net settlement amount after fees
    Example: "49.50"

  - `content.fees` (object, required)
    Settlement fees

  - `content.fees.transaction_fees` (string)
    Total fees applied to the settlement
    Example: "0.50"

  - `content.status` (string, required)
    Settlement status
    Enum: "PENDING", "PROCESSING", "COMPLETED", "FAILED", "CANCELLED"

  - `content.data` (any, required)
    Settlement data - varies based on settlement type (FIAT or CRYPTO)

  - `content.settlement_transactions` (array, required)
    List of settlement transactions

  - `content.settlement_transactions.id` (string, required)
    Unique identifier of the settlement transaction
    Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

  - `content.settlement_transactions.account_id` (string, required)
    Account ID associated with this settlement transaction
    Example: "f9e8d7c6-b5a4-3210-fedc-ba0987654321"

  - `content.settlement_transactions.market_rate` (object)
    Market rate at the time of settlement

  - `content.settlement_transactions.market_rate.base` (string)
    Base currency for the exchange rate
    Example: "USDC"

  - `content.settlement_transactions.market_rate.counter` (string)
    Counter currency for the exchange rate
    Example: "USD"

  - `content.settlement_transactions.market_rate.rate` (string)
    Exchange rate from base to counter currency
    Example: "1.00"

  - `content.settlement_transactions.exchange_rate` (object)
    Exchange rate from base to counter currency

  - `content.settlement_transactions.exchange_rate.base` (string)
    Base currency for the exchange rate
    Example: "USDC"

  - `content.settlement_transactions.exchange_rate.counter` (string)
    Counter currency for the exchange rate
    Example: "USD"

  - `content.settlement_transactions.exchange_rate.rate` (string)
    Exchange rate from base to counter currency
    Example: "0.99"

  - `content.settlement_transactions.amount` (string, required)
    Example: "49.50"

  - `page` (object)
    Pagination metadata.

  - `page.page` (integer, required)
    Example: 1

  - `page.size` (integer, required)
    Example: 10

  - `page.total_elements` (integer, required)
    Example: 100

  - `page.total_pages` (integer, required)
    Example: 10

## Response 400 fields (application/json):

  - `code` (string, required)
    Error code identifying the type of error

  - `reason` (string, required)
    Human-readable error message