Vipps API Client - API Contract

POST /api/v1/vipps/api/v1/vipps/token

Proxy token exchange request to Vipps API

Public

Request Example

{
  "grant_type": "authorization_code",
  "code": "auth_code_aBcDeFgH1234",
  "redirect_uri": "myapp://vipps-callback",
  "code_verifier": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk",
  "client_id": "vipps-client-abc123"
}

Response Example

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refresh_token": "rt_vippsRefresh9988",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "openid phoneNumber name"
}

GET /api/v1/vipps/api/v1/vipps/userinfo

Proxy userinfo fetch from Vipps API

Public

Response Example

{
  "sub": "c06c4afe-d9e1-4c5d-939a-177d88e9dbcd",
  "name": "Kari Nordmann",
  "phone_number": "+4799887766",
  "email": "kari.nordmann@example.no",
  "nin": "15076500565"
}

POST /api/v1/vipps/api/v1/vipps/token/revoke

Revoke a Vipps token

Public

Request Example

{
  "token": "rt_vippsRefresh9988",
  "token_type_hint": "refresh_token"
}

Response Example

{
  "revoked": true,
  "revoked_at": "2026-03-26T10:25:00Z"
}

PUT /api/v1/vipps/api/v1/vipps/environment

Set Vipps API environment (test/production)

Public

Request Example

{
  "environment": "production"
}

Response Example

{
  "environment": "production",
  "base_url": "https://api.vipps.no",
  "updated_at": "2026-03-26T10:26:00Z"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}