Pre-built Order Management API integration

The ePayment API comes with pre-built order management API integration, making it easy to supply order information at payment creation. Read more about the Order Management API in Order Management API. Instead of adding receipt with a different API call, merchant can send the information as part of Create Payment

Create a payment with order lines

Remember to have a fresh access token, see Set up and Authorize. Then, call the POST:/epayment/v1/payments with paymentMethod type = "WALLET".

curl -X POST https://apitest.vipps.no/epayment/v1/payments \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR-ACCESS-TOKEN" \
-H "Ocp-Apim-Subscription-Key: YOUR-SUBSCRIPTION-KEY" \
-H "Merchant-Serial-Number: YOUR-MSN" \
-H 'Idempotency-Key: YOUR-IDEMPOTENCY-KEY' \
-H "Vipps-System-Name: acme" \
-H "Vipps-System-Version: 3.1.2" \
-H "Vipps-System-Plugin-Name: acme-webshop" \
-H "Vipps-System-Plugin-Version: 4.5.6" \
-d '{
   "amount":{
      "currency":"NOK",
      "value":1000
   },
   "paymentMethod":{
      "type":"WALLET"
   },
   "reference":"acme-shop-123-order123abc",
   "returnUrl":"https://example.com/redirect?reference=acme-shop-123-order123abc",
   "userFlow":"PUSH_MESSAGE",
   "paymentDescription":"Two pairs of socks",
   "receipt":{
      "orderLines":[
         {
            "name":"Vipps socks",
            "id":"line_item_1",
            "totalAmount":1000,
            "totalAmountExcludingTax":800,
            "totalTaxAmount":200,
            "taxPercentage":25,
            "unitInfo":{
               "unitPrice":400,
               "quantity":"2",
               "quantityUnit":"PCS"
            },
            "discount":0,
            "productUrl":"https://example.com/store/socks",
            "isReturn":false,
            "isShipping":false
         },
         {
            "name":"Home Delivery",
            "id":"delivery",
            "totalAmount":200,
            "totalAmountExcludingTax":100,
            "totalTaxAmount":100,
            "taxPercentage":50,
            "discount":0,
            "isReturn":false,
            "isShipping":true
         }
      ],
      "bottomLine":{
         "currency":"NOK",
         "tipAmount":0,
         "barcode":{
            "format":"EAN13",
            "data":"696969"
         },
         "posId":"vipps_pos_122",
         "paymentSources":{
            "giftCard":2,
            "voucher":0,
            "cash":0
         },
         "receiptNumber":"0527013501"
      }
   }
}'