PPI Wallet Webhooks

Cashfree sends event-based notifications when a wallet event occurs.

In rare cases, such as network retries, read timeouts, processing delays, or delivery failures, the same webhook might be sent more than once for the same event. To prevent unintended side effects, implement idempotency in your webhook handler to handle duplicate deliveries.

Webhook signature

You receive the webhook signature in the webhook header. The following table shows a sample header from a webhook request.

Header name	Header value
`content-length`	1099
`x-webhook-attempt`	1
`content-type`	application/json
`x-webhook-signature`	07r5C3VMwsGYeldGOCYxe5zoHhIN1zLfa8O0U/yngHI=
`x-webhook-timestamp`	1746427759733
`x-webhook-version`	2025-01-01

Always capture the webhook payload in its raw text format before parsing into JSON. Parsing and reserialising the payload can change the structure (for example, array ordering, spacing, or null handling) and cause a signature mismatch during verification. Use the exact raw body string from the request when computing the signature.

Wallet credit events

Cashfree sends the following event when a wallet credit succeeds:

Event	Description
`PPI_CREDIT_SUCCESS`	The credit completes successfully and Cashfree adds funds to the sub-wallet.

The following example shows a PPI_CREDIT_SUCCESS webhook for a GIFT_PPI sub-wallet. The issued_gift_codes array appears only for gift wallets.

{
  "event_type": "PPI_CREDIT_SUCCESS",
  "event_time": "2006-01-02T15:04:05Z",
  "data": {
    "credit_id": "CREDIT126345",
    "cf_credit_id": "8901234567890123456",
    "wallet_id": "WALLET936721",
    "user_id": "USER827364",
    "amount": 100.5,
    "sub_wallet": {
      "cf_sub_wallet_id": "35246543210987654321",
      "name": "Gift Wallet",
      "type": "GIFT_PPI",
      "status": "ACTIVE",
      "balance": 1500.75
    },
    "issued_gift_codes": [
      {
        "code": "GIFT-2025-XYZ123",
        "value": 100.5,
        "expiry": "2025-12-31T23:59:59Z"
      }
    ],
    "status": "SUCCESS",
    "remarks": "Refund for order 123",
    "initiated_at": "2025-09-02T10:15:30Z",
    "processed_at": "2025-09-02T10:20:45Z"
  }
}

Wallet credit webhook payload fields

The webhook payload contains important metadata in its top-level fields.

Field	Type	Description
`event_type`	`string`	Indicates the type of event that triggered the webhook. Possible value: `PPI_CREDIT_SUCCESS`.
`event_time`	`string`	The UTC timestamp of when the event occurred, formatted in ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`).
`data`	`object`	Contains credit-specific details. The object matches the successful Credit Wallet API response.

Wallet debit events

Cashfree sends a debit webhook when a wallet debit completes with SUCCESS. Webhooks are not sent while the debit is PENDING (for example, while OTP verification is in progress). For SMALL_PPI and FULL_KYC_PPI sub-wallets, the webhook is sent after you complete verification with the Verify Debit Wallet API. Cashfree sends the following event when a wallet debit succeeds:

Event	Description
`PPI_DEBIT_SUCCESS`	The debit completes successfully and Cashfree deducts funds from the sub-wallet.

The webhook data object uses status and status_code of SUCCESS. For other combinations returned by the Debit Wallet and Verify Debit Wallet APIs, see Status and status-code reference. The following example shows a PPI_DEBIT_SUCCESS webhook for a GIFT_PPI sub-wallet. The applied_gift_codes array appears only for gift wallets.

{
  "event_type": "PPI_DEBIT_SUCCESS",
  "event_time": "2025-07-28T10:30:00Z",
  "data": {
    "debit_id": "DEBIT420984",
    "user_id": "USER827364",
    "cf_debit_id": "8901234567890123456",
    "wallet_id": "WALLET936721",
    "sub_wallet": {
      "cf_sub_wallet_id": "35246543210987654321",
      "name": "Gift Wallet",
      "type": "GIFT_PPI",
      "status": "ACTIVE",
      "balance": 1500.75,
      "available_balance": 1500.75,
      "funds_on_hold": 0.0
    },
    "applied_gift_codes": [
      {
        "code": "GHO-8900-HKDH-8899",
        "amount_debited": 100.00,
        "value": 100.00,
        "expiry": "2026-07-28T10:30:00Z"
      },
      {
        "code": "NMK-8454-JKJD-4224",
        "amount_debited": 500.00,
        "value": 600.00,
        "expiry": "2026-07-28T10:30:00Z"
      }
    ],
    "status": "SUCCESS",
    "status_code": "SUCCESS",
    "amount": 600.00,
    "remarks": "Purchase of electronics item",
    "initiated_at": "2025-07-28T10:30:00Z",
    "processed_at": "2025-07-28T10:30:00Z",
    "notes": {
      "example_key1": "example_value1",
      "example_key2": "example_value2"
    }
  }
}

Wallet debit webhook payload fields

The webhook payload contains important metadata in its top-level fields.

Field	Type	Description
`event_type`	`string`	Indicates the type of event that triggered the webhook. Possible value: `PPI_DEBIT_SUCCESS`.
`event_time`	`string`	The UTC timestamp of when the event occurred, formatted in ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`).
`data`	`object`	Contains debit-specific details. The object matches the successful Debit Wallet API or Verify Debit Wallet API response.

