REFUND STATUS UPDATE

Event Overview

Event Type: REFUND_STATUS_UPDATE
Category: Payment
Description: Refund status has changed This webhook is triggered whenever a refund transitions to a new status (for example, while it is being processed) through EximPe.

Delivery Details

Attribute	Value
HTTP method	`POST`
URL	The webhook URL configured on your merchant account’s API credentials
Content-Type	`application/json`
Timeout	10 seconds
Retries	Up to 5 delivery attempts (backoff: 1 min, 5 min, 15 min, 60 min)

Headers

Header	Description
`Content-Type`	`application/json`
`User-Agent`	`Eximpe-Webhook/1.0`
`X-Webhook-Event`	`REFUND_STATUS_UPDATE`
`X-Webhook-Timestamp`	Unix timestamp (string) at the time of the request
`X-Webhook-Signature`	HMAC-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 is in progress",
                "order_id": "OD5128740396",
                "refund_id": "RF8043512967",
                "payment_id": "PR6271908354",
                "refund_amount": 320,
                "refund_status": "PROCESSING",
                "order_reference_id": "REF5128740396",
                "refund_completed_at": null,
                "refund_reference_id": "f4d8b2e6a1c94b7fa0e3d6c9b8a5f2e1"
            }
        ]
    },
    "version": "1.0.0",
    "event_time": "2026-05-27T14:30:01.359434",
    "event_type": "REFUND_STATUS_UPDATE",
    "sequence_number": "b3e91f47-20ad-4c85-9f31-6d0a87145e2b"
}

Field Specifications

Root Level Fields
Data Object Fields

string

required

Always "REFUND_STATUS_UPDATE" for this webhook event

string

required

Timestamp when the event occurred in ISO 8601 formatExample: "2026-05-27T14:30:01.359434"

string

required

Webhook payload version (currently “1.0.0”)

string

required

Unique identifier for the event instanceExample: "b3e91f47-20ad-4c85-9f31-6d0a87145e2b"

object

required

Event-specific data payload containing refund details

array

required

Array of refund objects containing the refund information

string

required

Order ID associated with the refundExample: "OD5128740396"

string

required

Unique refund identifierExample: "RF8043512967"

string

required

Original payment ID that the refund was attempted againstExample: "PR6271908354"

number

required

Refund amountExample: 320

string

required

Current status of the refundExample: "PROCESSING"

string

Human-readable note describing the current refund statusExample: "Refund is in progress"

string

Bank ARN (Acquirer Reference Number) - null until the refund reaches the bankExample: null

string

Your reference ID for the order associated with the refundExample: "REF5128740396"

string

Timestamp when the refund completed - null while the refund is still in progressExample: null

string

Unique reference ID for this refund transactionExample: "f4d8b2e6a1c94b7fa0e3d6c9b8a5f2e1"

Order

Payment

Card Tokens

Merchant

Settlement

Refund

Subscriptions

Payment Links

Utilities

Webhooks

Event Overview

Delivery Details

Headers

Payload Schema

Field Specifications

​Event Overview

​Delivery Details

​Headers

​Payload Schema

​Field Specifications

Event Overview

Delivery Details

Headers

Payload Schema

Field Specifications