Terminology
Common terms
API keys
Codes that provide a merchant with access to the API (e.g., client_id, client_secret,
Ocp-Apim-Subscription-Key).
Think of them as "username and password".
Keep them secret.
See How to find the API keys.
Capture
Capture is the operation that moves the money from the customer's account to the merchant's account. This can take a few days, depending on your bank. See Reserve and capture for more details.
client_id
The client ID (e.g., the "username") for the merchant. Keep it secret. See How to find the API keys.
client_secret
The client secret (e.g., "password") for the merchant. Keep it secret. See How to find the API keys.
Deeplink
The "deeplink" opens the payment page in the app, where the user accepts a payment. This is an integrated part of the payment process, and the link should never be sent in an SMS or email.
Direct capture
Direct capture causes all payment reservations to be instantly captured. This is intended for situations where the product or service is immediately provided to the customer (e.g. digital services).
Idempotency key
An idempotency header ensures that, if the merchant retries a request with the same idempotency key, the retried request will not make additional changes. See the API specification for the requirements for the idempotency key.
Merchant
A juridical unit, typically called a business, identified with organization number (orgno).
Merchant Serial Number (MSN)
The MSN identifies a sales unit (not a merchant).
We recommend that everyone sends this header so that we can help you debug errors, if the need arises.
Partners must always send the Merchant-Serial-Number header, even when using the merchant's API keys.
The MSN is defined with the sales unit is created.
See How to find the MSN.
National identity number (NIN)
The National Identity Number (NIN) is the identification number given to people by their national government for official use.
In Denmark, the NIN is called Personnummer or CPR-nummer.
In Finland, NIN is henkilötunnus.
In Norway, NIN is fødselsnummer.
Merchants need to apply for access to NIN. See Who can get access to NIN and how?.
Ocp-Apim-Subscription-Key
This is the subscription key for the sales unit. Keep it secret. We will never ask for it, and we don't need it for anything. See how to find the API keys.
orderId
The API parameter that supplies a unique identifier for the payment.
Newer APIs will use reference instead of orderId.
Partner
A partner is a business that represents several merchants by providing a platform, helping set up custom integrations, or developing our official plugins. See Partners.
Partner keys
Unique identifiers that allow partners to use their own API credentials to make API calls on behalf of their merchants. See Partner keys.
Payment Service Provider (PSP)
A third-party business that performs online payments on behalf of Vipps MobilePay. Settlements for PSP integrations are handled by the PSP.
Point of Sale (POS)
A POS is a physical store. It's a type of sales unit.
reference
The API parameter that supplies a unique identifier for the payment.
Newer APIs will use the name reference instead of orderId.
Reserve
When a user accepts a payment request, it will go into the reserved state. The funds stay in the customer's account, but are not available to them.
See Reserve and capture for more details.
Reserve capture
Reserve capture is the normal flow. When the end user approves an initiated payment, it will be marked as reserved by the bank, but not transferred. It will stay reserved until the point at which it is captured.
Sales unit
A sales unit is anything that can sell goods or services and offer payment through Vipps or MobilePay. A merchant can have one or more sales units (e.g., a physical store, an online store, and an app). A merchant might also use different sales units for their different physical locations, different services, different brands, etc.
Norwegian terms
BankID
Software that certifies the identity of a person.
Brønnøysundregistrene
The Brønnøysundregistrene, or Business registry, is the official Norwegian register of companies.
D-nummer
A Norwegian identification number given to foreign persons who do not have a Norwegian National Identity Number (NIN), but have a need for identification for the Norwegian authorities.
Finanstilsynet
The Finanstilsynet is a Norwegian agency that supervises Norwegian financial companies.
Fødselsnummer
The National Identity Number (NIN) for Norway. An 11-digit number that uniquely identifies each Norwegian citizen. See Fødselsnummer.
orgno
The organization number for a merchant. Nine digits. This can be used to retrieve information at Brønnøysundregistrene.
Danish terms
MitID
Software that certifies the identity of a person. See MitID.
Det Centrale Virksomhedsregister
The official Danish register of companies. See Det Centrale Virksomhedsregister.
orgno
The organization number for a merchant. Also called CVR or VAT-number. 8 digits. This can be used to retrieve information at Det Centrale Virksomhedsregister.
Finanstilsynet
The Danish Financial Supervisory Authority that supervises Danish financial companies. See Finanstilsynet.
CPR-nummer
The National Identity Number (NIN) for Denmark. A 10-digit number that uniquely identifies each Danish citizen. See CPR-nummer.
Administrative CPR-nummer
A Danish identification number given to foreign persons who don't have a Danish social security number (SSN), but have a need for identification for the Danish authorities.
Finnish terms
Finnish Trust Network (FTN)
Software that certifies the identity of a person.
Yritys- ja yhteisötietojärjestelmä (YJT)
The official Finnish register of companies. See Yritys- ja yhteisötietojärjestelmä (YJT).
orgno
The business ID for a merchant. Also called Y-tunnus (Yritys- ja yhteisötunnus) or VAT-number. 8 digits. This can be used to retrieve information at YTJ.
Finanssivalvonta
Financial Supervisory Authority. See Finanssivalvonta.
Henkilötunnus
The National Identity Number (NIN) for Finland. A sequence of 11 characters that uniquely identifies each Finnish citizen. See Henkilötunnus.