Quick start

Use the Checkout API to create a checkout session and retrieve session information.

Before you begin

The provided example values in this guide must be changed with the values for your sales unit and user. This applies for API keys, HTTP headers, reference, phone number, etc. Note that any currency amount must be an Integer value minimum 100 in øre.

A note on errors: An endpoint may return a non-successful response code for many reasons, including invalid API keys, missing fields in an input, etc. When errors occur, a response based on https://tools.ietf.org/html/rfc7807 will be returned. The message format may evolve, so avoid building strict logic around it.

Your first Checkout

Step 1 - Setup

You must have already signed up as an organization with Vipps MobilePay and have your test credentials from the merchant portal.

You will need the following values, as described in the Getting started guide:

• client_id - Client_id for a test sales unit.
• client_secret - Client_id for a test sales unit.
• Ocp-Apim-Subscription-Key - Subscription key for a test sales unit.
• Merchant-Serial-Number - The unique ID for a test sales unit.

curl

In Postman, import the following files:

• Checkout API Postman collection
• Global Postman environment

🔥 To reduce risk of exposure, never store production keys in Postman or any similar tools. 🔥

Update the Current Value field in your Postman environment with your Merchant Test keys. Use Current Value field for added security, as these values are not synced to the cloud.

Postman

No additional setup needed :)

Step 2 - Create a checkout session

Create a checkout session with: POST:/v3/session.

curl

Send request Create a Checkout Session

The reference variable is automatically set in the environment of this Postman example.

Postman

curl https://apitest.vipps.no/checkout/v3/session \
-H "Content-Type: application/json" \
-H "client_id: YOUR-CLIENT-ID" \
-H "client_secret: YOUR-CLIENT-SECRET" \
-H "Ocp-Apim-Subscription-Key: YOUR-SUBSCRIPTION-KEY" \
-H "Merchant-Serial-Number: YOUR-MSN" \
-H "Vipps-System-Name: YOUR-COMPANY-NAME" \
-H "Vipps-System-Version: 3.1.2" \
-H "Vipps-System-Plugin-Name: YOUR-PLUGIN-NAME" \
-H "Vipps-System-Plugin-Version: 4.5.6" \
-X POST \
-d '{
  "merchantInfo": {
    "callbackUrl": "https://example.com/vipps/callbacks-for-checkout",
    "returnUrl": "https://example.com/vipps/fallback-result-page-for-both-success-and-failure/acme-shop-123-order123abc",
    "callbackAuthorizationToken": "538dd1d0-9e7f-4732-8134-dfed7fd0b236"
  },
  "transaction": {
    "amount": {
      "value": 1000,
      "currency": "NOK"
    },
    "reference": "UNIQUE-SESSION-REFERENCE",
    "paymentDescription": "One pair of socks."
  }
}'

Take note of the reference value, as it can be used for subsequent calls relating to this session.

To display the session, you will need to load the Checkout SDK in your website, as described in API Guide: Displaying the session.

Step 3 - Retrieve the session information

Retrieve the session information by using GET:/v3/session/{reference} with reference from the previous step.

curl

Send request Get session info

You will see the details appear in the lower pane.

Postman

curl https://apitest.vipps.no/checkout/v3/session/UNIQUE-SESSION-REFERENCE \
-H "Content-Type: application/json" \
-H "client_id: YOUR-CLIENT-ID" \
-H "client_secret: YOUR-CLIENT-SECRET" \
-H "Ocp-Apim-Subscription-Key: YOUR-SUBSCRIPTION-KEY" \
-H "Merchant-Serial-Number: YOUR-MSN" \
-H "Vipps-System-Name: acme" \
-H "Vipps-System-Version: 3.1.2" \
-H "Vipps-System-Plugin-Name: acme-webshop" \
-H "Vipps-System-Plugin-Version: 4.5.6" \
-X GET