Skip to main content
API docs by Redocly

Vipps Order Management API (2.0)

Download OpenAPI specification:Download

URL: https://developer.vippsmobilepay.com/docs/contact/

API to add and read additional info for Vipps orders. See the API Guide for more information.

Category

Add category to an order

The category adds a link, specified by you, to the Transaction page on the Vipps app. Only one (the latest) category is shown in the app.

Authorizations:
BearerToken
path Parameters
paymentType
required
string
Enum: "ecom" "recurring"

The type of transaction {ecom, recurring}

orderId
required
string^[0-9A-Za-z-_\.]+$

The orderId of the transaction, unique and managed by merchant

header Parameters
Authorization
required
string

The access token is a base64-encoded string that is required for all API calls. It is a JWT (JSON Web Token). The access token is fetched from the POST:/accesstoken/get endpoint. It is valid for 1 hour in the test environment and 24 hours in the production environment.

Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sales unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Vipps-System-Version
string <= 100 characters
Example: 5.4.0

The version number of the ecommerce solution. See http-headers.

Vipps-System-Plugin-Name
string <= 100 characters
Example: vipps-woocommerce

The name of the ecommerce plugin (if applicable). One word in lowercase letters is good. See http-headers.

Vipps-System-Name
string <= 100 characters
Example: woocommerce

The name of the ecommerce solution. One word in lowercase letters is good. See http-headers.

Vipps-System-Plugin-Version
string <= 100 characters
Example: 1.2.1

The version number of the ecommerce plugin (if applicable). See http-headers.

Request Body schema: application/json
category
required
string or null (CategoryEnum)
Enum: "GENERAL" "RECEIPT" "ORDER_CONFIRMATION" "DELIVERY" "TICKET" "BOOKING"
orderDetailsUrl
required
string <uri> non-empty

URL linking back to the merchant's website/store.

imageId
string or null [ 1 .. 128 ] characters ^[0-9A-Za-z-_\.]+$

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
"16328cb8-d769-4c53-90ad-e19777823f0a"

Image

Add an image

Endpoint for uploading images. A imageId will be returned that can be used when adding metadata to orders.

Authorizations:
BearerToken
header Parameters
Authorization
required
string

The access token is a base64-encoded string that is required for all API calls. It is a JWT (JSON Web Token). The access token is fetched from the POST:/accesstoken/get endpoint. It is valid for 1 hour in the test environment and 24 hours in the production environment.

Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sales unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Vipps-System-Version
string <= 100 characters
Example: 5.4.0

The version number of the ecommerce solution. See http-headers.

Vipps-System-Plugin-Name
string <= 100 characters
Example: vipps-woocommerce

The name of the ecommerce plugin (if applicable). One word in lowercase letters is good. See http-headers.

Vipps-System-Name
string <= 100 characters
Example: woocommerce

The name of the ecommerce solution. One word in lowercase letters is good. See http-headers.

Vipps-System-Plugin-Version
string <= 100 characters
Example: 1.2.1

The version number of the ecommerce plugin (if applicable). See http-headers.

Request Body schema: application/json
imageId
required
string <= 128 characters ^[0-9A-Za-z-_\.]+$

Id of the image to be added

src
required
string

The image data as a base64 encoded string (not a URL)

type
required
string
Value: "base64"

Responses

Request samples

Content type
application/json
{
  • "imageId": "vipps-socks-orange-123",
  • "src": "iVBORw0KGgoAAAANSUhEUgAAAKsAAADVCAMAAAAfHv",
  • "type": "base64"
}

Response samples

Content type
application/json
{
  • "imageId": "vipps-socks-orange-123"
}

Order

Get order with category and receipt

Get order with category and receipt

Authorizations:
BearerToken
path Parameters
paymentType
required
string
Enum: "ecom" "recurring"

The type of transaction {ecom, recurring}

orderId
required
string^[0-9A-Za-z-_\.]+$

The orderId of the transaction, unique and managed by merchant

header Parameters
Authorization
required
string

