Skip to main content
POST
Credit Wallet

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 credit funds to a user's sub-wallet.

credit_id
string
required

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

Required string length: 1 - 50
Example:

"CREDIT126345"

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 which the amount will be credited. Only numeric characters are allowed.

Required string length: 1 - 19
Example:

"35246543210987654321"

amount
number<double>
required

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

Example:

100.5

remarks
string

Alphanumeric and whitespaces are allowed. The maximum character limit is 60.

Example:

"Refund for order #123"

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 crediting a wallet.

credit_id
string

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

Example:

"CREDIT126345"

cf_credit_id
string

Unique identifier for the credit transaction, generated by Cashfree.

Example:

"8901234567890123456"

wallet_id
string

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

Example:

"WALLET936721"

user_id
string

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

Example:

"USER827364"

amount
number<double>

Amount that was credited.

Example:

100.5

sub_wallet
object
issued_gift_codes
object[]
status
string

Status of the credit operation.

Example:

"SUCCESS"

remarks
string

Remarks for the credit transaction.

Example:

"Refund for order 123"

initiated_at
string<date-time>

Timestamp when the credit transaction was initiated.

Example:

"2025-09-02T10:15:30Z"

processed_at
string<date-time>

Timestamp when the credit transaction was processed.

Example:

"2025-09-02T10:20:45Z"

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.