Skip to main content

Vipps Order Management API (1.0)

Download OpenAPI specification:Download

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
Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sale unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Authorization
required
string

Bearer

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

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

imageId
string [ 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
Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sale unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Authorization
required
string

Bearer

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

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
Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sale unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Authorization
required
string

Bearer

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

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

imageId
string [ 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
Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sale unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Authorization
required
string

Bearer

Responses

Response samples

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

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
Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sale unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Authorization
required
string

Bearer

Responses

Response samples

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

Receipt

Add receipt to an order.

Add receipt to an order.

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
Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sale unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Authorization
required
string

Bearer

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

Summary of the order. Total amount and total

Responses

Request samples

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

Response samples

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

Get receipt for an order Deprecated

Endpoint for retrieving receipts.

Authorizations:
BearerToken
path Parameters
transactionId
required
string
header Parameters
Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sale unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Authorization
required
string

Bearer

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
Merchant-Serial-Number
required
string

The Vipps merchant serial number for this sale unit.

Ocp-Apim-Subscription-Key
required
string

The API subscription key.

Authorization
required
string

Bearer

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

Summary of the order. Total amount and total

Responses

Request samples

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

Response samples

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