Create Refund
Use this API to initiate refunds.
Authorizations
Client app ID. You can find your app id in the Merchant Dashboard.
Client secret key. You can find your secret in the Merchant Dashboard.
Headers
API version to be used. Format is in YYYY-MM-DD
Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
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
The id which uniquely identifies your order
Body
create refund request object
Amount to be refunded. Should be lesser than or equal to the transaction amount. (Decimals allowed)
An unique ID to associate the refund with. Provie alphanumeric values
3 - 40
A refund note for your reference.
3 - 100
Speed at which the refund is processed. It's an optional field with default being STANDARD
STANDARD
, INSTANT
Response
The refund entity
Cashfree Payments ID of the payment for which refund is initiated
Cashfree Payments ID for a refund
Merchantās order Id of the order for which refund is initiated
Merchantās refund ID of the refund
Type of object
refund
Amount that is refunded
Currency of the refund amount
Note added by merchant for the refund
This can be one of ["SUCCESS", "PENDING", "CANCELLED", "ONHOLD", "FAILED"]
SUCCESS
, PENDING
, CANCELLED
, ONHOLD
The bank reference number for refund
Charges in INR for processing refund
Description of refund status
Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value pairs
This can be one of ["PAYMENT_AUTO_REFUND", "MERCHANT_INITIATED", "UNRECONCILED_AUTO_REFUND"]
PAYMENT_AUTO_REFUND
, MERCHANT_INITIATED
, UNRECONCILED_AUTO_REFUND
Method or speed of processing refund
STANDARD
, INSTANT
Time of refund creation
Time when refund was processed successfully
How fast refund has to be proecessed
Was this page helpful?