Skip to main content

Webhooks

The ePayment API offers the possibility to subscribe to webhooks for any number of events:

  • You register a webhook URL
  • We send updates and information to the webhook URL you have specified

See the Webhooks API for more information.

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 .. 6 ] characters ^[0-9]{4,6}$

The merchant serial number (MSN) for the sales unit.

reference
required
string (ReferenceType) [ 8 .. 50 ] characters ^[a-zA-Z0-9-]{8,50}$

A reference

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": "123456",
  • "reference": "reference-string",
  • "pspReference": "string",
  • "name": "AUTHORIZED",
  • "amount": {
    },
  • "timestamp": "2019-08-24T14:15:22Z",
  • "idempotencyKey": "string",
  • "success": true
}

For the full list of available events, see: Webhooks events.