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.
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.
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 |
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 |
Merchant-Serial-Number required | string The 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. |
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-_\.]+$ |
{- "category": "GENERAL",
- "imageId": "socks-orange-123"
}
"16328cb8-d769-4c53-90ad-e19777823f0a"
The category adds a link, specified by you, to the Transaction page in the Vipps or MobilePay app.
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 |
Merchant-Serial-Number required | string The 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. |
orderId required | string (OrderId) ^[0-9A-Za-z-_\.]+$ The orderId of the transaction, unique and managed by merchant |
paymentType required | string (PaymentType) 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. |
type required | string or null (CategoryEnum) Enum: "GENERAL" "RECEIPT" "ORDER_CONFIRMATION" "DELIVERY" "TICKET" "BOOKING" |
url required | string <uri> non-empty URL linking back to the merchant's website/store. |
imageId | string [ 1 .. 128 ] characters ^[0-9A-Za-z-_\.]+$ |
{- "orderId": "PaymentReference123",
- "paymentType": "ECOM",
- "type": "RECEIPT",
- "imageId": "f09c6aeb-442e-4da1-b36a-d8f613edc6c9"
}
{- "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0"
}
Query categories by orderId
orderId | string The orderId of the transaction, unique and managed by merchant |
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 |
Merchant-Serial-Number required | string The 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. |
{- "categories": [
- {
- "categoryId": "880f5088-7708-4a5a-87d9-31e83aacc035",
- "orderId": "PaymentReference123",
- "paymentType": "ECOM",
- "type": "RECEIPT",
- "imageId": "f09c6aeb-442e-4da1-b36a-d8f613edc6c9"
}
]
}
Query a category by its id
categoryId required | string <uuid> The id of the category |
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 |
Merchant-Serial-Number required | string The 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. |
{- "categoryId": "880f5088-7708-4a5a-87d9-31e83aacc035",
- "orderId": "PaymentReference123",
- "paymentType": "ECOM",
- "type": "RECEIPT",
- "imageId": "f09c6aeb-442e-4da1-b36a-d8f613edc6c9"
}
Delete a category by its id
categoryId required | string <uuid> The id of the category |
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 |
Merchant-Serial-Number required | string The 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. |
{- "type": "string",
- "title": "string",
- "detail": "string",
- "instance": "string",
- "invalidParams": [
- {
- "name": "string",
- "reason": "string"
}
]
}
Endpoint for uploading images. A imageId will be returned that can be used when adding metadata to orders.
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 |
Merchant-Serial-Number required | string The 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. |
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" |
{- "imageId": "f09c6aeb-442e-4da1-b36a-d8f613edc6c9",
- "src": "a3NhbGZuc2FrbGZubGthc25ma2Fuc2ZsYXNuZmxrYXNuZmw=",
- "type": "base64"
}
{- "imageId": "socks-orange-123"
}
Get order with category and orderlines
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 |
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 |
Merchant-Serial-Number required | string The 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. |
{- "category": {
- "category": "RECEIPT",
- "imageId": "socks-orange-123"
}, - "receipt": {
- "orderLines": [
- {
- "name": "socks",
- "id": "1234567890",
- "totalAmount": 1000,
- "totalAmountExcludingTax": 800,
- "totalTaxAmount": 250,
- "taxPercentage": 25,
- "taxRate": 2500,
- "unitInfo": {
- "unitPrice": 0,
- "quantity": "0.822",
- "quantityUnit": "PCS"
}, - "discount": 2000,
- "isReturn": false,
- "isShipping": false
}
], - "bottomLine": {
- "currency": "NOK",
- "tipAmount": 2000,
- "giftCardAmount": 20000,
- "posId": "string",
- "totalAmount": 0,
- "totalTax": 0,
- "totalDiscount": 0,
- "shippingAmount": 0,
- "shippingInfo": {
- "amount": 1000,
- "amountExcludingTax": 1000,
- "taxAmount": 250,
- "taxPercentage": 25
}, - "paymentSources": {
- "giftCard": 0,
- "card": 0,
- "voucher": 0,
- "cash": 0
}, - "barcode": {
- "format": "EAN-13",
- "data": "string"
}, - "receiptNumber": "string",
- "terminalId": "string"
}
}
}
Add orderlines and bottom line to an order.
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. |
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 |
Merchant-Serial-Number required | string The 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. |
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. |
{- "orderLines": [
- {
- "name": "socks",
- "id": "line_item_1",
- "totalAmount": 1000,
- "totalAmountExcludingTax": 800,
- "totalTaxAmount": 200,
- "taxPercentage": 25,
- "unitInfo": {
- "unitPrice": 400,
- "quantity": "2.5",
- "quantityUnit": "KG"
}, - "discount": 0,
- "isReturn": false,
- "isShipping": false
}, - {
- "name": "flip-flops",
- "id": "line_item_2",
- "totalAmount": 5000,
- "totalAmountExcludingTax": 4000,
- "totalTaxAmount": 1000,
- "taxPercentage": 25,
- "unitInfo": {
- "unitPrice": 2500,
- "quantity": "3",
- "quantityUnit": "PCS"
}, - "discount": 2500,
- "isReturn": false,
- "isShipping": false
}, - {
- "name": "Home Delivery",
- "id": "delivery",
- "totalAmount": 1000,
- "totalAmountExcludingTax": 800,
- "totalTaxAmount": 200,
- "taxPercentage": 25,
- "discount": 0,
- "isReturn": false,
- "isShipping": true
}
], - "bottomLine": {
- "currency": "NOK",
- "tipAmount": 0,
- "posId": "pos_122",
- "paymentSources": {
- "giftCard": 0,
- "card": 0,
- "voucher": 0,
- "cash": 0
}, - "barcode": {
- "format": "CODE 39",
- "data": "SC0527013501 "
}, - "receiptNumber": "0527013501"
}
}
"16328cb8-d769-4c53-90ad-e19777823f0a"
Post additional information about an order that will show up in the order details.
transactionId required | string |
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 |
Merchant-Serial-Number required | string The 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. |
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-_\.]+$ |
{- "category": "GENERAL",
- "imageId": "socks-orange-123"
}
Retrieve the metadata for an order
transactionId required | string |
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 |
Merchant-Serial-Number required | string The 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. |
{- "category": "TICKET",
- "imageIds": [
- {
- "id": "socks-orange-123",
- "sortOrder": 1
}
]
}
Endpoint for retrieving orderlines.
transactionId required | string |
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 |
Merchant-Serial-Number required | string The 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. |
Endpoint for adding orderlines to an order.
transactionId required | string |
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 |
Merchant-Serial-Number required | string The 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. |
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. |
{- "orderLines": [
- {
- "name": "socks",
- "id": "1234567890",
- "totalAmount": 1000,
- "totalAmountExcludingTax": 800,
- "totalTaxAmount": 250,
- "taxPercentage": 25,
- "taxRate": 2500,
- "unitInfo": {
- "unitPrice": 0,
- "quantity": "0.822",
- "quantityUnit": "PCS"
}, - "discount": 2000,
- "isReturn": false,
- "isShipping": false
}
], - "bottomLine": {
- "currency": "NOK",
- "tipAmount": 2000,
- "giftCardAmount": 20000,
- "posId": "string",
- "totalAmount": 0,
- "totalTax": 0,
- "totalDiscount": 0,
- "shippingAmount": 0,
- "shippingInfo": {
- "amount": 1000,
- "amountExcludingTax": 1000,
- "taxAmount": 250,
- "taxPercentage": 25
}, - "paymentSources": {
- "giftCard": 0,
- "card": 0,
- "voucher": 0,
- "cash": 0
}, - "barcode": {
- "format": "EAN-13",
- "data": "string"
}, - "receiptNumber": "string",
- "terminalId": "string"
}
}
{- "type": "string",
- "title": "string",
- "detail": "string",
- "instance": "string",
- "invalidParams": [
- {
- "name": "string",
- "reason": "string"
}
]
}