Get Wallet Statement

curl --request POST \
  --url https://api.cashfree.com/ppi/wallet/statement \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "user_id": "USER827364",
  "wallet_id": "WALLET124",
  "cf_sub_wallet_id": "5432109876543210987"
}
'

{
  "wallet_id": "WALLET124",
  "user_id": "USER827364",
  "has_next": true,
  "has_prev": false,
  "sub_wallet": {
    "cf_sub_wallet_id": "5432109876543210987",
    "name": "Gift Wallet",
    "type": "GIFT_PPI",
    "status": "ACTIVE",
    "balance": 1500.75,
    "available_balance": 1500.75,
    "funds_on_hold": 0
  },
  "statement_period": {
    "from": "2025-06-01T00:00:00Z",
    "to": "2025-12-01T00:00:00Z"
  },
  "statements": [
    {
      "flow_type": "CREDIT",
      "cf_statement_id": "8905234567890123406",
      "credit_id": "CREDIT126345",
      "cf_credit_id": "8901234567890123456",
      "amount": 1600,
      "closing_balance": 1600,
      "issued_gift_code": {
        "code": "GIFT-2025-XYZ123",
        "value": 1600,
        "expiry": "2026-06-15T10:15:45Z"
      },
      "event_type": "RECHARGE",
      "remarks": "Recharge for order 123",
      "initiated_at": "2025-06-15T14:15:30Z",
      "processed_at": "2025-06-15T14:15:45Z"
    },
    {
      "flow_type": "DEBIT",
      "cf_statement_id": "8904234567890123405",
      "debit_id": "DEBIT420984",
      "cf_debit_id": "890123456789012345",
      "amount": 600,
      "closing_balance": 1000,
      "applied_gift_codes": [
        {
          "code": "GIFT-2025-XYZ213",
          "amount_debited": 100,
          "value": 100,
          "expiry": "2026-07-28T10:30:00Z"
        },
        {
          "code": "GIFT-2025-XYZ444",
          "amount_debited": 500,
          "value": 600,
          "expiry": "2026-07-28T10:30:00Z"
        }
      ],
      "event_type": "DEBIT",
      "remarks": "Purchase of phone cover",
      "initiated_at": "2025-06-14T13:10:00Z",
      "processed_at": "2025-06-14T13:10:15Z"
    },
    {
      "flow_type": "CREDIT",
      "cf_statement_id": "8903234567890123405",
      "refund_id": "REFUND420984",
      "cf_refund_id": "890223456789012345",
      "amount": 200,
      "closing_balance": 800,
      "refunded_gift_codes": [
        {
          "code": "GIFT-2025-XYZ913",
          "amount_refunded": 100,
          "value": 100,
          "expiry": "2026-07-28T10:30:00Z"
        },
        {
          "code": "GIFT-2025-XYZ544",
          "amount_refunded": 500,
          "value": 100,
          "expiry": "2026-07-28T10:30:00Z"
        }
      ],
      "event_type": "DEBIT_REFUND",
      "remarks": "Refund for order 123",
      "initiated_at": "2025-06-14T12:12:00Z",
      "processed_at": "2025-06-14T12:12:15Z"
    },
    {
      "flow_type": "DEBIT",
      "cf_statement_id": "8902234567890123405",
      "amount": 100,
      "closing_balance": 700,
      "event_type": "INACTIVE",
      "remarks": "Sub-Wallet marked inactive due to inactivity",
      "initiated_at": "2025-06-14T11:10:00Z",
      "processed_at": "2025-06-14T11:10:15Z"
    },
    {
      "flow_type": "DEBIT",
      "cf_statement_id": "8901234567890123405",
      "amount": 100,
      "closing_balance": 600,
      "event_type": "EXPIRY",
      "remarks": "Gift-Code Expired",
      "initiated_at": "2025-06-14T10:10:00Z",
      "processed_at": "2025-06-14T10:10:15Z"
    },
    {
      "flow_type": "DEBIT",
      "cf_statement_id": "8901234567890123405",
      "closure_id": "CLOSURE420984",
      "cf_closure_id": "890023456789012145",
      "amount": 600,
      "closing_balance": 0,
      "event_type": "CLOSURE",
      "remarks": "Sub-Wallet Closed",
      "initiated_at": "2025-06-14T09:10:00Z",
      "processed_at": "2025-06-14T09:10:15Z"
    }
  ]
}

Wallet Management

Get Wallet Statement

Retrieves a paginated wallet statement for a user, including both credit and debit transactions for a specific sub-wallet.

The statement can be fetched for a specified date range. If no range is provided, the API returns transactions from the last 6 months.
The from date cannot be earlier than 1 year from the current date.
Pagination is handled using the after and before parameters, which define the cf_statement_id boundary for retrieving the next or previous set of records.
Only one of after or before can be passed at a time.

POST

ppi

wallet

statement

Get Wallet Statement

curl --request POST \
  --url https://api.cashfree.com/ppi/wallet/statement \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "user_id": "USER827364",
  "wallet_id": "WALLET124",
  "cf_sub_wallet_id": "5432109876543210987"
}
'

