Skip to main content

Point of Sale to ePayment

Read more about the transition to one platform. Below you can find comparison between the existing MobilePay PoS API and the new ePayment API replacing MobilePay PoS.

Visit our Recommended flows to see the recommended flow for in-store payment merchant scan.

PoS and ePayment endpoints

OperationMobilePay PoSePayment
PoS managementPOST/GET/DELETE /v10/pointofsalesN/A
Initiate PaymentPOST:/v10/paymentsPOST:/epayments/v1/payments
Initiate Prepared paymentPOST:/v10/payments/prepareN/A (For loyalty, see Loyalty at POS)
Query PaymentGET:/v10/payments/{paymentid}GET:/epayments/v1/payments/{reference}
Query Active PaymentsGET /v10/paymentsN/A
Query payment logN/AGET:/epayments/v1/payments/{reference}/events
Capture PaymentPOST:/v10/payments/{paymentid}/capturePOST:/epayments/v1/payments/{reference}/capture
Cancel PaymentPOST:/v10/payments/{paymentid}/cancelPOST:/epayments/v1/payments/{reference}/cancel
Refund PaymentPOST:/v10/refundsPOST:/epayments/v1/payments/{reference}/refund
Lookup a refundGET:/v10/refunds/{refundid}GET:/epayments/v1/payments/{reference}

Authentication and headers

See:

MobilePay PoSePayment
Authorization (POST:/connect/token)Authorization (POST:/accesstoken/get)
X-MobilePay-Client-System-VersionVipps-System-Version (see HTTP headers)
N/AVipps-System-Name (see HTTP headers)
N/AVipps-System-Plugin-Name (see HTTP headers)
N/AVipps-System-Plugin-Version (see HTTP headers)
X-MobilePay-Merchant-VAT-NumberN/A
X-MobilePay-Idempotency-KeyIdempotency-Key (see Idempotency)
N/AOcp-Apim-Subscription-Key
N/AMerchant-Serial-Number

Initiate Payment

See:

MobilePay PoSePayment
amountamount (currency, value)
currencyCodeApplied in amount
orderIdpaymentDescription​
plannedCaptureDelayN/A
posIdN/A
restrictions (debitCardDisallowed, creditCardDisallowed)N/A
merchantPaymentLabelN/A
N/Acustomer (phoneNumber)
N/AcustomerInteraction ("CUSTOMER_PRESENT")
N/ApaymentMethod (type "WALLET")
N/Areference
N/AuserFlow ("PUSH_MESSAGE" "QR")
N/AqrFormat (format, size)
Response
paymentIdreference (set in paymentInitiation)

Query Payment

See:

MobilePay PoSePayment
paymentIdreference
Response
orderIdreference
amountamount (currency, value)
currencyCodeApplied in amount
statusstate
N/Aaggregate (authorizedAmount, cancelledAmount, capturedAmount, refundedAmount)
N/ApaymentMethod (type)
loyaltyIdsprofile (sub) (see What is the sub?)
N/ApspReference

N/A: posId, restrictions (debitCardDisallowed, creditCardDisallowed), merchantPaymentLabel, plannedCaptureDelay, customerToken, customerReceiptToken, paymentExpiresAt, partialCapturePossible, pollDelayInMs

Capture, Cancel and Refund Payment

See:

MobilePay PoSePayment
paymentIdreference
amountmodificationAmount (currency, value) not applicable for cancel
Response
N/Aamount (currency, value)
N/Astate
N/Aaggregate (authorizedAmount, cancelledAmount, capturedAmount, refundedAmount)
refundId only applicable for refundpspReference
N/Areference

Test environment

The test environment is called Merchant Test (MT) and is now open for test. MT currently only allows Norwegian phone numbers and merchants, but you can test the API and payment flow. Please see the details of limitations of the test environment.

You need credentials to get access to MT. Just request it on the MobilePay merchant test page, and we'll e-mail you the information you need.