Skip to main content

Online payments


Last updated: 13-Mar-2024


Checkout can be used to accept Vipps payments.

Integration options supported: Hosted payment page (HPP) or IFRAME.

This guide requires familiarity with Accepting payments.

Integrate Vipps via Checkout

Parameters Type Required Description
currency_code String Yes Supported currencies: NOK
amount Integer Yes Transaction amount
customer String Yes ID of a Customer created via the Customer API. A customer object can be created and attached to a Checkout.
configurations.vipps Object Yes Object carrying the parameters required for making a Vipps payment


String Yes This ID can be found in the portal or given to you by a Verifone employee. It is used to retrieve a merchant's Vipps credentials necessary for payment.


String No Short text to be displayed on the bank statement of the cardholder. Support varies per Payment Contract.


Boolean No Used for separate authorization and capture


Boolean No Flag to identify the transaction originated from APP or Browser


String No Indicates the phone number, without country code, registered with Vipps Mobile APP. Supported value: 8 digits without spaces.


Object  No Details regarding SCA compliance Required, 3DS Required and authorization type Required


String No Card Authorization Type (PRE_AUTH, FINAL_AUTH). When capture_now is set to true, pre-authorization transactions cannot be done.

Authorization and capture

You can use Vipps transactions through the Checkout to do a sale (capture_now = true) or to authorize without capturing immediately (capture_now = false). An authorized payment reserves the money and allows you to capture the funds at a later stage.

Sending a checkout request using Vipps payment method:


    "currency_code": "NOK",
    "entity_id": "466c5c59-5177-45c2-b9a7-41ac422ef1fa",
    "customer": "deebacec-cd75-4ce5-9641-bfc40de5710d",
    "configurations": {
        "vipps": {
            "dynamic_descriptor": "Test Product",
            "capture_now": true,
            "payment_contract_id": "98a003be-03f2-43c4-a89c-36021fa63635",
            "app_phone_number": "40950037",
            "card": {
                "sca_compliance_level": "WALLET",
                "authorization_type": "FINAL_AUTH",
                "threed_secure": {
                    "enabled": true,
                    "threeds_contract_id": "76c87838-610e-40cf-8434-c91debb7cfd9",
                    "total_items": "01",
                    "transaction_mode": "S"
    "amount": 4300,
    "merchant_reference": "Test",
    "return_url": "",
    "interaction_type": "HPP"


Handling responses

Whenever a card payment is processed via the Checkout, the responses events include additional parameters specific to card payments in the Details object.

Example of a successful Vipps payment via the Checkout:



        "type": "TRANSACTION_INITIATED",
        "id": "8de44848-c9eb-48c1-bafe-ba97bf3fb77f",
        "timestamp": "2021-09-15T12:03:55.368Z",
        "details": {

            "amount": 400,
            "created_at": "2021-09-15T12:03:55.071859Z",
            "customer": "deebacec-cd75-4ce5-9641-bfc40de5710d",
            "details": {},
            "merchant_reference": "f811eb59-9fb6-4ac0-a0ee-df36e8e0fe4f",
            "status": "INITIATED",
            "shopper_interaction": "ECOMMERCE",
            "geo_location": [
            "country_code": "FI",
            "id": "03732287-5fca-4e63-baa7-9f059af58a62",
            "redirect_url": "",
            "processor": "NETS",
            "payment_product": "CARD",
            "payment_product_type": "Unknown"




        "type": "TRANSACTION_SUCCESS",
        "id": "1aaebd63-2daf-4753-bc32-bcdb8c35b743",
        "timestamp": "2021-03-31T11:44:07.717Z",
        "details": {

            "id": "fd31890c-8c45-4846-a934-a7faa584e823",
            "captureId": "93459848W31137123",
            "createdAt": "2021-03-31T11:44:06Z",
            "isFinalCapture": true,
            "payer": {
                "payerId": "92FT3NN28KELQ",
                "shippingAddress": {
                    "country": "IN",
                    "postalCode": "100047",
                    "countrySubdivision": "Maharashtra",
                    "city": "Mumbai",
                    "addressLine1": "addressLine1",
                    "addressLine2": "addressLine2",


            "status": "AUTHORISED"



Example of a failed Vipps payment via the Checkout:



        "type": "TRANSACTION_FAILED",
        "id": "f2041250-4fc2-4b3a-bc94-651ba099541a",
        "timestamp": "2020-07-08T12:42:37.974Z",
        "details": {

              "id": "6d85d047-1e78-4f13-afe2-cc041bce524f",
              "authorizationId": "4PB16132MH590854B",
              "createdAt": "2021-01-06T04:40:30Z",
              "expiresAt": "2021-02-04T04:40:30Z",
              "status": "FAILED",
              "payer": {

                  "payerId": "92FT3NN28KELQ",
                  "shippingAddress": {

                      "country": "IN",
                      "postalCode": "100047",
                      "countrySubdivision": "Maharashtra",
                      "city": "Mumbai",
                      "addressLine1": "addressLine1",
                      "addressLine2": "addressLine2",





  • Note: To ensure that the redirection request was not tampered with, always check that the transaction_id received as query parameter in the redirection matches the transaction_id property of the retrieved Checkout. If those are not matching, this is indication of either an incorrect integration, that the redirection to your return_url did not originate from Verifone, or transaction_id was tampered with.
  • You can now store the transaction_id value together with the order 1234 in your system to link the two together.






The table below describes the different outcomes of a Checkout. A full list of error codes is available.



Merchant action

Failed transaction*

Redirect: checkout_id={checkout_id} & transaction_id={transaction_id} & errorCode=123

Unsuccessful payment (technical reason), do not display order confirmation

Successful transaction

Redirect: checkout_id={checkout_id} & transaction_id={transaction_id}

Display order confirmation

Customer visits the URL of an already completed Checkout

Redirect: checkout_id={checkout_id} & errorCode=168

Display corresponding message to the customer. Checkout is completed whenever there was a single successful payment processed through it.

Customer visits the URL of an expired Checkout

Redirect: checkout_id={checkout_id} & errorCode=169

Display corresponding message to the customer. Checkout is expired whenever the expiry_time is reached

Customer visits the URL of a Checkout which has reached the maximum of failed payment attempts

Redirect: checkout_id={checkout_id} & errorCode=165

Display corresponding message to customer. Payments through a single Checkout can be attempted up to three times unsuccessfully.

Form validation errors / Other service failures on the Checkout page

Displays error alert to Customer on the page

Customer is prompted to correct their form input and retry the payment or try using alternate card or payment method

  *** Failed transaction - Depending on which step in the payment process failed, the transaction_id might not always be present as the query parameter

Need help?

Do you have a question? If you didn’t find the answer you are looking for in our documentation, you can contact our Support teams for more information. If you have a technical issue or question, please contact us. We are happy to help.

Not yet a Verifone customer?

We’ll help you choose the right payment solution for your business, wherever you want to sell, in-person or online. Our team of experts will happily discuss your needs.

Verifone logo