- Payment Gateway Overview
- Getting Started
- Payment Methods
- Integration
- API Endpoints
- APIs
- Authorisation
- Order
- Payment
- Refund
- Settlement
- Split Settlement
- E-Commerce Plugins
- Payment Button
- Qr Code
- UPI Mandate
- Payment Links
- Authorisation
Search Settlement Payouts
POST
/api/v0/settlement-payout/search
Request
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
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v0/settlement-payout/search' \
--header 'Authorization;' \
--header 'merchantAccessKey;' \
--header 'Content-Type: application/json' \
--data-raw '{
}'Responses
🟢200OK
application/json
Body
response_code
integer <int32>
optional
response_message
string
optional
payload
object (GenericPaginationResponseSettlementPayoutResponse)
optional
recordsCount
integer <int64>
optional
data
array[object (SettlementPayoutResponse) {20}]
optional
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"
}
]
}
}