Vipps for Payment Setup API

Last updated: April 30, 2026

To accept Vipps payments, you must:

Create a payment setup.
Confirm the payment.
Redirect the customer to Vipps.

Call the Create a payment setup endpoint.

Information

Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see API endpoints.

post

https://{prefix}.api.checkout.com/payments/setups


1{
2  "amount": 1000,
3  "currency": "NOK",
4  "settings": {
5    "success_url": "https://example.com/payments/success",
6    "failure_url": "https://example.com/payments/failure"
7  }
8}

In the request body, provide the following:

Field	Description
`amount` number	The payment amount, in the minor currency unit. Minimum: 1 Required
`currency` string	Three-letter ISO 4217 currency code. Supported value: `NOK` Required
`settings.failure_url` string	The URL to redirect the customer to if the payment fails. Format: URI Max length: 1024 Required
`settings.success_url` string	The URL to redirect the customer to if the payment is successful. Format: URI Max length: 1024 Required
`customer.phone` object	The customer's phone number details.
`customer.phone.country_code` string	The country code of the customer's phone number. Min length: 1 Max length: 7
`customer.phone.number` string	The customer's phone number. Max length: 25
`description` string	A description of the payment. Max length: 100
`reference` string	A reference you can use to identify the payment. Max length: 80


1{
2  "id": "set_rcmepwrchqab2wsergcafvijfy",
3  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
4  "amount": 1000,
5  "currency": "NOK",
6  "payment_type": "Regular",
7  "reference": "ORD-5023-4E89",
8  "description": "Vipps payment",
9  "payment_methods": {
10    "vipps": {
11      "status": "ready",
12      "flags": []
13    }
14  },
15  "available_payment_methods": [
16    "vipps"
17  ],
18  "settings": {
19    "success_url": "https://example.com/payments/success",
20    "failure_url": "https://example.com/payments/failure"
21  }
22}

The response returns a payment_methods object, which contains the payment methods enabled on your account.

When all required fields are present, the payment_methods.vipps object shows a ready status.

Confirm the payment by calling the Confirm a payment setup endpoint and provide:

The payment setup id as the {id} path parameter.
vipps as the payment method name.

post

https://{prefix}.api.checkout.com/payments/setups/{id}/confirm/vipps


1{
2  "id": "pay_py2itltbdu3ebnvd7heh7u6i4e",
3  "status": "Pending",
4  "reference": "ORD-5023-4E89",
5  "customer": {
6    "id": "cus_urx7wggzcpzufjjynbn7t6l5mq",
7    "phone": {
8      "country_code": "47",
9      "number": "99293473"
10    }
11  },
12  "_links": {
13    "self": {
14      "href": "https://{prefix}.api.checkout.com/payments/pay_py2itltbdu3ebnvd7heh7u6i4e"
15    },
16    "redirect": {
17      "href": "https://apitest.vipps.no/dwo-api-application/v1/redirectURL"
18    }
19  }
20}

Redirect the customer to the _links.redirect.href URL from the response. The customer completes the payment on the Vipps page and is then redirected back to your settings.success_url or settings.failure_url.

Vipps for Payment Setup API

Create a payment setup

Information

Request example

Response example

Confirm the payment

Request example

Response example

Redirect the customer