Skip to main content
POST
/
api
/
v2
/
subscriptions
/
create-refund
Create Subscription Refund
curl --request POST \
  --url https://sandbox.cashfree.com/api/v2/subscriptions/create-refund \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <x-client-id>' \
  --header 'X-Client-Secret: <x-client-secret>' \
  --data '{
  "paymentId": "1223",
  "refundAmount": 100,
  "refundNote": "Charge refund",
  "merchantRefundId": "test-refund",
  "requestedSpeed": "STANDARD"
}'
{
  "subRefundId": "SUB_76d688d5-cbcc-49ea-960b-21b11433b641",
  "merchantRefundId": "test-refund",
  "paymentId": 1223,
  "subReferenceId": 191645,
  "refundAmount": 100,
  "refundStatus": "INITIALIZED"
}

Headers

ā€‹
X-Client-Id
string
required

Client ID provided by Cashfree.

Example:

"asdf1234"

ā€‹
X-Client-Secret
string
required

Client Secret provided by Cashfree.

Example:

"qwer9876"

Body

application/json
ā€‹
paymentId
string

Payment ID for which the refund is to be created.

Example:

"1223"

ā€‹
refundAmount
number

Amount to be refunded.

Example:

100

ā€‹
refundNote
string

Note associated with the refund.

Example:

"Charge refund"

ā€‹
merchantRefundId
string

Unique ID for the merchant's refund request.

Example:

"test-refund"

ā€‹
requestedSpeed
string

The requested speed for processing the refund (e.g., STANDARD).

Example:

"STANDARD"

Response

Successful creation of the refund.

The response is of type any.