Enkash APIs
Search Settlement Payouts
POST/api/v0/settlement-payout/searchRequest
Query Params
offset
integer
optional
limit
integer
optional
<= 5000
orderBy
string
optional
direction
enum<string>
optional
Allowed values:
ASCDESC
Header Params
Authorization
string
required
merchantAccessKey
string
required
Body Params application/json
merchantDetailId
string
optional
settlementPayoutId
string
optional
settlementPayoutIds
array[string]
optional
totalSaleAmountFrom
number
optional
>= 0.01
totalSaleAmountTo
number
optional
>= 0.01
totalRefundAmountFrom
number
optional
>= 0
totalRefundAmountTo
number
optional
>= 0
totalChargesFrom
number
optional
>= 0
totalChargesTo
number
optional
>= 0
totalGstFrom
number
optional
>= 0
totalGstTo
number
optional
>= 0
totalSettlementAmountFrom
number
optional
totalSettlementAmountTo
number
optional
payoutStatus
enum<string>
optional
Allowed values:
INITSUCCESSFAILEDIN_PROGRESSON_HOLD
utr
string
optional
payoutDateFrom
string <date-time>
optional
payoutDateTo
string <date-time>
optional
createdOnFrom
string <date-time>
optional
createdOnTo
string <date-time>
optional
Example
{}Request samples
Responses
OK(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
response_code
integer <int32>
optional
response_message
string
optional
payload
object (GenericPaginationResponseSettlementPayoutResponse)
optional
recordsCount
integer <int64>
optional
data
array[object (SettlementPayoutResponse) {20}]
optional
Example
Not configured
Last modified: 3 months ago