{
  "wallet_id": "WALLET124",
  "user_id": "USER827364",
  "has_next": true,
  "has_prev": false,
  "sub_wallet": {
    "cf_sub_wallet_id": "5432109876543210987",
    "name": "Gift Wallet",
    "type": "GIFT_PPI",
    "status": "ACTIVE",
    "balance": 1500.75,
    "available_balance": 1500.75,
    "funds_on_hold": 0
  },
  "statement_period": {
    "from": "2025-06-01T00:00:00Z",
    "to": "2025-12-01T00:00:00Z"
  },
  "statements": [
    {
      "flow_type": "CREDIT",
      "cf_statement_id": "8905234567890123406",
      "credit_id": "CREDIT126345",
      "cf_credit_id": "8901234567890123456",
      "amount": 1600,
      "closing_balance": 1600,
      "issued_gift_code": {
        "code": "GIFT-2025-XYZ123",
        "value": 1600,
        "expiry": "2026-06-15T10:15:45Z"
      },
      "event_type": "RECHARGE",
      "remarks": "Recharge for order 123",
      "initiated_at": "2025-06-15T14:15:30Z",
      "processed_at": "2025-06-15T14:15:45Z"
    },
    {
      "flow_type": "DEBIT",
      "cf_statement_id": "8904234567890123405",
      "debit_id": "DEBIT420984",
      "cf_debit_id": "890123456789012345",
      "amount": 600,
      "closing_balance": 1000,
      "applied_gift_codes": [
        {
          "code": "GIFT-2025-XYZ213",
          "amount_debited": 100,
          "value": 100,
          "expiry": "2026-07-28T10:30:00Z"
        },
        {
          "code": "GIFT-2025-XYZ444",
          "amount_debited": 500,
          "value": 600,
          "expiry": "2026-07-28T10:30:00Z"
        }
      ],
      "event_type": "DEBIT",
      "remarks": "Purchase of phone cover",
      "initiated_at": "2025-06-14T13:10:00Z",
      "processed_at": "2025-06-14T13:10:15Z"
    },
    {
      "flow_type": "CREDIT",
      "cf_statement_id": "8903234567890123405",
      "refund_id": "REFUND420984",
      "cf_refund_id": "890223456789012345",
      "amount": 200,
      "closing_balance": 800,
      "refunded_gift_codes": [
        {
          "code": "GIFT-2025-XYZ913",
          "amount_refunded": 100,
          "value": 100,
          "expiry": "2026-07-28T10:30:00Z"
        },
        {
          "code": "GIFT-2025-XYZ544",
          "amount_refunded": 500,
          "value": 100,
          "expiry": "2026-07-28T10:30:00Z"
        }
      ],
      "event_type": "DEBIT_REFUND",
      "remarks": "Refund for order 123",
      "initiated_at": "2025-06-14T12:12:00Z",
      "processed_at": "2025-06-14T12:12:15Z"
    },
    {
      "flow_type": "DEBIT",
      "cf_statement_id": "8902234567890123405",
      "amount": 100,
      "closing_balance": 700,
      "event_type": "INACTIVE",
      "remarks": "Sub-Wallet marked inactive due to inactivity",
      "initiated_at": "2025-06-14T11:10:00Z",
      "processed_at": "2025-06-14T11:10:15Z"
    },
    {
      "flow_type": "DEBIT",
      "cf_statement_id": "8901234567890123405",
      "amount": 100,
      "closing_balance": 600,
      "event_type": "EXPIRY",
      "remarks": "Gift-Code Expired",
      "initiated_at": "2025-06-14T10:10:00Z",
      "processed_at": "2025-06-14T10:10:15Z"
    },
    {
      "flow_type": "DEBIT",
      "cf_statement_id": "8901234567890123405",
      "closure_id": "CLOSURE420984",
      "cf_closure_id": "890023456789012145",
      "amount": 600,
      "closing_balance": 0,
      "event_type": "CLOSURE",
      "remarks": "Sub-Wallet Closed",
      "initiated_at": "2025-06-14T09:10:00Z",
      "processed_at": "2025-06-14T09:10:15Z"
    }
  ]
}

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

The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.

Headers

x-api-version

string

default:2025-11-01

required

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

Example:

"2025-11-01"

Body

application/json

Request parameters to fetch the user's wallet statement for a given period.

user_id

string

required

Unique identifier for the user, as provided by you during PPI user creation.

Maximum string length: 50

Pattern: ^[a-zA-Z0-9_.-]+$

wallet_id

string

required

Unique identifier for the wallet, as provided by you during wallet creation.

Maximum string length: 50

Pattern: ^[a-zA-Z0-9_.-]+$

Example:

"WALLET124"

cf_sub_wallet_id

string

required

Unique identifier for the sub-wallet provided in response while creating the wallet.

Maximum string length: 50

Pattern: ^[0-9]+$

Example:

"5432109876543210987"

from

string<date-time>

Start date for the wallet statement in UTC. If not provided, the API defaults to 6 months before the current date-time. It cannot be earlier than 1 year from the current date

Example:

"2025-01-01T00:00:00Z"

string<date-time>

End date for the wallet statement in UTC. If not provided, the API defaults to the current date-time. Cannot be greater than the current date-time.

Example:

"2025-02-01T00:00:00Z"

limit

integer

Maximum number of records to return. Default value is 10.

Required range: x <= 50

Example:

10

after

string

The cf_statement_id after which statement should be fetched. When after is provided, the before parameter must not be used.

Example:

"5432109876543210987"

before

string

The cf_statement_id before which statement should be fetched. When before is provided, the after parameter must not be used.

Example:

"5432109876543210987"

Response

Success response for fetching the wallet statement.

wallet_id

string

Unique identifier for the wallet, as provided by you during wallet creation.

Example:

"WALLET124"

user_id

string

Unique identifier for the user, as provided by you during user creation.

Example:

"USER827364"

has_next

boolean

Indicates whether there are additional transactions after the current set within the requested statement period.

Example:

true

has_prev

boolean

Indicates whether there are additional transactions before the current set within the requested statement period..

Example:

true

sub_wallet

object

Show child attributes

statement_period

object

Show child attributes

statements

object[]

Show child attributes

Get Wallet Details Wallet Webhooks

⌘I