PAYMENT FAILED

Event Overview

Event Type: PAYMENT_FAILED
Category: Payment
Description: Payment transaction has failed This webhook is triggered when a customer’s payment attempt fails 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_FAILED`
`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_FAILED",
    "event_time": "2024-02-15 16:53:15Z",
    "version": "1.0",
    "sequence_number": "e40552bf-ed12-4f35-9a97-162d97e6fa34",
    "data": {
        "utr": null,
        "amount": 1000,
        "status": "FAILED",
        "message": "Cancelled by user",
        "mop_type": "UPI",
        "order_id": "OD3376378679",
        "link_id": null,
        "payment_id": "PR6938527534",
        "bank_ref_num": null,
        "extended_status": "FAILED",
        "payment_message": null,
        "subscription_id": null,
        "virtual_account_id": null,
        "payment_completed_at": null,
        "merchant_reference_id": "S2SIOAW7W4"
    }
}

Field Specifications

Root Level Fields
Data Object Fields

string

required

Always "PAYMENT_FAILED" for this webhook event

string

required

Timestamp when the event occurred in ISO 8601 formatExample: "2024-02-15 16:53:15Z"

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 failed payment transaction details

string

required

Payment status (FAILED for failed payments)Example: "FAILED"

string

required

Failure reason or messageExample: "Cancelled by user"

string

required

Method of payment typeExample: "UPI"

number

required

Payment amountExample: 1000

string

required

Order IDExample: "OD3376378679"

string

ID of the payment link this payment was made through — the link_id that Create Payment Link returned, which is the same value as payment_id. null when the payment was not made through a payment link; the key is always present.Example: "PR4829301756"

string

required

Payment IDExample: "PR6938527534"

string

Bank reference number; typically null for failed paymentsExample: null

string

required

Detailed status code for the paymentExample: "FAILED"

string

Additional processor-level message; may be null

string

UTR of the payment (if any); may be null

string

Subscription ID if this payment is linked to a subscription mandate; otherwise null

string

Virtual account ID if this payment is linked to a VBA; otherwise null

string

required

Your reference ID for the orderExample: "S2SIOAW7W4"

string

ISO 8601 payment completion timestamp; null for failed paymentsExample: null

Order

Payment

Card Tokens

Merchant

Settlement

Refund

Chargeback

Subscriptions

Payment Links

Utilities

Webhooks

Event Overview

Delivery Details

Headers

Payload Schema

Field Specifications