The access token is a base64-encoded string that is required for all API calls. It is a JWT (JSON Web Token). The access token is fetched from the POST:/accesstoken/get endpoint. It is valid for 1 hour in the test environment and 24 hours in the production environment.

Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sales unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Vipps-System-Version
string <= 100 characters
Example: 5.4.0

The version number of the ecommerce solution. See http-headers.

Vipps-System-Plugin-Name
string <= 100 characters
Example: vipps-woocommerce

The name of the ecommerce plugin (if applicable). One word in lowercase letters is good. See http-headers.

Vipps-System-Name
string <= 100 characters
Example: woocommerce

The name of the ecommerce solution. One word in lowercase letters is good. See http-headers.

Vipps-System-Plugin-Version
string <= 100 characters
Example: 1.2.1

The version number of the ecommerce plugin (if applicable). See http-headers.

Responses

Response samples

Content type
application/json
{
  • "category": {},
  • "receipt": {
    }
}

Receipt

Add receipt to an order

Add receipt to an order.

Authorizations:
BearerToken
path Parameters
orderId
required
string^[0-9A-Za-z-_\.]+$

The orderId of the transaction, unique and managed by merchant

paymentType
required
string
Enum: "ecom" "recurring"

The type of transaction {ecom, recurring}

header Parameters
Authorization
required
string

The access token is a base64-encoded string that is required for all API calls. It is a JWT (JSON Web Token). The access token is fetched from the POST:/accesstoken/get endpoint. It is valid for 1 hour in the test environment and 24 hours in the production environment.

Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sales unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Vipps-System-Version
string <= 100 characters
Example: 5.4.0

The version number of the ecommerce solution. See http-headers.

Vipps-System-Plugin-Name
string <= 100 characters
Example: vipps-woocommerce

The name of the ecommerce plugin (if applicable). One word in lowercase letters is good. See http-headers.

Vipps-System-Name
string <= 100 characters
Example: woocommerce

The name of the ecommerce solution. One word in lowercase letters is good. See http-headers.

Vipps-System-Plugin-Version
string <= 100 characters
Example: 1.2.1

The version number of the ecommerce plugin (if applicable). See http-headers.

Request Body schema: application/json
required
Array of objects (OrderLine) non-empty

All numbers are interpreted as integers with two trailing zeros. ex: 10.00 = 1000. Amounts are specified in minor units. For Norwegian kroner (NOK) that means 1 kr = 100 øre. Example: 10 kr = 1000 øre.

required
object (BottomLine)

Summary of the order. Total amount and total. Amounts are specified in minor units. For Norwegian kroner (NOK) that means 1 kr = 100 øre. Example: 20 kr = 2000 øre.

Responses

Request samples

Content type
application/json
{
  • "orderLines": [
    ],
  • "bottomLine": {
    }
}

Response samples

Content type
application/json
"16328cb8-d769-4c53-90ad-e19777823f0a"

Deprecated endpoints

No longer available

Add info to an order Deprecated

Post additional information about an order that will show up on the Vipps receipt.

Authorizations:
BearerToken
path Parameters
transactionId
required
string
header Parameters
Authorization
required
string

The access token is a base64-encoded string that is required for all API calls. It is a JWT (JSON Web Token). The access token is fetched from the POST:/accesstoken/get endpoint. It is valid for 1 hour in the test environment and 24 hours in the production environment.

Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sales unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Vipps-System-Version
string <= 100 characters
Example: 5.4.0

The version number of the ecommerce solution. See http-headers.

Vipps-System-Plugin-Name
string <= 100 characters
Example: vipps-woocommerce

The name of the ecommerce plugin (if applicable). One word in lowercase letters is good. See http-headers.

Vipps-System-Name
string <= 100 characters
Example: woocommerce

The name of the ecommerce solution. One word in lowercase letters is good. See http-headers.

Vipps-System-Plugin-Version
string <= 100 characters
Example: 1.2.1

The version number of the ecommerce plugin (if applicable). See http-headers.

Request Body schema: application/json
category
required
string or null (CategoryEnum)
Enum: "GENERAL" "RECEIPT" "ORDER_CONFIRMATION" "DELIVERY" "TICKET" "BOOKING"
orderDetailsUrl
required
string <uri> non-empty

URL linking back to the merchant's website/store.

