Skip to main content
POST
/
ppi
/
wallet
/
debit
Debit Funds from a User Sub-Wallet
curl --request POST \
  --url https://api.cashfree.com/ppi/wallet/debit \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "debit_id": "debit420984",
  "user_id": "1234567890123456789",
  "wallet_id": "9876543210987654321",
  "sub_wallet_id": "5432109876543210987",
  "amount": 600,
  "remarks": "Purchase of electronics item"
}'
{
  "debit_id": "debit420984",
  "user_id": "1234567890123456789",
  "cf_debit_id": "8901234567890123456",
  "wallet_id": "9876543210987654321",
  "gift_codes": [
    {
      "gift_code": "GHO-8900-HKDH-8899",
      "amount_deducted": 100,
      "total_value": 100,
      "expiry": "2026-07-28T10:30:00Z"
    },
    {
      "gift_code": "NMK-8454-JKJD-4224",
      "amount_deducted": 500,
      "total_value": 600,
      "expiry": "2026-07-28T10:30:00Z"
    }
  ],
  "sub_wallet_id": "5432109876543210987",
  "sub_wallet_type": "GIFT_PPI",
  "status": "SUCCESS",
  "sub_status": "SUCCESS",
  "amount": 600,
  "initiated_at": "2025-07-28T10:30:00Z",
  "processed_at": "2025-07-28T10:30:00Z"
}

Authorizations

​
x-client-id
string
header
required

Your unique client identifier issued by Cashfree.

​
x-client-secret
string
header
required

The secret key associated with your client ID.

Body

application/json
​
debit_id
string
required

Unique identifier for the debit transaction.

Required string length: 1 - 100
Example:

"7234567890123456789"

​
user_id
string
required

Unique identifier for the user.

Required string length: 1 - 50
Example:

"1234567890123456789"

​
sub_wallet_id
string
required

Sub-wallet ID from which the amount will be debited.

Required string length: 1 - 100
Example:

"5432109876543210987"

​
amount
number
required

Amount to be debited. Decimal values are allowed. The minimum value should be equal to or greater than 1.00 (>= 1.00).

Required range: x >= 1
Example:

100.5

​
wallet_id
string

Primary wallet ID from which the amount will be debited.

Required string length: 1 - 100
Example:

"9876543210987654321"

​
remarks
string

Optional remarks or description for the debit transaction.

Maximum length: 500
Example:

"Payment for subscription service"

Response

Debit request processed successfully.

​
debit_id
string

Unique identifier for the debit transaction.

Example:

"7234567890123456789"

​
cf_debit_id
string

Cashfree internal debit ID.

Example:

"8901234567890123456"

​
wallet_id
string

Primary wallet ID from which the amount was debited.

Example:

"9876543210987654321"

​
user_id
string

Unique identifier for the user.

Example:

"1234567890123456789"

​
gift_codes
object[]

List of gift codes used in the transaction are applicable for GIFT type wallets.

​
sub_wallet_id
string

Sub-wallet ID from which the amount was debited.

Example:

"5432109876543210987"

​
sub_wallet_type
string

Type of the sub-wallet.

Example:

"GIFT_PPI"

​
status
string

Status of the debit transaction.

Example:

"SUCCESS"

​
sub_status
string

Sub-status providing more details about the debit operation.

Example:

"SUCCESS"

​
amount
number

Amount that was debited.

Example:

600

​
initiated_at
string<date-time>

Timestamp when the debit transaction was initiated.

Example:

"2025-07-28T10:30:00Z"

​
processed_at
string<date-time>

Timestamp when the debit transaction was processed.

Example:

"2025-07-28T10:30:00Z"

⌘I