# Search Settlement Payouts ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v0/settlement-payout/search: post: summary: Search Settlement Payouts deprecated: false description: >- :::highlight purple 📌 Retrieve a list of settlement payouts based on filters like date range, status, or settlement type. Use this API to track multiple settlements, monitor payout cycles, and simplify your reconciliation process. ::: operationId: searchSettlementPayout tags: - Payment Gateway/APIs - Payment Gateway /Settlement parameters: - name: offset in: query description: '' required: false example: 0 schema: type: integer - name: limit in: query description: '' required: false example: 0 schema: type: integer maximum: 5000 - name: orderBy in: query description: '' required: false example: '' schema: type: string - name: direction in: query description: '' required: false example: '' schema: type: string enum: - ASC - DESC x-apidog-enum: - name: '' value: ASC description: '' - name: '' value: DESC description: '' - name: Authorization in: header description: '' required: true example: '' schema: type: string - name: merchantAccessKey in: header description: '' required: true example: '' schema: type: string requestBody: content: application/json: schema: type: object x-apidog-refs: 01J0R3SQ631WAHTTX1K3FAH4GP: $ref: '#/components/schemas/SearchSettlementPayoutRequest' x-apidog-overrides: {} properties: merchantDetailId: type: string settlementPayoutId: type: string settlementPayoutIds: type: array items: type: string totalSaleAmountFrom: minimum: 0.01 type: number totalSaleAmountTo: minimum: 0.01 type: number totalRefundAmountFrom: minimum: 0 type: number totalRefundAmountTo: minimum: 0 type: number totalChargesFrom: minimum: 0 type: number totalChargesTo: minimum: 0 type: number totalGstFrom: minimum: 0 type: number totalGstTo: minimum: 0 type: number totalSettlementAmountFrom: type: number totalSettlementAmountTo: type: number payoutStatus: type: string enum: - INIT - SUCCESS - FAILED - IN_PROGRESS - ON_HOLD utr: type: string payoutDateFrom: type: string format: date-time payoutDateTo: type: string format: date-time createdOnFrom: type: string format: date-time createdOnTo: type: string format: date-time x-apidog-orders: - 01J0R3SQ631WAHTTX1K3FAH4GP x-apidog-ignore-properties: - merchantDetailId - settlementPayoutId - settlementPayoutIds - totalSaleAmountFrom - totalSaleAmountTo - totalRefundAmountFrom - totalRefundAmountTo - totalChargesFrom - totalChargesTo - totalGstFrom - totalGstTo - totalSettlementAmountFrom - totalSettlementAmountTo - payoutStatus - utr - payoutDateFrom - payoutDateTo - createdOnFrom - createdOnTo example: {} responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/ApplicationResponseGenericPaginationResponseSettlementPayoutResponse example: response_code: 0 response_message: Success payload: recordsCount: 2 data: - settlementPayoutId: SPGJ11111111F4 totalSaleAmount: 30.6 totalRefundAmount: 0 totalCharges: 0.0153 totalGst: 0.0029 totalSettlementAmount: 28.56 refundChargebackAmount: 0 carryForwardAmount: 0 adjustmentAmount: 0 payoutStatus: SUCCESS utr: AXIS11111183236 remarks: AUTO_T1_RELEASE merchantName: Test Merchant payoutDate: '2026-06-17 17:20:06' createdOn: '2026-06-17 17:10:00' walletFundAdjustment: 0 instantSettlementCharges: 0 instantSettlementGst: 0 transactionsCount: 7 settlementType: NORMAL splitTransactionCharges: 0 splitTransactionGst: 0 - settlementPayoutId: SP1111147IVP1D totalSaleAmount: 3 totalRefundAmount: 0 totalCharges: 0.0015 totalGst: 0.0003 totalSettlementAmount: 3 refundChargebackAmount: 0 carryForwardAmount: 0 adjustmentAmount: 0 payoutStatus: SUCCESS utr: AXISC1117446 remarks: AUTO_T1_RELEASE merchantName: Test Merchant payoutDate: '2026-06-20 20:20:01' createdOn: '2026-06-20 20:00:01' walletFundAdjustment: 0 instantSettlementCharges: 0 instantSettlementGst: 0 transactionsCount: 3 settlementType: NORMAL splitTransactionCharges: 0 splitTransactionGst: 0 splitAccount: splitAccountDetailId: SADCD111111113PS0 name: Test Split label: TESTSPLIT accountNumber: '12343212343' ifsc: IDFB0021416 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-8990256-run components: schemas: SearchSettlementPayoutRequest: type: object properties: merchantDetailId: type: string settlementPayoutId: type: string settlementPayoutIds: type: array items: type: string totalSaleAmountFrom: minimum: 0.01 type: number totalSaleAmountTo: minimum: 0.01 type: number totalRefundAmountFrom: minimum: 0 type: number totalRefundAmountTo: minimum: 0 type: number totalChargesFrom: minimum: 0 type: number totalChargesTo: minimum: 0 type: number totalGstFrom: minimum: 0 type: number totalGstTo: minimum: 0 type: number totalSettlementAmountFrom: type: number totalSettlementAmountTo: type: number payoutStatus: type: string enum: - INIT - SUCCESS - FAILED - IN_PROGRESS - ON_HOLD utr: type: string payoutDateFrom: type: string format: date-time payoutDateTo: type: string format: date-time createdOnFrom: type: string format: date-time createdOnTo: type: string format: date-time x-apidog-orders: - merchantDetailId - settlementPayoutId - settlementPayoutIds - totalSaleAmountFrom - totalSaleAmountTo - totalRefundAmountFrom - totalRefundAmountTo - totalChargesFrom - totalChargesTo - totalGstFrom - totalGstTo - totalSettlementAmountFrom - totalSettlementAmountTo - payoutStatus - utr - payoutDateFrom - payoutDateTo - createdOnFrom - createdOnTo x-apidog-ignore-properties: [] x-apidog-folder: '' ApplicationResponseGenericPaginationResponseSettlementPayoutResponse: type: object properties: response_code: type: integer format: int32 response_message: type: string payload: $ref: >- #/components/schemas/GenericPaginationResponseSettlementPayoutResponse x-apidog-orders: - response_code - response_message - payload x-apidog-ignore-properties: [] x-apidog-folder: '' GenericPaginationResponseSettlementPayoutResponse: type: object properties: recordsCount: type: integer format: int64 data: type: array items: $ref: '#/components/schemas/SettlementPayoutResponse' x-apidog-orders: - recordsCount - data x-apidog-ignore-properties: [] x-apidog-folder: '' SettlementPayoutResponse: 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 remarks: type: string payoutRemarks: type: string transferId: type: string transferResponseReason: type: string merchantName: type: string payoutDate: type: string format: date-time createdOn: type: string format: date-time x-apidog-orders: - settlementPayoutId - totalSaleAmount - totalRefundAmount - totalCharges - totalGst - totalSettlementAmount - refundChargebackAmount - carryForwardAmount - adjustmentAmount - payoutStatus - payoutMode - utr - remarks - payoutRemarks - transferId - transferResponseReason - merchantName - payoutDate - createdOn x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: {} servers: - url: https://ekpayout-uat.enkash.in description: Testing Env security: [] ```