Skip to main content
POST
/
bbps
/
cou
/
agent
/
{agentId}
/
wallet
/
ledger
Fetch Agent Wallet Ledger
curl --request POST \
  --url https://sandbox.cashfree.com/bbps/cou/agent/{agentId}/wallet/ledger \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "start_date_time": "2025-01-01 00:00:00",
  "end_date_time": "2025-01-31 23:59:59",
  "sale_type": "DEBIT",
  "utr": "UTR123456789"
}
'
{
  "content": [
    {
      "id": 1001,
      "wallet_id": 42,
      "sale_type": "DEBIT",
      "amount": 250,
      "closing_balance": 4750,
      "utr": "UTR123456789",
      "added_on": "2025-01-15 10:30:00",
      "updated_on": "2025-01-15 10:30:05"
    }
  ],
  "size": 20,
  "page": 0,
  "last": true
}

Documentation Index

Fetch the complete documentation index at: https://www.cashfree.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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.

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