Events

The Webhooks API sends out events for the following APIs. New event types may be provided in the future.

ePayment API events

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

The payload format is:

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.
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 the event

{

• "msn": "1234567",
• "reference": "acme-shop-123-order123abc",
• "pspReference": "string",
• "name": "AUTHORIZED",
• "amount": {

  • "currency": "NOK",
  • "value": 49900

  },
• "timestamp": "2019-08-24T14:15:22Z",
• "idempotencyKey": "string",
• "success": true

}

We support up to 25 webhook registrations per event. For more details, see ePayment Webhooks.

Recurring API events

Agreement webhook events

Name	Event Type
Agreement accepted	recurring.agreement-activated.v1
Agreement rejected	recurring.agreement-rejected.v1
Agreement stopped	recurring.agreement-stopped.v1
Agreement expired	recurring.agreement-expired.v1

Payload properties may include:

Field name	Type	Description	Possible values
agreementId	string	ID of an agreement	agr_kFW4chk
agreementUUID	UUID	ID of an agreement	82ce990f-d08a-448c-bd26-ee6be8418d06
agreementExternalId	nullable string	Merchant provided external ID of agreement	ExtId123
eventType	enum	Indicates what has happened to an agreement	Values provided in a table above
occurred	ISO 8601 UTC date	When change has occurred	2023-10-10T13:30:36.079765975Z
actor	nullable enum	Indicates who has initiated action. Applicable only for recurring.agreement-stopped.v1 webhook.	MERCHANT, USER

Charge webhook events

Name	Event Type
Charge reserved	recurring.charge-reserved.v1
Charge captured	recurring.charge-captured.v1
Charge cancelled	recurring.charge-canceled.v1
Charge failed	recurring.charge-failed.v1
Charge failed on creation	recurring.charge-creation-failed.v1

Payload properties may include:

Field name	Type	Description	Possible values
agreementId	string	ID of an agreement	agr_kFW4chk
chargeExternalId	nullable string	Merchant provided external ID of charge	ExtId123
chargeId	string	ID of a charge	82ce990f-d08a-448c-bd26-ee6be8418d06
amount	number	Amount of charge in øre (NOK, DKK) or cents (EUR)	300
chargeType	enum	Indicates type of charge	RECURRING, INITIAL, UNSCHEDULED
eventType	enum	Indicates what has happened to a charge	Values provided in a table above
currency	enum	Currency of charge	DKK, NOK, EUR
occurred	ISO 8601 UTC date	When change has occurred	2023-10-10T13:30:36.079765975Z
amountCaptured	number	Amount of payment that was captured	100
amountCanceled	number	Amount of charge that was canceled	200
amountRefunded	number	Amount of charge that was refunded	100
failureCode	number	Code of an error during async creation	Listed below
failureText	string	Explanation of an error during async creation	Listed below

Possible failureCode and failureText combinations. These fields are only present if the charge has failed async validation and was created using the multiple charge creation endpoint: POST:/recurring/v3/agreements/charges.

Failure code	Failure text	Explanation
50006	DeclinedBySystem	Unspecified exception during charge creation
50003	AgreementNotActive	Charge is requested for non-active agreement
70001	ChargeAmountTooHighForFixedAmountAgreement	Charge amount is 5 times higher than fixed amount agreement's amount
70002	ChargeCreationConflict	Trying to create charge with same idempotency key more than once
70004	ChargeTooFarInFuture	Due date is too far in the future
70005	ChargeDueDateTooSoon	Due date is too soon

We support up to 25 webhook registrations per event. For more details, see: Recurring Webhooks.

QR API events

Name	Event Type
CheckedIn	user.checked-in.v1

The payload format is:

Name	Type	Description
customerToken	Base64 string	A reference to the customer. Should be used when initiating a payment through the ePayment API. Token is valid for 15 minutes.
merchantQrId	string	The ID of the QR code that has been scanned which is defined by the merchant when the QR was created.
msn	string	Merchant serial number. A unique ID of the sales unit to which the scanned QR belongs.
initiatedAt	UTC Timestamp in ISO 8601 format	The timestamp of when the customer scanned the QR.

We support up to one webhook registration per event. For more details, see QR Webhooks.

Login API events

Name	Event Type
Ping	login.merchant-initiated.ping.v1

The payload will contain:

Name	Type	Description
auth_req_id	String	The auth_req_id that identifies the login.

For more details, see Login Webhooks.