Download OpenAPI specification:Download
The Vipps PSP Signup API allows PSPs to onboard and control their merchants. See the PSP Signup API guide for more details.
This returns an array of all the merchant sales units you have created.
Authorization required | string 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 |
Ocp-Apim-Subscription-Key required | string This is your PSP subscription key, used to create and manage payments for all your merchants. Keep it secret. |
{- "merchants": [
- {
- "organizationNumber": "123456789",
- "companyName": "Vipps AS",
- "companyEmail": "user@example.com",
- "merchantSerialNumber": "123456",
- "name": "Example AS",
- "status": "ACTIVE",
- "email": "user@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"
}, - "marketPlaceId": "string"
}
]
}
Create a new merchant sales unit.
Authorization required | string 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 |
Ocp-Apim-Subscription-Key required | string This is your PSP subscription key, used to create and manage payments for all your merchants. Keep it secret. |
Idempotency-Key required | string Unique key for idempotent operation |
merchant
organizationNumber required | string [ 1 .. 50 ] characters Organization number of the merchant, in the correct format for the organization's country. 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, etc is validated as much as practically possible. |
name required | string [ 1 .. 200 ] characters The merchant's name. This name will be displayed in the Vipps app. This may be different from the legal name in |
mccCode required | string = 4 characters ^\d{4}$ Four-digit number listed in ISO 18245 for retail financial services, used to classify a business by the types of goods or services it provides |
marketPlaceId | string^[a-zA-Z0-9-]{0,64}$ ID of the merchant's marketplace. This is related to invoicing multiple merchants in the same price tier and requires special contract to take effect |
logo required | string Base64 encoded string of the logo of the merchant. The logo will be displayed in the Vipps app, both when paying and on receipts. The logo must be in PNG (Portable Network Graphics) format. Square images are recommended. The longest side can not be more than 1000 pixels. The minimum size is 100 x 100 pixels. |
string <email> <= 255 characters ^[a-zA-Z0-9.!#$%&*+\/=?^_{|}~-]+@[a-zA-Z0-9](... Contact email for the merchant. Can be same as companyEmail | |
website | string <uri> <= 255 characters ^[(http(s)?):\/\/(www\.)?a-zA-Z0-9@:\-%._\+~#... The URL for the merchant's website |
required | object (Address) The merchant's address |
companyName required | string [ 1 .. 255 ] characters The legal name of the organization. This may be different from |
companyEmail required | string <email> <= 255 characters ^[a-zA-Z0-9.!#$%&*+\/=?^_{|}~-]+@[a-zA-Z0-9](... The merchant's email address |
{- "organizationNumber": "123456789",
- "name": "Example AS",
- "mccCode": "5411",
- "marketPlaceId": "string",
- "logo": "VGhlIGltYWdlIGdvZXMgaGVyZQ== (truncated)",
- "email": "user@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"
}
{- "merchantSerialNumber": "string"
}
Get details for a merchant sales unit.
merchantSerialNumber required | string [ 5 .. 10 ] characters ^\d{5,10}$ The Vipps merchant serial number |
Authorization required | string 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 |
Ocp-Apim-Subscription-Key required | string This is your PSP subscription key, used to create and manage payments for all your merchants. Keep it secret. |
{- "organizationNumber": "123456789",
- "companyName": "Vipps AS",
- "companyEmail": "user@example.com",
- "merchantSerialNumber": "123456",
- "name": "Example AS",
- "status": "ACTIVE",
- "email": "user@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"
}, - "marketPlaceId": "string"
}
Update limited details for a merchant sales unit.
merchantSerialNumber required | string [ 5 .. 10 ] characters ^\d{5,10}$ The Vipps merchant serial number |
Authorization required | string 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 |
Ocp-Apim-Subscription-Key required | string This is your PSP subscription key, used to create and manage payments for all your merchants. Keep it secret. |
merchant
deactivate | boolean Set as true in order to deactivate a merchant. Already deactivated merchant cannot be activated or updated through the API |
name | string <= 200 characters The merchant's name. This name will be displayed in the Vipps app. This may be different from the legal name in |
mccCode | string = 4 characters ^\d{4}$ Four-digit number listed in ISO 18245 for retail financial services, used to classify a business by the types of goods or services it provides |
logo | string Base64 encoded string of the logo of the merchant. The logo will be displayed in the Vipps app, both when paying and on receipts. The logo must be in PNG (Portable Network Graphics) format. Square images are recommended. The longest side can not be more than 1000 pixels. The minimum size is 100 x 100 pixels. |
string <email> <= 255 characters ^[a-zA-Z0-9.!#$%&*+\/=?^_{|}~-]+@[a-zA-Z0-9](... Contact email for the merchant. Can be same as companyEmail | |
website | string <uri> <= 255 characters ^[(http(s)?):\/\/(www\.)?a-zA-Z0-9@:%._\+~#=]... The URL for the merchant's website |
object (Address) The merchant's address | |
marketPlaceId | string^[a-zA-Z0-9-]{0,64}$ ID of the merchant's marketplace. This is related to invoicing multiple merchants in the same price tier and requires special contract to take effect |
{- "deactivate": true,
- "name": "Example AS",
- "mccCode": "5411",
- "logo": "string",
- "email": "user@example.com",
- "address": {
- "addressLine1": "Robert Levins gate 5",
- "addressLine2": "Att: Rune Garborg",
- "city": "Oslo",
- "postCode": "0154",
- "country": "NO"
}, - "marketPlaceId": "string"
}
{- "title": "Postcode validation error",
- "status": 400,
- "detail": "Postcode must be four digits",
}