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 sales unit. Keep it secret. See How to find the API keys.
client_secret
The client secret (e.g., "password") for the sales unit. 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 company or business, identified with organization number (orgno).
Merchant Serial Number (MSN)
The MSN identifies a sales unit (not a business, which is identified with the organization number). The MSN is defined with the sales unit is created.
To find the MSN, see:
- Merchant portal: How to find the MSN
- For PSPs, see the PSP API guide
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 CPR-nummer or personnummer.
In Finland, NIN is called henkilötunnus.
In Norway, NIN is fødselsnummer or personnummer.
In Sweden, NIN is personnummer.
This information is protected. If you need access, 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. This is case-sensitive.
Organization number
The organization number (also called, "org number" or "orgno") is a unique identifier for a business and can be used to retrieve information and the national registries for the country in which the business operates.
Vipps MobilePay is legally required by the financial authorities to perform several checks of all businesses that have a customer relationship with us. This is based on each business' organization number, and the legally binding agreement between the businesses and Vipps MobilePay.
If a business has "changed organization numbers", it is considered a new legal entity, regardless of whether the business has the same name, or is owned by the same people The new business needs a new agreement with Vipps MobilePay. Establishing a new customer relationship for the new business is done on the merchant portal or through their Payment Service Provider, if applicable.
In Denmark, this consists of 8 digits.
Also known as CVR or VAT-number, this can be used to retrieve information at Det Centrale Virksomhedsregister.
In Finland, this consists of 8 digits.
Also known as Y-tunnus (Yritys- ja yhteisötunnus) or VAT-number, this can be used to retrieve information at YTJ.
In Norway, this consists of 9 digits without spaces.
This can be used to retrieve information at the Norwegian business registry.
The business must be active in the Norwegian business registry
and the organization number must be for the main entity ("hovedenhet"),
not a sub entity ("underenhet").
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. This is case-sensitive.
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/company/organization 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.
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.
Finanstilsynet
The Danish Financial Supervisory Authority that supervises Danish financial companies. See Finanstilsynet.
CPR-nummer
CPR-nummer is the National Identity Number (NIN) for Denmark, also called personnummer. A 10-digit number that uniquely identifies each Danish citizen.
Non-citizens can get an identity number called a Administrative CPR-nummer.
This information is protected. If you need access, see Who can get access to NIN and how.
More information about Danish identity numbers can be found at:
Administrative CPR-nummer
A National Identity number given to non-Danish citizens who don't have a Danish CPR-nummer, but have a need for identification for the Danish authorities.
This information is protected. If you need access, see Who can get access to NIN and how.
More information about Danish identity numbers can be found at:
Finnish terms
Finnish Trust Network (FTN)
Software that certifies the identity of a person. See FTN.
Yritys- ja yhteisötietojärjestelmä (YJT)
The official Finnish register of companies. See Yritys- ja yhteisötietojärjestelmä (YJT).
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.
This information is protected. If you need access, see Who can get access to NIN and how.
More information about Finnish identity numbers can be found at:
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 identity number (NIN) given to foreign persons who do not have a Norwegian Fødselsnummer, but have a need for identification for the Norwegian authorities. An 11-digit number that uniquely identifies each Norwegian citizen.
This information is protected. If you need access, see Who can get access to NIN and how.
More information about Norwegian identity numbers can be found at:
Finanstilsynet
The Finanstilsynet is a Norwegian agency that supervises Norwegian financial companies.
Fødselsnummer
Fødselsnummer is the National Identity Number (NIN) for Norway, also called "personnummer". An 11-digit number that uniquely identifies each Norwegian citizen.
Non-citizens can get an identity number called a D-nummer.
This information is protected. If you need access, see Who can get access to NIN and how.
More information about the Norwegian identity number can be found at:
Swedish terms
Personnummer
Personnummer is the National Identity Number (NIN) for Sweden.
This information is protected. If you need access, see Who can get access to NIN and how.
More information about the Swedish identity number can be found at: