> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eximpe.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Settlements

> Retrieve a list of settlements.



## OpenAPI

````yaml GET /pg/settlements/
openapi: 3.0.0
info:
  title: Eximpe Payment Gateway API
  description: >-
    API for payment processing and order management through Eximpe payment
    gateway. This specification includes v1, v2, and v3 API versions.
  license:
    name: Proprietary
  version: 2.0.0
servers:
  - url: https://api-pacb-uat.eximpe.com
    description: Payment Gateway Sandbox URL
security:
  - clientAuth: []
    clientSecretAuth: []
    apiVersionHeader: []
tags:
  - name: Card Tokens
  - name: Merchants
  - name: Orders
  - name: Payment Links
  - name: Payments
  - name: Refunds
  - name: Settlements
  - name: Subscriptions
paths:
  /pg/settlements/:
    get:
      tags:
        - Settlements
      summary: List Settlements
      description: Retrieve a list of settlements with optional filtering.
      operationId: v1_get_pg_settlements_
      parameters:
        - name: from_date
          in: query
          description: 'Filter settlements from this date. Format: YYYY-MM-DD.'
          schema:
            type: string
            format: date
        - name: to_date
          in: query
          description: 'Filter settlements up to this date. Format: YYYY-MM-DD.'
          schema:
            type: string
            format: date
      responses:
        '200':
          description: A paginated list of settlements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1_ListSettlementsResponse'
              example:
                success: true
                message: Settlements fetched successfully
                data:
                  settlement_id: ST4353980017
                  utr_number: 092dc30a-4f19-4318-9798-ad08b48801f6
                  settlement_completed_date: '2025-06-20T08:06:59.293548Z'
                  forex_rate: 86
                  settlement_amount: 1000
                  settlement_currency: USD
                  transactions:
                    - settlement_type: capture
                      transaction_id: PR3828502708
                      transaction_amount: 1000
                      merchant_service_fee: 0
                      merchant_service_tax: 0
                      merchant_net_amount: 1000
                      mop_type: upi
                      transaction_currency: INR
                      forex_rate: 86
      security:
        - clientAuth: []
          clientSecretAuth: []
          apiVersionHeader: []
components:
  schemas:
    v1_ListSettlementsResponse:
      type: object
      properties:
        count:
          type: integer
        page:
          type: integer
        page_size:
          type: integer
        next:
          type: string
          format: uri
          nullable: true
        previous:
          type: string
          format: uri
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/v1_SettlementInList'
    v1_SettlementInList:
      type: object
      properties:
        settlement_id:
          type: string
        utr_number:
          type: string
        settlement_completed_date:
          type: string
          format: date-time
        forex_rate:
          type: number
          format: float
        settlement_amount:
          type: number
          format: float
        settlement_currency:
          type: string
  securitySchemes:
    clientAuth:
      type: apiKey
      name: X-Client-ID
      in: header
      description: >-
        **Client Application ID** - Your unique application identifier used to
        authenticate API requests. You can find your Client ID in the Developer
        Settings section of the merchant dashboard.
      x-displayName: Client ID
      x-example: your-client-id
    clientSecretAuth:
      type: apiKey
      name: X-Client-Secret
      in: header
      description: >-
        **Client Secret Key** - Your secret key used alongside the Client ID for
        secure authentication. Keep this confidential and never expose it in
        client-side code. Available in the Developer Settings section of the
        merchant dashboard.
      x-displayName: Client Secret
      x-example: your-client-secret
    apiVersionHeader:
      type: apiKey
      name: X-API-Version
      in: header
      description: >-
        **API Version** - Specifies which version of the API to use (e.g.,
        '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which
        API version your integration uses. Default version information is
        available in the Developer Settings.
      x-displayName: API Version
      x-example: 3.0.0

````