Refund Events
Refund Events are webhook notifications from GETTRX One that provide real-time updates on the status of refund transactions. These events allow you to track refund progress, notify merchants and customers of updates, and manage refund workflows effectively.
Refunds are a critical part of the payment lifecycle, and subscribing to these events ensures transparency and timely communication throughout the process.
Key Refund Webhook Events
Refund Pending (refund.pending)
Triggered when a refund request has been initiated and is awaiting processing. Use this event to notify merchants or customers that their refund request is in progress.
{
account: "acm_65f48b068b8d6912fe07f000",
attemptId: "wha_6751e4a3a02adccc5f7dcb18",
created: "1733379298",
"data": {
"object": {
id: "re_675144e11b260933080d9177",
amount: 19.78,
charge: "ch_675144dd1b260933080d9171",
currency: "usd",
paymentRequest: "pr_675144dd1b260933080d9170",
reason: "fraudulent",
reasonNotes: "deposit transaction at Turcotte, John's Shoe Store using card ending with ***(...2158) for PKR 113.78 in account ***91974060",
status: "pending",
created: 1733379298,
type: "offline_return",
object: "refund"
}
},
id: "evt_675144e2891a560145e268b1",
object: "event",
"request": {},
type: "refund.pending"
}
Refund Succeed (refund.succeeded)
Indicates that a refund has been successfully processed. This final status confirms the completion of the refund and is essential for updating order statuses or notifying the customer.
{
account: "acm_65f48b068b8d6912fe07f000",
attemptId: "wha_6751e4aa38b1d5a52d085e54",
created: "1733379235",
"data": {
"object": {
id: "re_6751447f1b260933080d90db",
amount: 38.95,
charge: "ch_6751447e1b260933080d90d9",
currency: "usd",
paymentRequest: "pr_6751447e1b260933080d90d8",
reason: "fraudulent",
reasonNotes: "withdrawal transaction at John's Shoe Store using card ending with ***(...6229) for SAR 858.29 in account ***15309814",
status: "succeeded",
created: 1733379200,
type: "reversal",
object: "refund"
}
},
id: "evt_675144a3891a560145e267c7",
object: "event",
"request": {},
type: "refund.succeeded"
}
Refund Failed (refund.failed)
Sent when a refund attempt has failed due to reasons such as insufficient funds or processing errors. Use this event to inform merchants or customers and provide guidance on resolving the issue.
{
"id": "evt_666323a06ee877590a4a000",
"account": "acm_65f48b068b8d6912fe07f302",
"created": 1717773216,
"data": {
"object": "{success=false, code=400, message=One or more required values are missing., data=null}"
},
"object": "event",
"request": {},
"type": "refund.failed"
}
Best Practices for Refund Events
Proactive Communication:
Notify customers immediately when a refund transitions to refund.pending or refund.succeeded to manage their expectations. Provide clear explanations and support options when a refund.failed event is triggered.
Automate Workflows:
Integrate refund.succeeded into your system to automatically update order statuses and inventory. Use refund.failed to trigger internal alerts or retry mechanisms for processing refunds.
Enhance Customer Support:
Use refund.pending to reassure customers that their refund request is being processed. Provide refund timelines and resolution steps in cases where refund.failed is encountered.
Monitor and Audit Refund Activity:
Leverage these events to track refund volumes, identify patterns, and optimize refund management processes.
By subscribing to refund events, you can improve refund handling efficiency, enhance customer satisfaction, and reduce manual intervention in refund workflows.
Updated 3 months ago