# Get Settlement Payout By ID

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/settlement-payout/{settlementPayoutId}:
    get:
      summary: Get Settlement Payout By ID
      deprecated: false
      description: >-

        :::highlight purple 📌

        Retrieve detailed information about a specific settlement payout using
        its unique ID. This API helps you track settlement status, amounts,
        timelines, and other key details for easier reconciliation and
        reporting.

        :::
      operationId: getSettlementPayoutById
      tags:
        - Payment Gateway/APIs - Payment Gateway /Settlement
      parameters:
        - name: settlementPayoutId
          in: path
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - name: Authorization
          in: header
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - name: merchantAccessKey
          in: header
          description: ''
          required: true
          example: ''
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ApplicationResponseSettlementPayoutDetailResponse
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Payment Gateway/APIs - Payment Gateway /Settlement
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-8990255-run
components:
  schemas:
    ApplicationResponseSettlementPayoutDetailResponse:
      type: object
      properties:
        response_code:
          type: integer
          format: int32
        response_message:
          type: string
        payload:
          $ref: '#/components/schemas/SettlementPayoutDetailResponse'
      x-apidog-orders:
        - response_code
        - response_message
        - payload
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    SettlementPayoutDetailResponse:
      type: object
      properties:
        settlementPayoutId:
          type: string
        totalSaleAmount:
          type: number
        totalRefundAmount:
          type: number
        totalCharges:
          type: number
        totalGst:
          type: number
        totalSettlementAmount:
          type: number
        refundChargebackAmount:
          type: number
        carryForwardAmount:
          type: number
        adjustmentAmount:
          type: number
        payoutStatus:
          type: string
          enum:
            - INIT
            - SUCCESS
            - FAILED
            - IN_PROGRESS
            - ON_HOLD
        payoutMode:
          type: string
          enum:
            - IMPS
            - NEFT
            - RTGS
        utr:
          type: string
        payoutDate:
          type: string
          format: date-time
        remarks:
          type: string
        payoutRemarks:
          type: string
        transferId:
          type: string
        transferResponseReason:
          type: string
        createdOn:
          type: string
          format: date-time
        settlementTransactions:
          type: array
          items:
            $ref: '#/components/schemas/SettlementTransactionResponse'
        settlementSplitTransactions:
          type: array
          items:
            $ref: '#/components/schemas/SettlementTransactionSplitResponse'
      x-apidog-orders:
        - settlementPayoutId
        - totalSaleAmount
        - totalRefundAmount
        - totalCharges
        - totalGst
        - totalSettlementAmount
        - refundChargebackAmount
        - carryForwardAmount
        - adjustmentAmount
        - payoutStatus
        - payoutMode
        - utr
        - payoutDate
        - remarks
        - payoutRemarks
        - transferId
        - transferResponseReason
        - createdOn
        - settlementTransactions
        - settlementSplitTransactions
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    SettlementTransactionSplitResponse:
      type: object
      properties:
        settlementTransactionId:
          type: string
        settlementTransactionSplitId:
          type: number
        enkashTransactionId:
          type: number
        txnAmount:
          type: number
        amount:
          type: number
        transactionType:
          type: string
          enum:
            - SALE
            - REPAYMENT
            - RECOVERY
            - LOAD_MONEY
            - REFUND
            - REVERSAL
            - CREDIT
            - FEE
            - ALLOCATE_FUND
            - UNALLOCATE_FUND
            - CASHBACK
            - FUNDPOST_DEBIT
            - PAYOUT
            - DISCOUNT
            - OPEN_VOUCHER
            - ALLOCATE_POINT
            - UNALLOCATE_POINT
            - VA_UNALLOCATE_FUND
            - VA_ALLOCATE_FUND
            - EXCESS_LOAD
            - EXCESS_UNLOAD
            - ALLOCATE_COIN
        settlementSplitType:
          type: string
          enum:
            - PENDING
            - APPROVED
            - SETTLEMENT_IN_PROCESS
            - DISPUTED
            - SETTLED
            - PENDING_WITH_BANK
            - REFUND
        payoutDate:
          type: string
          format: date-time
        splitTransactionCharges:
          type: number
        splitTransactionGst:
          type: number
      x-apidog-orders:
        - settlementTransactionId
        - settlementTransactionSplitId
        - enkashTransactionId
        - txnAmount
        - amount
        - transactionType
        - settlementSplitType
        - payoutDate
        - splitTransactionCharges
        - splitTransactionGst
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    SettlementTransactionResponse:
      type: object
      properties:
        settlementTransactionId:
          type: string
        saleAmount:
          type: number
        txnAmount:
          type: number
        taxAmount:
          type: number
        charges:
          type: number
        settlementAmount:
          type: number
        transactionType:
          type: string
          enum:
            - SALE
            - REPAYMENT
            - RECOVERY
            - LOAD_MONEY
            - REFUND
            - REVERSAL
            - CREDIT
            - FEE
            - ALLOCATE_FUND
            - UNALLOCATE_FUND
            - CASHBACK
            - FUNDPOST_DEBIT
            - PAYOUT
            - DISCOUNT
            - OPEN_VOUCHER
            - ALLOCATE_POINT
            - UNALLOCATE_POINT
            - VA_UNALLOCATE_FUND
            - VA_ALLOCATE_FUND
            - EXCESS_LOAD
            - EXCESS_UNLOAD
            - ALLOCATE_COIN
        settlementStatus:
          type: string
          enum:
            - PENDING
            - APPROVED
            - SETTLEMENT_IN_PROCESS
            - DISPUTED
            - SETTLED
            - PENDING_WITH_BANK
            - REFUND
        remarks:
          type: string
        merchantMdrMode:
          type: string
          enum:
            - CONVENIENCE
            - NORMAL
        createdOn:
          type: string
          format: date-time
      x-apidog-orders:
        - settlementTransactionId
        - saleAmount
        - txnAmount
        - taxAmount
        - charges
        - settlementAmount
        - transactionType
        - settlementStatus
        - remarks
        - merchantMdrMode
        - createdOn
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```