Vipps MobilePay
Offer Vipps and MobilePay in the Nordics: switch it on for your platform, set up the contract with the merchant's Vipps MobilePay keys, then test.
Ginger connects directly to Vipps MobilePay, so your merchants can offer Vipps and MobilePay in the Nordics with the payment method vipps-mobilepay. This page shows how you set up your platform, how you connect a merchant, and how you test.
A Vipps MobilePay payment is an authorisation: the amount is reserved in the customer's app, and the merchant captures it later, or voids it. Delayed capture is also supported (see the changelog).
Vipps MobilePay is the acquirer: it pays the merchant directly. Vipps MobilePay payments are not in the payouts of Ginger.
Set up your platform
You do this once, with Vipps MobilePay and your Ginger contact.
Become a Vipps MobilePay partner
Your platform needs a technical agreement with Vipps MobilePay for the ePayment API: apply as a partner on the Vipps MobilePay partner page. Vipps MobilePay gives you access to its test environment, reviews the integration against its partner checklist, and then approves you as a partner. Tell them you use Ginger's integration of the ePayment API. See Developer documentation for partners.
Ask Ginger to switch it on
Ask your Ginger contact to switch Vipps MobilePay on for your platform: it's off unless you asked for it.
Connect a merchant
Before you start, the merchant has a Vipps MobilePay merchant agreement and a sales unit, with its API keys from the
Vipps MobilePay portal: client ID, client secret, subscription key (Ocp-Apim-Subscription-Key) and merchant serial
number (MSN). The merchant can add your platform as a user of the sales unit, so you download the keys yourself, instead
of sending them to you. See Merchant signup in the
Vipps MobilePay partner docs.
Allow the payment method
Allow vipps-mobilepay in the base permissions of the merchant and in the permissions of the project: / with POST. In the Admin portal, open the project, go to the Payment Method Contracts tab and switch on Vipps MobilePay.
Fill in the contract
Open Vipps MobilePay on the Payment Method Contracts tab and fill in the keys of the merchant's sales unit: the client ID, client secret, subscription key and merchant serial number (MSN). All four are required.
With the Boarding API, set them in the vipps-mobilepay contract of the project. See
Update a project contract in the API reference:
curl https://api.example.com/v1/admin/merchants/$MERCHANT_ID/projects/$PROJECT_ID/contracts/vipps-mobilepay/ \
--user "$API_KEY:" \
--header "Content-Type: application/json" \
--request PUT \
--data '{
"client_id": "<client ID of the sales unit>",
"client_secret": "<client secret of the sales unit>",
"ocp_apim_subscription_key": "<subscription key>",
"merchant_serial_number": "<MSN>",
"currencies": ["NOK", "DKK"]
}'Keep the keys secret
The client secret and the subscription key give access to the merchant's Vipps MobilePay account. Only enter them in the contract, and never share them by email or chat.
Test
A project in test mode (status active-testing) sends Vipps MobilePay payments to the Vipps MobilePay test
environment. Ginger has no shared test account for it: fill in the contract with the keys of a test sales unit, the
merchant's or your own, from the Vipps MobilePay portal.
Live keys on the live project
The test project's contract holds the test keys. Give the live project's contract the merchant's live keys.
-
Install the Vipps or MobilePay test app on your phone and set up a test user, as described in the Vipps MobilePay test environment docs.
-
Create an order with a
vipps-mobilepaytransaction with the API key of the test project:curl https://api.example.com/v1/orders/ \ --user "$API_KEY:" \ --header "Content-Type: application/json" \ --data '{ "currency": "NOK", "amount": 100, "transactions": [{ "payment_method": "vipps-mobilepay" }] }'See Create an order in the payment acceptance docs.
-
Open the
payment_of the transaction. On the Vipps MobilePay page, enter the phone number of your test user and approve the payment in the test app.url -
Retrieve the order: the authorisation is successful. Then test a capture, a void and a refund.
Capture, void and refund
The merchant captures, voids and refunds Vipps MobilePay payments with the standard order API requests:
- Capture the authorised amount, in full or in parts. A capture can't exceed the authorised amount. An authorisation expires after 7 days.
- Void what isn't captured yet. A void can't take an amount: it cancels the whole remaining amount, once.
- Refund a captured amount, in full or in parts. Refunds can't exceed the captured amount.
Next steps
- Payments: the payment methods and processors of your platform.
- Processor contracts: contracts and capture modes.