POST
/
subscriptions
/
{subscription_id}
/
refunds

Authorizations

x-client-id
string
headerrequired

Client app ID. You can find your app id in the Merchant Dashboard.

x-client-secret
string
headerrequired

Client secret key. You can find your secret in the Merchant Dashboard.

Headers

x-api-version
string
default: 2023-08-01required

API version to be used. Format is in YYYY-MM-DD

x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

x-idempotency-key
string

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Path Parameters

subscription_id
string
required

Provide the SubscriptionId using which the subscription was created.

Body

application/json

Request body to create a subscription refund.

subscription_id
string
required

A unique ID passed by merchant for identifying the subscription.

refund_id
string
required

A unique ID passed by merchant for identifying the refund.

refund_amount
number
required

The amount to be refunded. Can be partial or full amount of the payment.

payment_id
string

A unique ID passed by merchant for identifying the transaction.

refund_note
string

Refund note.

refund_speed
string

Refund speed. Can be INSTANT or STANDARD. UPI supports only STANDARD refunds, Enach and Pnach supports only INSTANT refunds.

Response

200 - application/json

Get/Create Subscription Payment Refund Response

payment_id
string

A unique ID passed by merchant for identifying the transaction.

cf_payment_id
string

Cashfree subscription payment reference number.

refund_id
string

A unique ID passed by merchant for identifying the refund.

cf_refund_id
string

Cashfree subscription payment refund reference number.

refund_amount
number

The refund amount.

refund_note
string

Refund note.

refund_speed
string

Refund speed. Can be INSTANT or NORMAL.

refund_status
string

Status of the refund.