Skip to main content
POST
Close Wallet

Closure Status Descriptions

The following table outlines the possible status values returned in the closure response:

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. 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. Only alphanumeric characters, periods (.), hyphens (-), and underscores (_) are allowed.

Required string length: 1 - 50
Example:

"USER827364"

wallet_id
string
required

Unique identifier for the wallet, as provided by you during wallet creation. Only alphanumeric characters, periods (.), hyphens (-), and underscores (_) are allowed.

Required string length: 1 - 50
Example:

"WALLET936721"

cf_sub_wallet_id
string
required

Unique identifier of the sub-wallet to be closed. Only numeric characters are allowed.

Required string length: 1 - 19
Example:

"35246543210987654321"

remarks
string

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

Maximum string length: 60
Example:

"Wallet Closure"

notes
object

Optional key-value pairs for any extra information. Keys and values must be strings. The following constraints apply:

  • Maximum 10 entries.
  • Keys: maximum 50 characters. Alphanumeric characters, underscores (_), periods (.), commas (,), single quotes ('), ampersands (&), hyphens (-), and spaces are allowed.
  • Values: maximum 200 characters. Same character set as keys.

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. The following constraints apply:

  • Maximum 10 entries.
  • Keys: maximum 50 characters. Alphanumeric characters, underscores (_), periods (.), commas (,), single quotes ('), ampersands (&), hyphens (-), and spaces are allowed.
  • Values: maximum 200 characters. Same character set as keys.
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"