Skip to main content

Check-in API (1.0.2)

Download OpenAPI specification:Download

The Check-in API enables you to communicate with users in a physical point of sale context. For details, see the API Guide.

point-of-sale

Initiate a loyalty check in session for a Vipps user

Endpoint for triggering a Vipps loyalty check-in

Authorizations:
BearerToken
header Parameters
Authorization
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni (truncated)

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.

Ocp-Apim-Subscription-Key
required
string
Example: 0f14ebcab0ec4b29ae0cb90d91b4a84a

The subscription key for a sales unit. See API keys.

Merchant-Serial-Number
string
Example: 123456

The merchant serial number (MSN) for the sales unit. Partners 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.

Vipps-System-Name
string <= 30 characters
Example: WooCommerce

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

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

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

Vipps-System-Plugin-Name
string <= 30 characters
Example: woocommerce-payment

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

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

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

Request Body schema: application/json
phoneNumber
required
string or null^47[0-9]{8}$

Phone number for the user in MSISDN format.

isMember
required
boolean or null

Is the customer a member of the loyalty program?

Responses

Request samples

Content type
application/json
{
  • "phoneNumber": "4791234567",
  • "isMember": true
}

Response samples

Content type
application/json
"string"