Search Settlement Payouts

POST

/api/v0/settlement-payout/search

📌

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.

Request

Query Params

Header Params

Body Params application/json

Example

{
    
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v0/settlement-payout/search?offset=&limit=&orderBy=&direction=' \
--header 'Authorization;' \
--header 'merchantAccessKey;' \
--header 'Content-Type: application/json' \
--data-raw '{
    
}'

Responses

🟢200OK

application/json

Body

Example

{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "recordsCount": 0,
        "data": [
            {
                "settlementPayoutId": "string",
                "totalSaleAmount": 0,
                "totalRefundAmount": 0,
                "totalCharges": 0,
                "totalGst": 0,
                "totalSettlementAmount": 0,
                "refundChargebackAmount": 0,
                "carryForwardAmount": 0,
                "adjustmentAmount": 0,
                "payoutStatus": "INIT",
                "payoutMode": "IMPS",
                "utr": "string",
                "remarks": "string",
                "payoutRemarks": "string",
                "transferId": "string",
                "transferResponseReason": "string",
                "merchantName": "string",
                "payoutDate": "2019-08-24T14:15:22Z",
                "createdOn": "2019-08-24T14:15:22Z",
                "modifiedOn": "2019-08-24T14:15:22Z"
            }
        ]
    }
}

Modified at 2025-07-05 11:23:32

Get Settlement Payout By ID

Split Settlement