Search Payouts

Use this api to search payout transfers initiated by you by providing request parameters as needed.

API can be used for below use cases like:

To get status of a transaction by searching on transactionId

To get status of all the transactions in a batch request by searching on batchTransactionId

To search transactions initiated betweena defined range of dates by searching on createdOnFrom & createdOnTo

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:

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.

Example:

Authorization: Bearer ********************

Header Params

clientId

string

required

Example:

CEKxxxxxxx

User-Agent

string

required

Body Params application/json

request

string

required

Encrypted request payload string

Example

{
    "request": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Body

response_code

integer <int32>

optional

response_message

string

optional

payload

string

optional

Example

{
    "response_code": 0,
    "response_message": "string",
    "payload": "string"
}

Request

Request samples

Responses