Skip to main content
POST
Fetch Agent Institution Wallet Ledger

Authorizations

x-client-id
string
header
required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

x-client-secret
string
header
required

Your unique client secret issued by Cashfree. Keep this confidential and never expose it in client-side code. You can find this in your Merchant Dashboard.

Headers

x-api-version
string
default:2025-01-01
required

API version to be used. Format is YYYY-MM-DD.

Path Parameters

agentId
string
required

The BBPS Agent ID (bbpsAgentId) of the Agent Institution.

Query Parameters

page
integer
default:0

Zero-indexed page number. Default is 0.

size
integer
default:20

Number of entries per page. Default is 20.

Body

application/json

Request parameters to filter wallet ledger entries.

start_date_time
string

Filter entries from this datetime. Format: yyyy-MM-dd HH:mm:ss.

Example:

"2025-01-01 00:00:00"

end_date_time
string

Filter entries up to this datetime. Format: yyyy-MM-dd HH:mm:ss.

Example:

"2025-01-31 23:59:59"

sale_type
enum<string>

Filter by transaction type.

Available options:
CREDIT,
DEBIT
Example:

"DEBIT"

utr
string

Filter by Unique Transaction Reference number.

Example:

"UTR123456789"

Response

Success response for fetching a paginated list of wallet ledger entries for a given Agent Institution.

content
object[]

List of ledger entries for the current page.

size
integer

Number of entries per page.

Example:

20

page
integer

Current page number (zero-indexed).

Example:

0

last
boolean

Indicates whether this is the last page.

Example:

true