Get All Refunds for an Order

Use this API to fetch all refunds processed against an order.

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: 2022-09-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<UUID>

Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors.

Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders

Path Parameters

order_id · string · required

The id which uniquely identifies your order

Response

200

application/json

OK

cf_payment_id · integer

Cashfree Payments ID of the payment for which refund is initiated

cf_refund_id · string

Cashfree Payments ID for a refund

order_id · string

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

refund_id · string

Merchant’s refund ID of the refund

entity · enum<string>

Type of object

Available options:

refund

refund_amount · number

Amount that is refunded

refund_currency · string

Currency of the refund amount

refund_note · string

Note added by merchant for the refund

refund_status · enum<string>

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

Available options:

SUCCESS,

PENDING,

CANCELLED,

ONHOLD

refund_arn · string

The bank reference number for refund

refund_charge · number

Charges in INR for processing refund

status_description · string

Description of refund status

metadata · object | null

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

refund_splits · VendorSplit · object[]

Show child attributes

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

refund_mode · enum<string>

Method or speed of processing refund

Available options:

STANDARD,

INSTANT

created_at · string

Time of refund creation

processed_at · string

Time when refund was processed successfully

refund_speed · object

How fast refund has to be proecessed

Show child attributes

Example:

{
  "requested": "STANDARD",
  "accepted": "STANDARD",
  "processed": "STANDARD",
  "message": "Error message, if any"
}