Accept MobilePay payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
As with other redirect payment methods, you need to redirect your shopper to MobilePay so they can confirm or enter their phone number. To give your shoppers a better experience, you can also send the shopper's telephone number when making the payment, so they no longer have to provide this later when they're redirected to MobilePay.
Before you begin
These instructions explain how to add MobilePay to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your MobilePay integration:
Build your payment form for MobilePay
Include MobilePay in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.
We provide logos for MobilePay that you can use on your payment form. For more information, refer to Downloading logos.
If you are using a POST /paymentMethods request to show available payment methods to the shopper, specify one of the following combinations:
|The value of the payment, in minor units.|
|The value of the payment, in minor units.|
The response contains
Make a payment
From your server, make a POST /payments request, specifying:
telephoneNumber: Optional If you already have your shopper's phone number, send it in the request so they no longer have to provide this later when they're redirected to MobilePay.
returnUrl: URL to where the shopper should be taken back to after a redirection.
The /payments response contains an
action object with the information needed to redirect the shopper.
Handle the redirect
- To complete the payment, redirect the shopper to the
action.urlreturned in the /payments response.
After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
details: Object that contains the URL-decoded
redirectResultreturned when the shopper was redirected back to your site.
You receive a response containing:
resultCode: Use this to present the result to your shopper.
pspReference: Our unique identifier for the transaction.
Present the payment result
resultCode values you can receive for MobilePay are:
|resultCode||Description||Action to take|
|Authorised||The payment was successful.||Inform the shopper that the payment has been successful, and proceed with the order.
You receive the funds after the payment has been captured.
|Cancelled||The shopper cancelled the payment.||Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.|
|Error||There was an error when the payment was being processed.||Inform the shopper that there was an error processing their payment.|
|Refused||The payment was refused.||Ask the shopper to try the payment again using a different payment method.|
If the shopper failed to return to your website or app, wait for the AUTHORISATION webhook to receive the outcome of the payment:
|eventCode||success field||Description||Action to take|
|AUTHORISATION||false||The transaction failed.||Cancel the order and inform the shopper that the payment failed.|
|AUTHORISATION||true||The shopper successfully completed the payment.||Inform the shopper that the payment has been successful, and proceed with the order.|
Test and go live
Test MobilePay payments
Once you've set up your payment form to show MobilePay and completed your payment method integration, you can test the payment flow.
We recommend that you do a penny test using a live MobilePay account in your live Customer Area, as this is the fastest way to test your integration. If that is not possible, you can use the MobilePay test app.
Live penny test (recommended)
- Make sure you have access to a live MobilePay account that is coupled with a Visa, Mastercard, or Dankort account, and a valid phone number.
- Submit a request for MobilePay in your live Customer Area.
- After MobilePay is added to your Customer Area, make a payment for a minimal amount choosing MobilePay as the payment method.
- Check the status of the test payment in your live Customer Area > Transactions > Payments.
MobilePay test app
The MobilePay test app uses shared login credentials.
If you use the MobilePay test app, consider the following:
- The test phone numbers are shared so all test transaction details will be visible to others. Do not include sensitive data when you make test payments.
- If you're having issues with a test phone number, try a different number or reach out to email@example.com for help with the test app.
- Only use the test app login details provided by MobilePay. For example, if you use the wrong PIN, you could block other test app users.
- You can only use the Mastercard and Visa test cards provided in the test app. You cannot add other test cards. To test other cards, do a live penny test.
Add the MobilePay payment method in your Customer Area.
Download and install the MobilePay test app. Follow the instructions on the MobilePay website under the header Test app.
Log in to the test app using the information provided by MobilePay. You can use one of the following phone numbers:
You can test different payment statuses with codes to test authorization using additional data.
Check the status of MobilePay test payments in your Customer Area > Transactions > Payments.
Before you can accept live MobilePay payments, you need to submit a request for MobilePay in your live Customer Area.