PAYMENT SUCCESSFUL

Event Overview

Event Type: PAYMENT_SUCCESSFUL
Category: Payment
Description: Payment transaction was successful This webhook is triggered when a payment is marked CAPTURED (after a payment success callback or VBA transfer processor).

When the webhook is sent

Regular payment flow: After a payment success callback is received, the payment is updated to CAPTURED and the webhook is created.
VBA transfer flow: After a VBA transfer payment is successfully recorded, the webhook is created.
The webhook is created only if your merchant account (or parent, for sub-merchants) has a webhook URL configured.

Delivery Details

Attribute	Value
HTTP method	`POST`
URL	The webhook URL configured for your merchant account
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_SUCCESSFUL`
`X-Webhook-Timestamp`	Unix timestamp (string) at the time of the request
`X-Webhook-Signature`	`HMAC-SHA256(encryption_key, raw_body)`, hex-encoded
`X-Webhook-Signature-V2`	`t=<timestamp>,v2=<hex>` where the digest is `HMAC-SHA256(encryption_key, "<timestamp>." + raw_body)`

Verifying. The body is serialised once and those exact bytes are both sent and signed, so hashing the raw request body as received is correct — do not re-serialise the parsed JSON first. Both signature headers are sent. Verify V2 (recommended) or V1 — see Verifying webhooks.

Payload Schema

{
  "event_type": "PAYMENT_SUCCESSFUL",
  "event_time": "2026-02-12T10:30:00.123456",
  "version": "3.0.0",
  "sequence_number": "550e8400-e29b-41d4-a716-446655440000",
  "data": {
    "payment_id": "770e8400-e29b-41d4-a716-446655440002",
    "order_id": "660e8400-e29b-41d4-a716-446655440001",
    "link_id": null,
    "status": "CAPTURED",
    "message": "Payment Captured",
    "mop_type": "VBA_TRANSFER",
    "amount": 1000,
    "bank_ref_num": "BANKREF123",
    "extended_status": "SUCCESS",
    "payment_message": null,
    "payment_completed_at": "2026-02-12T10:29:55.000000Z",
    "utr": "UTR123456",
    "virtual_account_id": "USER09",
    "subscription_id": null,
    "merchant_reference_id": "S2SICR1QPJ"
  }
}

Field Specifications

Root Level Fields
Data Object Fields

string

required

Always "PAYMENT_SUCCESSFUL" for this webhook event

string

required

UTC, no timezone suffix, e.g. "2026-02-12T10:30:00.123456". Parse tolerantly — fractional seconds can be absent.

string

required

API version of your account, e.g. "3.0.0"

string

required

Unique ID of this event (a UUID, not an ordering counter). A retry resends the same value; use it to de-duplicate.Example: "550e8400-e29b-41d4-a716-446655440000"

object

required

Payment request details (payment_id, order_id, link_id, status, message, mop_type, amount, bank_ref_num, extended_status, payment_message, payment_completed_at, utr, virtual_account_id, subscription_id, merchant_reference_id)

string

required

UID of the paymentExample: "770e8400-e29b-41d4-a716-446655440002"

string

required

UID of the order for this paymentExample: "660e8400-e29b-41d4-a716-446655440001"

string

ID of the payment link this payment was made through — the link_id that Create Payment Link returned. null when the payment was not made through a payment link; the key is always present. A buyer can try a link more than once, so several payments can carry the same link_id, each with its own payment_id. On some accounts payment_id and link_id can be the same value. Match the payment to your link on link_id; refund and reconcile it by payment_id.Example: "PR4829301756"

string

required

Payment status (CAPTURED for successful payments)Example: "CAPTURED"

string

required

Status message from the paymentExample: "Payment Captured"

string

required

Method of payment typeExample: "VBA_TRANSFER"

number

required

Payment amountExample: 1000

string

Bank reference number; may be nullExample: "BANKREF123"

string

required

Detailed status code for the paymentExample: "SUCCESS"

string

Additional processor-level message; may be null

string

required

ISO 8601 datetime when payment completed (typically set for success)Example: "2026-02-12T10:29:55.000000Z"

string

UTR of the payment (if any); may be empty or nullExample: "UTR123456"

string

Virtual account ID, if the payment came in through a virtual account; otherwise null.Example: "USER09"

string

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

string

required

Your reference ID for the order. For a recurring subscription debit, it is the payment_id that Trigger Recurring Payment returned (the reference_id you sent, if you sent one), with -attempt-1, -attempt-2, and so on appended if the debit was retried.Example: "S2SICR1QPJ"

What to Do When You Receive This Webhook

Respond with HTTP 2xx (e.g. 200 OK) as soon as you have accepted the payload, so the platform marks the delivery as successful and does not retry.
Verify the signature using your Encryption Key and the raw request body (HMAC-SHA256, hex) to ensure authenticity.
Use data.payment_id and data.order_id to reconcile with your system or fetch more details from the Partner API.
If data.link_id is not null, the payment was made through that payment link — refund and reconcile it by data.payment_id. See Tracking a payment link.
Note: You may subsequently receive a VERIFICATION_NEEDED webhook if verification details are missing on the order (see Verification Needed). LRS payments receive LRS_VERIFICATION_NEEDED instead.

Order

Payment

Merchant

Settlement

Refund

Subscriptions

Payment Links

Virtual Bank Accounts

LRS

B2B Services

Webhooks

Event Overview

When the webhook is sent

Delivery Details

Headers

Payload Schema

Field Specifications

What to Do When You Receive This Webhook

​Event Overview

​When the webhook is sent

​Delivery Details

​Headers

​Payload Schema

​Field Specifications

​What to Do When You Receive This Webhook

Event Overview

When the webhook is sent

Delivery Details

Headers

Payload Schema

Field Specifications

What to Do When You Receive This Webhook