Wallet refund events

Cashfree sends this webhook only when a refund completes successfully. Failed refunds or refunds that remain PENDING do not trigger a webhook. Cashfree sends the following event when a wallet refund succeeds:

Event	Description
`PPI_REFUND_SUCCESS`	The refund completes successfully and Cashfree credits the amount back to the sub-wallet.

The following examples show PPI_REFUND_SUCCESS webhooks for gift, closed-loop, and standard wallets. The refunded_gift_codes array is included only for GIFT_PPI refunds.

{
  "event_type": "PPI_REFUND_SUCCESS",
  "event_time": "2025-07-28T11:00:00Z",
  "data": {
    "refund_id": "REFUND420984",
    "debit_id": "DEBIT420984",
    "cf_refund_id": "9012345678901234567",
    "user_id": "USER827364",
    "wallet_id": "WALLET936721",
    "sub_wallet": {
      "cf_sub_wallet_id": "35246543210987654321",
      "name": "Standard Wallet",
      "type": "STANDARD_PPI",
      "status": "ACTIVE",
      "balance": 1600.75,
      "available_balance": 1600.75,
      "funds_on_hold": 0.0
    },
    "status": "SUCCESS",
    "amount": 100.00,
    "remarks": "Refund for cancelled order #ORD-001",
    "initiated_at": "2025-07-28T10:55:00Z",
    "processed_at": "2025-07-28T11:00:00Z",
    "notes": {
      "order_id": "ORD-001",
      "merchant_name": "Example Store"
    }
  }
}

{
  "event_type": "PPI_REFUND_SUCCESS",
  "event_time": "2025-07-28T11:00:00Z",
  "data": {
    "refund_id": "REFUND420986",
    "debit_id": "DEBIT420986",
    "cf_refund_id": "9012345678901234569",
    "user_id": "USER827364",
    "wallet_id": "WALLET936721",
    "sub_wallet": {
      "cf_sub_wallet_id": "35246543210987654322",
      "name": "Closed Loop Wallet",
      "type": "CLOSED_LOOP_PPI",
      "status": "ACTIVE",
      "balance": 1600.75,
      "available_balance": 1600.75,
      "funds_on_hold": 0.0
    },
    "status": "SUCCESS",
    "amount": 100.00,
    "remarks": "Refund for cancelled order #ORD-003",
    "initiated_at": "2025-07-28T10:55:00Z",
    "processed_at": "2025-07-28T11:00:00Z",
    "notes": {
      "order_id": "ORD-003",
      "merchant_name": "Example Store"
    }
  }
}

