PAYMENT REFUNDED

Event Overview

Event Type: PAYMENT_REFUNDED
Category: Payment
Description: Payment has been refunded This webhook is triggered when a payment is refunded to the customer 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`	`PAYMENT_REFUNDED`
`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

{
    "event_type": "PAYMENT_REFUNDED",
    "event_time": "2024-02-15 16:53:15",
    "version": "1.0",
    "sequence_number": "e40552bf-ed12-4f35-9a97-162d97e6fa34",
    "data": {
        "refunds": [
            {
                "bank_arn": "arn",
                "comments": "Refund processed successfully",
                "order_id": "OD6085456489",
                "refund_id": "RF2684785771",
                "payment_id": "PR7485664995",
                "refund_amount": 1000,
                "order_reference_id": "REF6085456489",
                "refund_completed_at": "2025-06-24T12:30:44.000000Z",
                "refund_reference_id": "c82df8dedf844acaa497ece9126a967e"
            }
        ]
    }
}

Field Specifications

Root Level Fields
Data Object Fields

string

required

Always "PAYMENT_REFUNDED" for this webhook event

string

required

Timestamp when the event occurred in YYYY-MM-DD HH:MM:SS formatExample: "2024-02-15 16:53:15"

string

required

Webhook payload version (currently “1.0”)

string

required

Unique identifier for the event instanceExample: "e40552bf-ed12-4f35-9a97-162d97e6fa34"

object

required

Event-specific data payload containing refund details

array

required

Array of refund objects containing the refund information

string

required

Original payment ID that was refundedExample: "PR7485664995"

string

required

Order ID associated with the refundExample: "OD6085456489"

string

required

Unique refund identifierExample: "RF2684785771"

number

required

Refund amountExample: 1000

string

Bank ARN (Acquirer Reference Number) - may be nullExample: "arn"

string

Human-readable note describing the refund outcomeExample: "Refund processed successfully"

string

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

string

ISO 8601 timestamp when the refund completedExample: "2025-06-24T12:30:44.000000Z"

string

Unique reference ID for this refund transactionExample: "c82df8dedf844acaa497ece9126a967e"

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