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

# Settlement Reconciliation

> Retrieve a paginated list of the transactions (captures, refunds, and chargebacks) that make up a settlement.



## OpenAPI

````yaml GET /pg/settlements/{uid}/recon/
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/{uid}/recon/:
    get:
      tags:
        - Settlements
      summary: Settlement Reconciliation
      description: >-
        Returns a paginated list of the individual transactions (captures,
        refunds, and chargebacks) that make up a single settlement batch.


        Use this endpoint for reconciliation when a settlement contains too many
        transactions to fetch in one response. The settlement detail endpoint
        (`GET /pg/settlements/{settlement_id}/`) returns every transaction in
        one unpaginated payload; this endpoint returns the same transactions
        paginated, with a trimmed field set.


        Transactions across all three types are merged into a single stream
        ordered by `created_at` descending. For a PSP, supply the optional
        `X-Merchant-ID` header to scope the response to a single sub-merchant.
      operationId: v1_get_pg_settlements_uid_recon_
      parameters:
        - name: uid
          in: path
          description: Settlement unique identifier (e.g. `ST6937597440`).
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: Page number.
          required: false
          schema:
            type: integer
            default: 1
        - name: page_size
          in: query
          description: Transactions per page (max 1000).
          required: false
          schema:
            type: integer
            default: 250
            maximum: 1000
        - name: X-Merchant-ID
          in: header
          description: >-
            PSP only. When supplied, scopes the response to the named
            sub-merchant. When omitted, a PSP sees its own and all
            sub-merchants' transactions.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: A paginated list of settlement transactions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1_SettlementReconResponse'
              example:
                success: true
                message: Settlement transactions retrieved successfully
                data:
                  count: 412
                  page: 1
                  page_size: 250
                  next: >-
                    https://api.eximpe.com/pg/settlements/ST6937597440/recon/?page=2
                  previous: null
                  results:
                    - settlement_type: capture
                      transaction_id: PR7041820005
                      settlement_id: ST6937597440
                      settlement_completed_at: '2026-05-28T11:20:33Z'
                      settlement_currency: USD
                      transaction_amount: '100.00'
                      merchant_net_amount: '95.00'
                      total_processing_fee: '3.00'
                      total_service_tax: '0.54'
                      mop_type: UPI
                      transaction_currency: INR
                    - settlement_type: refund
                      transaction_id: RF1533204282
                      settlement_id: ST6937597440
                      settlement_currency: USD
                      transaction_amount: '20.00'
                      merchant_net_amount: '-20.00'
                      total_processing_fee: '0.00'
                      total_service_tax: '0.00'
                      mop_type: UPI
                      transaction_currency: INR
                    - settlement_type: chargeback
                      transaction_id: CB4611686552
                      settlement_id: ST6937597440
                      settlement_completed_at: '2026-05-28T11:20:33Z'
                      settlement_currency: USD
                      transaction_amount: '50.00'
                      merchant_net_amount: '-50.00'
                      total_processing_fee: '0.00'
                      total_service_tax: '0.00'
                      mop_type: CREDIT_CARD
                      transaction_currency: INR
        '401':
          description: Missing or invalid credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1_ErrorResponse'
              example:
                success: false
                error:
                  code: ERR_AUTH_001
                  message: Invalid credentials
        '404':
          description: >-
            Settlement does not exist or does not belong to the authenticated
            merchant.
          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_SettlementReconResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          $ref: '#/components/schemas/v1_SettlementReconData'
    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_SettlementReconData:
      type: object
      properties:
        count:
          type: integer
          description: >-
            Total number of transactions in this settlement (for the
            authenticated merchant).
        page:
          type: integer
          description: Current page number.
        page_size:
          type: integer
          description: Number of items per page.
        next:
          type: string
          format: uri
          nullable: true
          description: URL for the next page, or null on the last page.
        previous:
          type: string
          format: uri
          nullable: true
          description: URL for the previous page, or null on the first page.
        results:
          type: array
          items:
            $ref: '#/components/schemas/v1_SettlementReconTransaction'
    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_SettlementReconTransaction:
      type: object
      properties:
        settlement_type:
          type: string
          description: The kind of transaction in the settlement.
          enum:
            - capture
            - refund
            - chargeback
        transaction_id:
          type: string
          description: >-
            The transaction's unique identifier (payment `PR...`, refund
            `RF...`, chargeback `CB...`).
        settlement_id:
          type: string
          description: The parent settlement UID.
        settlement_completed_at:
          type: string
          format: date-time
          description: When the settlement completed. Not present on refund rows.
        settlement_currency:
          type: string
          description: Currency the settlement is paid out in.
        transaction_amount:
          type: string
          description: >-
            Gross transaction amount, returned as a decimal string (e.g.
            "100.00").
        merchant_net_amount:
          type: string
          description: >-
            Net amount to the merchant, as a decimal string. Negative for
            refunds and chargebacks (money out).
        total_processing_fee:
          type: string
          description: >-
            Processing fee, as a decimal string. Always "0.00" for refunds and
            chargebacks.
        total_service_tax:
          type: string
          description: >-
            Service tax on the fee, as a decimal string. Always "0.00" for
            refunds and chargebacks.
        mop_type:
          type: string
          nullable: true
          description: >-
            Mode of payment, e.g. UPI, CREDIT_CARD, DEBIT_CARD, NET_BANKING,
            WALLET, CARD. May be null if the mode of payment was not recorded.
        transaction_currency:
          type: string
          description: Currency the buyer was charged in.
  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

````