Skip to main content
POST
/
ppi
/
wallet
/
closure
Close Wallet
curl --request POST \
  --url https://api.cashfree.com/ppi/wallet/closure \
  --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 '
{
  "closure_id": "CLOSURE420984",
  "user_id": "USER827364",
  "wallet_id": "WALLET936721",
  "cf_sub_wallet_id": "35246543210987654321",
  "remarks": "Wallet Closure",
  "notes": {
    "example_key1": "example_value1",
    "example_key2": "example_value2"
  }
}
'
{
  "closure_id": "CLOSURE420984",
  "user_id": "USER827364",
  "cf_closure_id": "8901234567890123456",
  "wallet_id": "WALLET936721",
  "sub_wallet": {
    "cf_sub_wallet_id": "35246543210987654321",
    "name": "Gift Wallet",
    "type": "GIFT_PPI",
    "status": "CLOSED",
    "balance": 0,
    "available_balance": 0,
    "funds_on_hold": 0
  },
  "status": "SUCCESS",
  "remarks": "Wallet Closure",
  "notes": {
    "example_key1": "example_value1",
    "example_key2": "example_value2"
  },
  "initiated_at": "2025-07-28T10:30:00Z",
  "processed_at": "2025-07-28T10:30:00Z"
}

Closure Status Descriptions

The following table outlines the possible status values returned in the closure response:
StatusDescription
SUCCESSThe wallet closure has been processed successfully and the sub-wallet is now inactive. All remaining balance has been handled according to the closure policy.
PENDINGThe closure request has been accepted and is currently being processed.
APPROVAL_PENDINGThe closure request requires manual approval.

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 close a user's wallet.

ā€‹
closure_id
string
required

Unique identifier that you create to identify the closure transaction in your system. Maximum 50 characters. Only alphanumeric characters, periods (.), hyphens (-), and underscores (_) are allowed.

Required string length: 1 - 50
Example:

"CLOSURE420984"

ā€‹
user_id
string
required

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

Required string length: 1 - 50
Example:

"USER827364"

ā€‹
wallet_id
string
required

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

Required string length: 1 - 50
Example:

"WALLET936721"

ā€‹
cf_sub_wallet_id
string
required

Unique identifier of the sub-wallet to be closed.

Required string length: 1 - 50
Example:

"35246543210987654321"

ā€‹
remarks
string

Additional remarks for the closure request. Alphanumeric and whitespaces are allowed. The maximum character limit is 500.

Maximum string length: 500
Example:

"Wallet Closure"

ā€‹
notes
object

Optional key-value pairs for any extra information. Keys and values must be strings.

Response

Success response for closing a wallet.

ā€‹
closure_id
string

Unique identifier for the closure transaction, as provided by you during the closure request.

Example:

"CLOSURE420984"

ā€‹
user_id
string

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

Example:

"USER827364"

ā€‹
cf_closure_id
string

Unique identifier for the closure transaction, generated by Cashfree.

Example:

"8901234567890123456"

ā€‹
wallet_id
string

Primary wallet ID from which the sub-wallet is being closed.

Example:

"WALLET936721"

ā€‹
sub_wallet
object
ā€‹
status
enum<string>

Status of the refund operation:

  • SUCCESS: Closure has been processed successfully.
  • PENDING: Closure is being processed and will be completed shortly
  • APPROVAL_PENDING : closure requires manual approval
Available options:
SUCCESS,
PENDING,
APPROVAL_PENDING
Example:

"SUCCESS"

ā€‹
remarks
string

Remarks for the closure transaction.

Example:

"Wallet Closure"

ā€‹
notes
object

Optional key-value pairs for any extra information. Keys and values must be strings.

ā€‹
initiated_at
string<date-time>

Timestamp when the closure transaction was initiated.

Example:

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

ā€‹
processed_at
string<date-time> | null

Timestamp when the closure transaction was processed. Null if still pending.

Example:

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