Skip to main content

Event Overview

Event Type: REFUND_FAILED
Category: Payment
Description: Refund could not be completed
This webhook is triggered when a refund fails to process or its final status could not be confirmed through EximPe.

Delivery Details

AttributeValue
HTTP methodPOST
URLThe webhook URL configured on your merchant account’s API credentials
Content-Typeapplication/json
Timeout10 seconds
RetriesUp to 5 delivery attempts (backoff: 1 min, 5 min, 15 min, 60 min)

Headers

HeaderDescription
Content-Typeapplication/json
User-AgentEximpe-Webhook/1.0
X-Webhook-EventREFUND_FAILED
X-Webhook-TimestampUnix timestamp (string) at the time of the request
X-Webhook-SignatureHMAC-SHA256 signature of the request body (JSON string with keys sorted, no extra whitespace), using your API key as the secret. Hex-encoded.
Signature verification (recommended):
Compute HMAC-SHA256(encryption_key, raw_body) where raw_body is the exact UTF-8 request body as received. Compare the hex result with the X-Webhook-Signature header to ensure the webhook is from the platform and unchanged.

Payload Schema

{
    "data": {
        "refunds": [
            {
                "bank_arn": null,
                "comments": "Refund failed or status unknown",
                "order_id": "OD3391756028",
                "refund_id": "RF4762038159",
                "payment_id": "PR6018394572",
                "refund_amount": 1499,
                "refund_completed_at": null
            }
        ]
    },
    "version": "2.0.0",
    "event_time": "2026-06-03T14:30:02.854654",
    "event_type": "REFUND_FAILED",
    "sequence_number": "c5d9e203-8a41-4f7b-bf62-913e07ad4c18"
}

Field Specifications

event_type
string
required
Always "REFUND_FAILED" for this webhook event
event_time
string
required
Timestamp when the event occurred in ISO 8601 formatExample: "2026-06-03T14:30:02.854654"
version
string
required
Webhook payload version (currently “2.0.0”)
sequence_number
string
required
Unique identifier for the event instanceExample: "c5d9e203-8a41-4f7b-bf62-913e07ad4c18"
data
object
required
Event-specific data payload containing refund details