Skip to main content

Vipps QR API (1.0)

Download OpenAPI specification:Download

API to generate QR codes for a Vipps payment and Merchant Redirects. See the API Guide for more information.

Merchant redirect QR

Create merchant redirect QR

Generate a QR that works as a redirect back to the merchant

Authorizations:
BearerToken
header Parameters
Accept
required
string
Enum: "image/*" "image/png" "image/svg+xml" "text/targetUrl"

Requested image format. Supported values: {image/*,image/png, image/svg+xml, text/targetUrl}

Authorization
required
string

Bearer

Ocp-Apim-Subscription-Key
required
string

Subscription Key

Merchant-Serial-Number
string

The merchant serial number (MSN) for the sale unit. Partners and PSP merchants must always send the Merchant-Serial-Number header, and we recommend that everyone sends it, also when using the merchant's own API keys. The Merchant-Serial-Number header can be used with all API keys, and can speed up any trouble-shooting of API problems quite a bit.

Request Body schema: application/json
id
required
string or null [ 1 .. 128 ] characters ^[-_+%æøåÆØÅ\w\s]*$

Merchant supplied Id for QR

redirectUrl
required
string or null <uri> ^https:\/\/[\w\.]+([\w#!:.?+=&%@\-\/]+)?$

The target url of the QR (redirect destination)

ttl
integer or null [ 300 .. 2147483647 ]

Optional time-to-live field, given in seconds

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Get all merchant redirect QRs

Get all merchant redirect QRs for this saleunit

Authorizations:
BearerToken
header Parameters
Authorization
required
string

Bearer

Ocp-Apim-Subscription-Key
required
string

Subscription Key

Merchant-Serial-Number
string

The merchant serial number (MSN) for the sale unit. Partners and PSP merchants must always send the Merchant-Serial-Number header, and we recommend that everyone sends it, also when using the merchant's own API keys. The Merchant-Serial-Number header can be used with all API keys, and can speed up any trouble-shooting of API problems quite a bit.

Accept
required
string
Enum: "image/*" "image/png" "image/svg+xml" "text/targetUrl"

Requested image format. Supported values: {image/*,image/png, image/svg+xml, text/targetUrl}

Responses

Response samples

Content type
application/json
[]

Update redirectUrl for merchant redirect QR

Update the redirect url (target destination) of the QR

Authorizations:
BearerToken
path Parameters
id
required
string

id for QR

header Parameters
Accept
required
string
Enum: "image/*" "image/png" "image/svg+xml" "text/targetUrl"

Requested image format. Supported values: {image/*,image/png, image/svg+xml, text/targetUrl}

Authorization
required
string

Bearer

Ocp-Apim-Subscription-Key
required
string

Subscription Key

Merchant-Serial-Number
string

The merchant serial number (MSN) for the sale unit. Partners and PSP merchants must always send the Merchant-Serial-Number header, and we recommend that everyone sends it, also when using the merchant's own API keys. The Merchant-Serial-Number header can be used with all API keys, and can speed up any trouble-shooting of API problems quite a bit.

Request Body schema: application/json
redirectUrl
required
string <uri> ^https:\/\/[\w\.]+([\w#!:.?+=&%@\-\/]+)?$

Responses

Request samples

Content type
application/json

Response samples

Content type
application/json
{}

Delete merchant redirect QR

Delete merchant redirect QR

Authorizations:
BearerToken
path Parameters
id
required
string

id for QR

header Parameters
Authorization
required
string

Bearer

Ocp-Apim-Subscription-Key
required
string

Subscription Key

Merchant-Serial-Number
string

The merchant serial number (MSN) for the sale unit. Partners and PSP merchants must always send the Merchant-Serial-Number header, and we recommend that everyone sends it, also when using the merchant's own API keys. The Merchant-Serial-Number header can be used with all API keys, and can speed up any trouble-shooting of API problems quite a bit.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "detail": "string",
  • "instance": "string",
  • "invalidParams": [
    ]
}

Get merchant redirect QR by id

Get merchant redirect QR by id

Authorizations:
BearerToken
path Parameters
id
required
string

id for QR

header Parameters
Authorization
required
string

Bearer

Ocp-Apim-Subscription-Key
required
string

Subscription Key

Merchant-Serial-Number
string

The merchant serial number (MSN) for the sale unit. Partners and PSP merchants must always send the Merchant-Serial-Number header, and we recommend that everyone sends it, also when using the merchant's own API keys. The Merchant-Serial-Number header can be used with all API keys, and can speed up any trouble-shooting of API problems quite a bit.

Accept
required
string
Enum: "image/*" "image/png" "image/svg+xml" "text/targetUrl"

Requested image format. Supported values: {image/*,image/png, image/svg+xml, text/targetUrl}

Size
string

Eks: 200. Then 200x200 px is set at dimension for Qr

Responses

Response samples

Content type
application/json
{}

One time payment QR

Create One Time Payment QR

Endpoint for generating a Vipps QR for a merchant payment. Given a valid vippsLandingPageUrl this endpoint will return a QR for that payment.

Authorizations:
BearerToken
header Parameters
Accept
required
string
Enum: "image/*" "image/png" "image/svg+xml" "text/targetUrl"

Requested image format. Supported values: {image/*,image/png, image/svg+xml, text/targetUrl}

Authorization
required
string

Bearer

Ocp-Apim-Subscription-Key
required
string

Subscription Key

Merchant-Serial-Number
string

The merchant serial number (MSN) for the sale unit. Partners and PSP merchants must always send the Merchant-Serial-Number header, and we recommend that everyone sends it, also when using the merchant's own API keys. The Merchant-Serial-Number header can be used with all API keys, and can speed up any trouble-shooting of API problems quite a bit.

Request Body schema: application/json
url
required
string

Url to the Vipps landing page, obtained from ecom/recurring apis

Responses

Request samples

Content type
application/json
{
  • "url": " https://api.vipps.no/dwo-api-application/v1/deeplink/vippsgateway?v=2&token=eyJraWQiO...."
}

Response samples

Content type
application/json
{}