API guide

Only available for Vipps.

The PSP Signup API allows Payment Service Providers (PSPs) to onboard and manage their merchants.

This API is the only way to sign up non-Norwegian merchants.

The API specification is available at: PSP Signup API Reference.

API version: 3.0

Introduction

A PSP can use its existing API keys to access this API, and perform the following:

• List one or all merchants under them
• Create a new merchant under them
• Update an existing merchant

See the PSP API Guide for more.

Information shown in Vipps

This contains the information about the merchant as provided by the PSP.

Item	Description
Merchant name	The legal name of the business / organization (e.g., VIPPS TEKNOLOGI AS)
Sales unit name	The name of the sales unit (e.g., Vipps Team Cowboys)
Merchant serial Number	Merchant serial number / sales unit ID (e.g., #119145)
Product name	The name of the product being purchased (e.g., T-shirt)
Order ID / Description	The orderId, or a description provided by the merchant
Transaction ID	The internal Vipps ID for the transaction
Website	The merchant's website (e.g., butikken.no)

The landing page

The payment screen

The receipt screen

Get all merchants

For a JSON response showing all the merchants and their information, send GET:/merchant-management/psp/v1/merchants.

Example response (see the API specification for details):

{
   "merchants":[
      {
         "organizationNumber":"123456789",
         "companyName":"Vipps AS",
         "companyEmail":"user@example.com",
         "merchantSerialNumber":"123456",
         "name":"Example AS",
         "status":"ACTIVE",
         "email":"user@example.com",
         "website":"https://example.com",
         "createdAt":"2019-01-01T00:00:00Z",
         "updatedAt":"2019-01-01T00:00:00Z",
         "address":{

         }
      }
   ]
}

Get information about a specific merchant

For information about a specific merchant, send GET:/merchant-management/psp/v1/merchants/:merchantSerialNumber. Supply the MSN for a merchant in your list of merchants.

Example response (see the API specification for details):

{
   "organizationNumber":"123456789",
   "companyName":"Vipps AS",
   "companyEmail":"user@example.com",
   "merchantSerialNumber":"123456",
   "name":"Example AS",
   "status":"ACTIVE",
   "email":"user@example.com",
   "website":"https://example.com",
   "createdAt":"2019-01-01T00:00:00Z",
   "updatedAt":"2019-01-01T00:00:00Z",
   "address":{
      "addressLine1":"Robert Levins gate 5",
      "addressLine2":"Att: Rune Garborg",
      "city":"Oslo",
      "postCode":"0154",
      "country":"NO"
   }
}

Please note: The mccCode may be returned as null, this is expected.

Create a new merchant sales unit

To create new merchant sales unit, send POST:/merchant-management/psp/v1/merchants.

For Norway: The orgno must be 9 digits without spaces, the merchant must be active in the Norwegian business registry and the orgno must be for the main entity ("hovedenhet"), not a sub entity ("underenhet"). For other countries: The orgno, address, and other information are validated as much as practically possible.

Example request (see the API specification for details):

{
   "organizationNumber":"123456789",
   "name":"Example AS",
   "mccCode":"5411",
   "logo":"VGhlIGltYWdlIGdvZXMgaGVyZQ== (truncated)",
   "email":"user@example.com",
   "website":"https://example.com",
   "address":{
      "addressLine1":"Robert Levins gate 5",
      "addressLine2":"Att: Rune Garborg",
      "city":"Oslo",
      "postCode":"0154",
      "country":"NO"
   },
   "companyName":"Vipps AS",
   "companyEmail":"user@example.com"
}

Update an existing merchant sales unit

To update a merchant sales unit, send PATCH:/v1/merchants/:merchantSerialNumber. Provide the MSN for the merchant and update the details in the body section.

info

PSP sales units can only be updated using the PSP Signup API. The sales units can't be managed on portal.vippsmobilepay.com. Merchants that only have PSP sales units cannot even log in on the portal, since the portal is only for managing sales units that use a direct integration (not through a PSP).