ePayment webhook events

The ePayment API provides following webhooks:

Name	Event Type
Created	`epayments.payment.created.v1`
Aborted	`epayments.payment.aborted.v1`
Expired	`epayments.payment.expired.v1`
Cancelled	`epayments.payment.cancelled.v1`
Captured	`epayments.payment.captured.v1`
Refunded	`epayments.payment.refunded.v1`
Authorized	`epayments.payment.authorized.v1`
Terminated	`epayments.payment.terminated.v1`

You can receive instant notifications about important events, such as successful payments and cancellations. To set up the basic webhook infrastructure, you need to register your webhook URL, as described in the Webhooks API guide. We'll send the real-time notifications about subscription events to the URL you specify.

We support up to 25 webhook registrations per event type per MSN. For more about these limits, see webhook limits.

Please note

Webhooks offer a faster user experience than polling, but you should not rely on webhooks alone. In the rare cases where webhooks may be delayed, you should poll the relevant API to get the information you need: GET:/epayment/v1/payments/{reference}.

Depending on your use case, you should set an appropriate timeout for webhooks. If the webhook is not received within that time, you should start polling.

Please follow our polling guidelines.

For any webhook, you will receive the following payload, where the only property changing is the name, which will reflect the event type you subscribed on.

msn required	string (MSNType) [ 4 .. 7 ] characters ^[0-9]{4,7}$ The merchant serial number (MSN) for the sales unit.
reference required	string (ReferenceType) [ 8 .. 50 ] characters ^[a-zA-Z0-9-]{8,50}$ The `reference` is the unique identifier for the payment, specified when initiating the payment. The reference must be unique for the sales unit (MSN), but is not globally unique, so several MSNs may use the same reference. See the recommendations.
pspReference required	string (PspReference) Reference value for a payment, defined by Vipps MobilePay. Each payment operation (capture, refund, etc.) will have a unique `pspReference`.
name required	string (PaymentEventName) Enum: "CREATED" "ABORTED" "EXPIRED" "CANCELLED" "CAPTURED" "REFUNDED" "AUTHORIZED" "TERMINATED"
required	object (Amount) Amount object, containing a `value` and a `currency`.
timestamp required	string <date-time>
idempotencyKey	string or null The Idempotency key of the request.
success required	boolean The outcome of this payment operation: `true` means that the operation was successful.

{"msn": "1234567",
"reference": "acme-shop-123-order123abc",
"pspReference": "3343121302",
"name": "AUTHORIZED",
"amount": {"currency": "NOK",
"value": 49900
},
"timestamp": "2024-12-31T00:00:00Z",
"idempotencyKey": "string",
"success": true
}

Note that idempotencyKey is not required, and some webhooks (e.g., CANCELLED) may not supply this value.