imageId
string or null [ 1 .. 128 ] characters ^[0-9A-Za-z-_\.]+$

Responses

Request samples

Content type
application/json
{}

Get info for an order Deprecated

Retrieve the metadata for an order

Authorizations:
BearerToken
path Parameters
transactionId
required
string
header Parameters
Authorization
required
string

The access token is a base64-encoded string that is required for all API calls. It is a JWT (JSON Web Token). The access token is fetched from the POST:/accesstoken/get endpoint. It is valid for 1 hour in the test environment and 24 hours in the production environment.

Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sales unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Vipps-System-Version
string <= 100 characters
Example: 5.4.0

The version number of the ecommerce solution. See http-headers.

Vipps-System-Plugin-Name
string <= 100 characters
Example: vipps-woocommerce

The name of the ecommerce plugin (if applicable). One word in lowercase letters is good. See http-headers.

Vipps-System-Name
string <= 100 characters
Example: woocommerce

The name of the ecommerce solution. One word in lowercase letters is good. See http-headers.

Vipps-System-Plugin-Version
string <= 100 characters
Example: 1.2.1

The version number of the ecommerce plugin (if applicable). See http-headers.

Responses

Response samples

Content type
application/json
{
  • "category": "TICKET",
  • "orderDetailsUrl": "https://www.vipps.no",
  • "imageIds": [
    ]
}

Get receipt for an order Deprecated

Endpoint for retrieving receipts.

Authorizations:
BearerToken
path Parameters
transactionId
required
string
header Parameters
Authorization
required
string

The access token is a base64-encoded string that is required for all API calls. It is a JWT (JSON Web Token). The access token is fetched from the POST:/accesstoken/get endpoint. It is valid for 1 hour in the test environment and 24 hours in the production environment.

Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sales unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Vipps-System-Version
string <= 100 characters
Example: 5.4.0

The version number of the ecommerce solution. See http-headers.

Vipps-System-Plugin-Name
string <= 100 characters
Example: vipps-woocommerce

The name of the ecommerce plugin (if applicable). One word in lowercase letters is good. See http-headers.

Vipps-System-Name
string <= 100 characters
Example: woocommerce

The name of the ecommerce solution. One word in lowercase letters is good. See http-headers.

Vipps-System-Plugin-Version
string <= 100 characters
Example: 1.2.1

The version number of the ecommerce plugin (if applicable). See http-headers.

Responses

Response samples

Content type
application/json
No sample

Add receipt to an order Deprecated

Endpoint for adding receipts to an order.

Authorizations:
BearerToken
path Parameters
transactionId
required
string
header Parameters
Authorization
required
string

The access token is a base64-encoded string that is required for all API calls. It is a JWT (JSON Web Token). The access token is fetched from the POST:/accesstoken/get endpoint. It is valid for 1 hour in the test environment and 24 hours in the production environment.

Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sales unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Vipps-System-Version
string <= 100 characters
Example: 5.4.0

The version number of the ecommerce solution. See http-headers.

Vipps-System-Plugin-Name
string <= 100 characters
Example: vipps-woocommerce

The name of the ecommerce plugin (if applicable). One word in lowercase letters is good. See http-headers.

Vipps-System-Name
string <= 100 characters
Example: woocommerce

The name of the ecommerce solution. One word in lowercase letters is good. See http-headers.

Vipps-System-Plugin-Version
string <= 100 characters
Example: 1.2.1

The version number of the ecommerce plugin (if applicable). See http-headers.

Request Body schema: application/json
required
Array of objects (OrderLine) non-empty

All numbers are interpreted as integers with two trailing zeros. ex: 10.00 = 1000. Amounts are specified in minor units. For Norwegian kroner (NOK) that means 1 kr = 100 øre. Example: 10 kr = 1000 øre.

required
object (BottomLine)

Summary of the order. Total amount and total. Amounts are specified in minor units. For Norwegian kroner (NOK) that means 1 kr = 100 øre. Example: 20 kr = 2000 øre.

Responses

Request samples

Content type
application/json
{
  • "orderLines": [
    ],
  • "bottomLine": {
    }
}

Response samples

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