📌Use this API to search for payout transfers that you have initiated, by providing the appropriate request parameters. This API supports multiple use cases, including:
Check the status of a specific transaction by searching with transactionId
Get the status of all transactions in a batch by searching with batchTransactionId
Retrieve transactions initiated within a specific date range by using createdOnFrom and createdOnTo This helps you efficiently track, reconcile, and audit your payout activity.
PayoutTransactionSearchRequest
batchTransactionId
string
optional
transactionId
string
optional
bankAccountNumber
string
optional
ifsc
string
optional
vpaHandle
string
optional
beneficiaryEmail
string
optional
beneficiaryPhone
string
optional
beneficiaryAddress
string
optional
beneficiaryCity
string
optional
beneficiaryState
string
optional
beneficiaryPincode
string
optional
beneficiaryName
string
optional
beneficiaryId
string
optional
amount
number
optional
totalAmount
number
optional
transactionMode
enum<string>
required
Allowed values:
PAYOUTREFUND
remarks
string
optional
sourceAccountId
string
optional
createdOnFrom
string<date-time>
optional
createdOnTo
string<date-time>
optional
companyId
string
optional
direction
enum<string>
optional
Allowed values:
ASCDESC
Default:
DESC
orderBy
string
optional
Default:
createdOn
offset
integer
optional
>= 0
Default:
0
limit
integer
optional
>= 0<= 100
Default:
100
Response will be list of PayoutTransactionSearchResponse object
PayoutTransactionSearchResponse
batchTransactionId
string
optional
transactionId
string
optional
bankAccountNumber
string
optional
ifsc
string
optional
vpaHandle
string
optional
beneficiaryEmail
string
optional
beneficiaryPhone
string
optional
beneficiaryAddress
string
optional
beneficiaryCity
string
optional
beneficiaryState
string
optional
beneficiaryPincode
string
optional
beneficiaryName
string
optional
beneficiaryId
string
optional
amount
number
optional
totalAmount
number
optional
transactionMode
enum<string>
required
Allowed values:
PAYOUTREFUND
status
string
required
utr
string
optional
remarks
string
optional
sourceAccountId
string
optional
referenceNumber
string
optional
reversalReferenceNumber
string
optional
createdOn
string<date-time>
required
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.