{
  "event_type": "PPI_REFUND_SUCCESS",
  "event_time": "2025-07-28T11:00:00Z",
  "data": {
    "refund_id": "REFUND420985",
    "debit_id": "DEBIT420985",
    "cf_refund_id": "9012345678901234568",
    "user_id": "USER827364",
    "wallet_id": "WALLET936721",
    "sub_wallet": {
      "cf_sub_wallet_id": "35246543210987654321",
      "name": "Gift Wallet",
      "type": "GIFT_PPI",
      "status": "ACTIVE",
      "balance": 600.00,
      "available_balance": 600.00,
      "funds_on_hold": 0.0
    },
    "status": "SUCCESS",
    "refunded_gift_codes": [
      {
        "code": "GHO-8900-HKDH-8899",
        "value": 100.00,
        "expiry": "2026-07-28T10:30:00Z",
        "amount_refunded": 100.00
      }
    ],
    "amount": 100.00,
    "remarks": "Refund for cancelled order #ORD-002",
    "initiated_at": "2025-07-28T10:55:00Z",
    "processed_at": "2025-07-28T11:00:00Z"
  }
}

Wallet refund webhook payload fields

The webhook payload contains important metadata in its top-level fields.

Field	Type	Description
`event_type`	`string`	Indicates the type of event that triggered the webhook. Possible value: `PPI_REFUND_SUCCESS`.
`event_time`	`string`	The UTC timestamp of when the event occurred, formatted in ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`).
`data`	`object`	Contains refund-specific details. The structure and fields match the `SUCCESS` state of the Refund Wallet API response.

Wallet refund data fields

The data object contains the following fields:

Field	Type	Description
`refund_id`	`string`	Your unique identifier for the refund.
`debit_id`	`string`	Your unique identifier for the original debit transaction that is being refunded.
`cf_refund_id`	`string`	Cashfree’s unique identifier for this refund.
`user_id`	`string`	Your unique identifier for the user.
`wallet_id`	`string`	Your unique identifier for the wallet.
`sub_wallet`	`object`	Details of the sub-wallet to which the refund was credited.
`sub_wallet.cf_sub_wallet_id`	`string`	Cashfree’s unique identifier for the sub-wallet.
`sub_wallet.name`	`string`	Name of the sub-wallet.
`sub_wallet.type`	`string`	Type of the sub-wallet. Possible values: `GIFT_PPI`, `CLOSED_LOOP_PPI`, and `STANDARD_PPI`.
`sub_wallet.status`	`string`	Current status of the sub-wallet (for example, `ACTIVE`).
`sub_wallet.balance`	`number`	Total balance in the sub-wallet after the refund, in INR.
`sub_wallet.available_balance`	`number`	Balance available for new transactions after the refund, in INR.
`sub_wallet.funds_on_hold`	`number`	Funds reserved for in-flight transactions, in INR.
`status`	`string`	Terminal status of the refund. Value: `SUCCESS`.
`refunded_gift_codes`	`array`	List of gift codes from which amounts were refunded. Present only for `GIFT_PPI` sub-wallets; omitted for all other sub-wallet types.
`refunded_gift_codes[].code`	`string`	The gift code from which the amount was refunded.
`refunded_gift_codes[].value`	`number`	Total face value of the gift code, in INR.
`refunded_gift_codes[].expiry`	`string`	Expiry timestamp of the gift code (ISO 8601).
`refunded_gift_codes[].amount_refunded`	`number`	Amount refunded from this specific gift code, in INR.
`amount`	`number`	Total refund amount, in INR.
`remarks`	`string`	Remarks provided when the refund was initiated.
`initiated_at`	`string`	Timestamp when the refund was initiated (ISO 8601).
`processed_at`	`string`	Timestamp when the refund reached a terminal state (ISO 8601).
`notes`	`object \| null`	Custom key-value pairs provided during refund creation. Returns `null` if no notes were set.

Verify the signature before you process any webhook payload. For more information, see Webhook signature verification.

​Webhook signature

​Wallet credit events

​Wallet credit webhook payload fields

​Wallet debit events

​Wallet debit webhook payload fields

​Wallet refund events

​Wallet refund webhook payload fields

​Wallet refund data fields

Webhook signature

Wallet credit events

Wallet credit webhook payload fields

Wallet debit events

Wallet debit webhook payload fields

Wallet refund events

Wallet refund webhook payload fields

Wallet refund data fields