Skip to main content

Vipps Issuer Provisioning API (⚠️ Work in Progress) (0.1.0)

Download OpenAPI specification:Download

API to securely communicate card details with Vipps on behalf of card holder,

Authentication

Mutual TLS authentication for secure API communication. To access this API, you must provide a valid client certificate signed by Vipps CA.

PaymentSources

Initiate Card Provisioning

Initiate card provisioning flow to let user easily add the given card to their Vipps app.

Request Body schema: application/json
required
encryptedCardData
required
string

Encrypted JSON Web Encryption (JWE) token containing sensitive card data.

  • Required headers: alg, enc, kid.
  • Algorithm: RSA-OAEP-256 with SHA-256 key and 4096-bit size.
  • Encryption: AES-128-GCM with 128-bit key.
  • Pan: Payment Account Reference (PAN) of the card e.g. 1234567890123456.
  • Expiry: Card expiration date in YYYY-MM format, e.g. '2025-12'.
  • Payload: { pan, expiry }.
countryCode
required
string

ISO 3166-1 alpha-2 country code for the cardholder's issuing country.

nin
required
string

National identity number of the cardholder.

returnUrl
required
string

Redirect URL for returning to the calling application after provisioning completes.

appSwitch
required
boolean

Indicates whether the issuer is calling from a mobile device that may have the Vipps app installed.

last4
required
string

Last 4 digits of the card number for display and verification purposes.

Responses

Request samples

Content type
application/json
{
  • "encryptedCardData": "eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2R0NNIn0...",
  • "countryCode": "NO",
  • "nin": "12345678901",
  • "appSwitch": true,
  • "last4": "1234"
}