Auto-Refund Webhooks

Suggest Edits

Auto-refund webhooks can be configured to receive automated notifications when auto-refunds are initiated, processed and delayed. Auto-refunds are refunds triggered automatically for unsuccessful payments, disputes, duplicate payments; or instances where payments are received directly to your VPA, regardless of whether an order has been generated.

Webhook notifications are sent to every URL added and enabled under Auto-refund Webhooks. Merchants can add new URLs and enable or disable existing ones for auto-refund webhooks at any point in time. The changes are reflected instantaneously.

You can learn more on configuring webhooks.

Sample Payload

{
  "data": {
    "auto_refund": {
      "event": "AUTO-REFUND",
      "cf_refund_id": 1243460973,
      "cf_payment_id": "2148333968",
      "bank_reference": "234928698581",
      "order_id": "order_1944392Tpba8y2fHcHVx0SwREojp51Jgr",
      "refund_amount": 39,
      "refund_currency": "INR",
      "refund_type": "PAYMENT_AUTO_REFUND",
      "refund_arn": "205907014017",
      "refund_status": "SUCCESS",
      "status_description": "Auto-Refund processed successfully",
      "refund_reason": "Multiple payments were performed against same order.",
      "created_at": "2023-08-11T14:08:28+05:30",
      "processed_at": null,
      "refund_charge": 0,
      "refund_splits": null,
      "metadata": null
    }
  },
  "event_time": "2023-08-11T14:10:21+05:30",
  "type": "AUTO_REFUND_STATUS_WEBHOOK"
}

Find the description for each field of the payload below:

Field	Description	Example
cf_refund_id	It represents the ID created by Cashfree Payments to identify the refund.	1243460973
cf_payment_id	It represents the ID created by Cashfree Payments to identify the payment for the initiated refund.	2148333968
order_id	It represents the ID created by you to identify the order for which the refund is initiated.	sampleorder0413
bank_reference	It represents the bank reference number for the transaction.	234928698581
refund_currency	It represents the currency of the refund amount.	INR
refund_amount	It represents the refunded amount.	2
refund_type	It represents the refund type. The value will always be PAYMENT_AUTO_REFUND.	PAYMENT_AUTO_REFUND
refund_arn	It represents the bank reference number for the refund.	205907014017
refund_status	It represents the status of the refund (either SUCCESS or INITIATED)	SUCCESS
status_description	It represents the description of the refund status (Two possible values: Auto-Refund initiated successfully or Auto-Refund processed successfully).	Auto-Refund initiated successfully
created_at	It represents the time of auto-refund creation.	2022-02-28T12:54:25+05:30
processed_at	It represents when the auto-refund was processed successfully.	2022-02-28T13:04:27+05:30
refund_reason	It represents the reason of initiation of Auto-refund (Possible values: Credit was received for an incomplete payment. Refunded to customer for Dispute. Payment made directly to your VPA without order creation. Multiple payments were performed against same order. Payment details (amount, bank, etc.) do not match with created order or the payment was made after TTL.)	Multiple payments were performed against same order
refund_charge	It represents the charges for processing refund in INR.	0
refund_splits	It represents the refund split details.	[]
metadata	It represents the additional metadata.	null
event_time	It represents when the refund webhook was initiated.	2022-02-28T13:04:28+05:30
type	It represents the webhook type. The value will always be AUTO_REFUND_STATUS_WEBHOOK.	AUTO_REFUND_STATUS_WEBHOOK

Updated about 1 year ago