Skip to main content

Order Management API (2.0)

Download OpenAPI specification:Download

The Order Management API enables you to read and add information for Vipps MobilePay orders. See the Order Management API Guide for more details.

Category

Add category to an order

The category adds a link, specified by you, to the Transaction page on the Vipps MobilePay 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}. Use "ecom" for both eCom API and ePayment API payments. Use "recurring" for Recurring API payments.

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 merchant serial number for this sales unit. See API keys.

Ocp-Apim-Subscription-Key
required
string

The API subscription key. See API keys. Keep it secret.

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
{
  • "category": "GENERAL",
  • "orderDetailsUrl": "https://example.com",
  • "imageId": "vipps-socks-orange-123"
}

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 merchant serial number for this sales unit. See API keys.

Ocp-Apim-Subscription-Key
required
string

The API subscription key. See API keys. Keep it secret.

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). The image must be in PNG or JPEG format. Square images are recommended. Minimum height is 167px, and max file size is 2MB.

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}. Use "ecom" for both eCom API and ePayment API payments. Use "recurring" for Recurring API payments.

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 merchant serial number for this sales unit. See API keys.

Ocp-Apim-Subscription-Key
required
string

The API subscription key. See API keys. Keep it secret.

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}. Use "ecom" for both eCom API and ePayment API payments. Use "recurring" for Recurring API payments.

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 merchant serial number for this sales unit. See API keys.

Ocp-Apim-Subscription-Key
required
string

The API subscription key. See API keys. Keep it secret.

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

Amounts are specified in minor units (i.e., integers with two trailing zeros). For example: 10.00 EUR/NOK/DKK should be written as 1000.

required
object (BottomLine)

Summary of the order. Total amount and total. Amounts are specified in minor units (i.e., integers with two trailing zeros). For example: 10.00 EUR/NOK/DKK should be written as 1000.

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 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 merchant serial number for this sales unit. See API keys.

Ocp-Apim-Subscription-Key
required
string

The API subscription key. See API keys. Keep it secret.

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
{
  • "category": "GENERAL",
  • "orderDetailsUrl": "https://example.com",
  • "imageId": "vipps-socks-orange-123"
}

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 merchant serial number for this sales unit. See API keys.

Ocp-Apim-Subscription-Key
required
string

The API subscription key. See API keys. Keep it secret.

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://example.com",
  • "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 merchant serial number for this sales unit. See API keys.

Ocp-Apim-Subscription-Key
required
string

The API subscription key. See API keys. Keep it secret.

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 merchant serial number for this sales unit. See API keys.

Ocp-Apim-Subscription-Key
required
string

The API subscription key. See API keys. Keep it secret.

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

Amounts are specified in minor units (i.e., integers with two trailing zeros). For example: 10.00 EUR/NOK/DKK should be written as 1000.

required
object (BottomLine)

Summary of the order. Total amount and total. Amounts are specified in minor units (i.e., integers with two trailing zeros). For example: 10.00 EUR/NOK/DKK should be written as 1000.

Responses

Request samples

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

Response samples

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