> ## 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.

# Get Settlement

> Retrieve the details of a specific settlement by its ID.



## OpenAPI

````yaml GET /pg/settlements/{settlement_id}/
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/{settlement_id}/:
    get:
      tags:
        - Settlements
      summary: Get Settlement
      description: Retrieve the details of a specific settlement by its ID.
      operationId: v1_get_pg_settlements_settlement_id_
      parameters:
        - name: settlement_id
          in: path
          description: The ID of the settlement to retrieve.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The details of the settlement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1_GetSettlementResponse'
              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
        '404':
          description: Settlement not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1_ErrorResponse'
              example:
                success: false
                error:
                  code: ERR_SETTLEMENT_002
                  message: Settlement not found
                  details:
                    settlement_id: Settlement not found
      security:
        - clientAuth: []
          clientSecretAuth: []
          apiVersionHeader: []
components:
  schemas:
    v1_GetSettlementResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          $ref: '#/components/schemas/v1_Settlement'
    v1_ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          enum:
            - false
          description: >-
            Indicates if the request was successful. Always false for error
            responses.
        error:
          $ref: '#/components/schemas/v1_ErrorDetails'
    v1_Settlement:
      type: object
      properties:
        settlement_id:
          type: string
          description: Unique identifier for the settlement.
        utr_number:
          type: string
          description: UTR (Unique Transaction Reference) number for the settlement.
        settlement_completed_date:
          type: string
          format: date-time
          description: The timestamp of when the settlement was completed.
        forex_rate:
          type: integer
          description: Forex rate.
        settlement_amount:
          type: integer
          description: Settlement amount.
        settlement_currency:
          type: string
          description: Currency code for the settlement amount.
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/v1_SettlementTransaction'
    v1_ErrorDetails:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Error code (e.g., ERR_ORDER_002)
        message:
          type: string
          description: Error message
        details:
          type: object
          description: Detailed validation error information with field-specific errors
          additionalProperties:
            type: string
            description: Error message for the specific field
    v1_SettlementTransaction:
      type: object
      properties:
        settlement_type:
          type: string
          description: Type of settlement transaction (e.g., capture, refund)
        transaction_id:
          type: string
          description: Unique identifier for the transaction
        transaction_amount:
          type: number
          format: float
          description: Transaction amount
        merchant_service_fee:
          type: number
          format: float
          description: Merchant service fee
        merchant_service_tax:
          type: number
          format: float
          description: Merchant service tax
        merchant_net_amount:
          type: number
          format: float
          description: Net amount for merchant
        mop_type:
          type: string
          description: Method of payment type
          enum:
            - upi
            - credit_card
            - debit_card
            - net_banking
            - qr
        transaction_currency:
          type: string
          description: Currency of the transaction
        forex_rate:
          type: number
          format: float
          description: Forex rate applied to the transaction
  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

````