App Payments to ePayment
Read more about the transition to one platform on the MobilePay site. Below, you can find comparison between the existing MobilePay App Payments API and the new ePayment API replacing MobilePay App Payments.
App Payments and ePayment endpoints
| Operation | MobilePay App Payments | ePayment |
|---|---|---|
| Initiate Payment | POST:/v1/payments | POST:/epayments/v1/payments |
| Fetch Single Payment | GET:/v1/payments/{paymentid} | GET:/epayments/v1/payments/{reference} |
| Fetch a list of payments | GET /v1/payments | N/A |
| Query payment log | N/A | GET:/epayments/v1/payments/{reference}/events |
| Capture Payment | POST:/v1/payments/{paymentid}/capture | POST:/epayments/v1/payments/{reference}/capture |
| Cancel Payment | POST:/v1/payments/{paymentid}/cancel | POST:/epayments/v1/payments/{reference}/cancel |
| Issue new refund | POST:/v1/refunds | POST:/epayments/v1/payments/{reference}/refund |
| fetch a list of refunds | GET:/v1/refunds | N/A |
| fetch single refund | GET:/v1/refunds/{refundid} | GET:/epayments/v1/payments/{reference} |
Authentication and headers
See:
| MobilePay App Payments | ePayment |
|---|---|
apiKey or openId | Authorization (POST:/accesstoken/get) |
| N/A | Vipps-System-Version (see HTTP headers) |
| N/A | Vipps-System-Name (see HTTP headers) |
| N/A | Vipps-System-Plugin-Name (see HTTP headers) |
| N/A | Vipps-System-Plugin-Version (see HTTP headers) |
X-MobilePay-Idempotency-Key | Idempotency-Key (see Idempotency) |
| N/A | Ocp-Apim-Subscription-Key |
| N/A | Merchant-Serial-Number |
Initiate Payment
See:
| MobilePay App Payments | ePayment |
|---|---|
amount | amount (currency, value) |
idempotencyKey | Idempotency-Key |
reference | paymentDescription |
paymentPointId | Merchant-Serial-Number |
redirectUri | returnUrl |
description | paymentDescription |
customerPhoneNumber (Used for dual device flows on web) | customer (phoneNumber) |
| N/A | customerInteraction ("CUSTOMER_NOT_PRESENT") |
| N/A | paymentMethod (type "WALLET") |
| N/A | reference |
| N/A | userFlow ("NATIVE_REDIRECT" "WEB_REDIRECT") |
| Response | |
paymentId | reference (set in paymentInitiation) |
Query Payment
See:
| MobilePay App Payments | ePayment |
|---|---|
paymentId | reference |
| Response | |
paymentId | reference |
amount | amount (currency, value) |
description | N/A |
state | state |
| N/A | aggregate (authorizedAmount, cancelledAmount, capturedAmount, refundedAmount) |
| N/A | paymentMethod (type) |
| N/A | profile (sub) (see What is the sub?) |
| N/A | pspReference |
Capture, Cancel and Refund Payment
See:
| MobilePay App payments | ePayment |
|---|---|
paymentId | reference |
amount | modificationAmount (currency, value) not applicable for cancel |
| Response | |
| N/A | amount (currency, value) |
| N/A | state |
| N/A | aggregate (authorizedAmount, cancelledAmount, capturedAmount, refundedAmount) |
refundId only applicable for refund | N/A |
| N/A | pspReference |
| N/A | reference |
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. In order to receive those, you just need to sign up as partner, and we'll e-mail you the information you need to get started. This is also needed even though you are an existing MobilePay integrator, since we need your information registered on our new joint platform.