POST
/
orders
/
{order_id}
/
refunds

Authorizations

x-client-id
string
header
required

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

x-client-secret
string
header
required

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

Headers

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

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

order_id
string
required

The id which uniquely identifies your order

Body

application/json

create refund request object

refund_amount
number
required

Amount to be refunded. Should be lesser than or equal to the transaction amount. (Decimals allowed)

refund_id
string
required

An unique ID to associate the refund with. Provie alphanumeric values

Required string length: 3 - 40
refund_note
string

A refund note for your reference.

Required string length: 3 - 100
refund_speed
enum<string>

Speed at which the refund is processed. It's an optional field with default being STANDARD

Available options:
STANDARD,
INSTANT
refund_splits
object[]

Response

200 - application/json

The refund entity

cf_payment_id
string

Cashfree Payments ID of the payment for which refund is initiated

cf_refund_id
string

Cashfree Payments ID for a refund

created_at
string

Time of refund creation

entity
enum<string>

Type of object

Available options:
refund
metadata
object

Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value pairs

order_id
string

Merchant’s order Id of the order for which refund is initiated

processed_at
string

Time when refund was processed successfully

refund_amount
number

Amount that is refunded

refund_arn
string

The bank reference number for refund

refund_charge
number

Charges in INR for processing refund

refund_currency
string

Currency of the refund amount

refund_id
string

Merchant’s refund ID of the refund

refund_mode
enum<string>

Method or speed of processing refund

Available options:
STANDARD,
INSTANT
refund_note
string

Note added by merchant for the refund

refund_speed
object

How fast refund has to be proecessed

refund_splits
object[]
refund_status
enum<string>

This can be one of ["SUCCESS", "PENDING", "CANCELLED", "ONHOLD", "FAILED"]

Available options:
SUCCESS,
PENDING,
CANCELLED,
ONHOLD
refund_type
enum<string>

This can be one of ["PAYMENT_AUTO_REFUND", "MERCHANT_INITIATED", "UNRECONCILED_AUTO_REFUND"]

Available options:
PAYMENT_AUTO_REFUND,
MERCHANT_INITIATED,
UNRECONCILED_AUTO_REFUND
status_description
string

Description of refund status