Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

MobilePay Web Component

Add MobilePay to an existing Web Components integration.

Our MobilePay Component renders MobilePay in your payment form. As with other redirect payment methods, you need to use createFromAction to redirect the shopper, and handle the redirect after the shopper returns to your website.

When paying with MobilePay, the shopper is first redirected to a MobilePay-hosted page to confirm or enter their phone number. Then they receive a push notification on their phone to complete the payment in the MobilePay app on their mobile device.

Before you begin

This page explains how to add MobilePay to your existing Web Components integration. The Web Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your MobilePay integration:

  1. Make sure that you have set up your back end implementation, and created an instance of AdyenCheckout.
  2. Add MobilePay in your Customer Area.

Show MobilePay in your payment form

To present the MobilePay Component in your payment form:

  1. From your server, make a POST /paymentMethods request specifying one of the following combinations:

    Country countryCode amount.currency amount.value
    Denmark DK DKK The value of the payment, in minor units.
    Finland FI EUR The value of the payment, in minor units.

  1. Pass the full response from the /paymentMethods call as the paymentMethodsResponse object when creating an instance of the AdyenCheckout.

  2. Add the MobilePay Component:
    a. Create a DOM element for MobilePay, placing it where you want the form to be rendered:

    <div id="mobilepay-container"></div>

    b. Create and mount an instance of the MobilePay Component using its component name, mobilepay.

    function handleOnSubmit(state, component) {
        // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
        state.isValid // True or false. Specifies if all the information that the shopper provided is valid.
        state.data // Provides the data that you need to pass in the `/payments` call.
        component // Provides the active component instance that called this event.
    }
    const mobilepayComponent =  checkout.create('mobilepay', {
        onSubmit: handleOnSubmit // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
    }).mount('#mobilepay-container');

    When the shopper enters the payment details, the Component calls the onSubmit event.

  3. If state.isValid is true, collect the values passed in state.data, and pass these to your server — these are the shopper details that you need to make the payment.

Make a payment

From your server, make a POST /payments request, specifying:

  • paymentMethod: The state.data.paymentMethod from the onSubmit event from your front end.
  • returnUrl: URL to where the shopper should be taken back to after a redirection. The URL can contain a maximum of 1024 characters and should include the protocol: http:// or https://. You can also include your own additional query parameters, for example, shopper ID or order reference number.
curl https://checkout-test.adyen.com/v52/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "amount":{
    "currency":"DKK",
    "value":1000
  },
  "paymentMethod":{
    "type":"mobilepay"
  },
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy.."
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :amount => {
    :currency => "DKK",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "mobilepay"
  },
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
})
// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
    Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
    Checkout checkout = new Checkout(client);

    PaymentsRequest paymentsRequest = new PaymentsRequest();

    String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
    paymentsRequest.setMerchantAccount(merchantAccount);

    Amount amount = new Amount();
    amount.setCurrency("DKK");
    amount.setValue(1000L);
    paymentsRequest.setAmount(amount);

    DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
    paymentMethodDetails.setType("mobilepay");
    paymentsRequest.setPaymentMethod(paymentMethodDetails);

    paymentsRequest.setReference("YOUR_ORDER_NUMBER");
    paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");

    PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = array(
  "amount" => array(
    "currency" => "DKK",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "mobilepay"
  ),
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
);
$result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   'amount': {
      'value': 1000,
      'currency': 'DKK'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'mobilepay'
   },
   'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
})
// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var amount = new Model.Checkout.Amount("DKK", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "mobilepay"
};
var paymentsRequest = new Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  PaymentMethod = details
};

var paymentResponse = checkout.Payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: { currency: "DKK", value: 1000 },
    paymentMethod: {
        type: 'mobilepay'
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy.."
}).then(res => res);

The /payments response contains:

  • action.method: GET or POST. The HTTP request method that you should use. After the shopper completes the payment, they will be redirected back to your returnURL using the same method.
    The redirect method depends on your payment method configuration and the length of the data included in the request, so make sure that your integration can handle both HTTP GET and HTTP POST methods.

To verify the payment result, you also need the following from the /payments response:

  • action.paymentData: Store this on your server — this is the paymentData value that you send in your /payments/details request.
  • details: Array of parameters that you need to send in your /payments/details request. For example, payload or redirectResult.
    The parameters can vary based on the payment method configuration. Always check the details array for the parameters that you need to send in your next API request.
/payments response
  {
  "resultCode": "RedirectShopper",
   "action": {
     "method": "GET",
     "paymentData": "Ab02b4c0!BQABAgCSZT7t...",
     "paymentMethodType": "mobilepay",
     "type": "redirect",
     "url": "https://test.adyen.com/hpp/redirect.shtml?brandCode=.."
  },
  "details": [
    {
        "key": "payload",
        "type": "text"
    }
  ],
  ...
  }

Handle the redirect

  1. Call createFromAction and pass the action object from the previous step. This will return a new Component that you need to mount:
       checkout.createFromAction(action).mount('#my-container');

    The Component redirects the shopper to the MobilePay-hosted page.

  2. After the shopper is redirected back to your website, check the payment result by making a /payments/details request, specifying:

    • paymentData: Value you received in the /payments response.
    • details: Object that contains the URL-decoded values of the parameters that were returned when the shopper was redirected back to your site. For example, payload. To check the parameters that you should submit, refer to the details array that you received in the /payments response.

    /payments/details request
    {
      "paymentData":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
      "details":{
        "{hint:Verify the parameters from /payments response}payload{/hint}":"Ab02b4c0!BQABAgCW5sxB4e/=="
      }
    }

    You receive a response containing:

    • resultCode: Use this to present the result to your shopper.
    • pspReference: Our unique identifier for the transaction.

    /payments/details response
    {
      "resultCode": "Authorised",
      "pspReference": "88154795347618C"
    }

Present the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.

The 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. For more information, check the refusalReason field. Inform the shopper that there was an error processing their payment.
Refused The payment was refused. For more information, check the refusalReason field. 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 notification 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 once you've completed your payment method integration, you can test the payment flow.

  1. Add the MobilePay payment method in your test Customer Area.
  2. 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.
    Contact our Support Team if you don’t have access to a live MobilePay account that you can use for testing.
  3. Do a penny test: Make a payment for a minimal amount choosing MobilePay as the payment method.
  4. Check the status of the test payment in your Customer Area as described below.

MobilePay payments in your Customer Area

Check the status of MobilePay test payments in your Customer Area > Transactions > Payments.

Finding authorised MobilePay payments

Because the Adyen payments platform stores authorised payments under the card acquirer, authorised MobilePay payments will show up in your Customer Area as Visa, Mastercard, or Dankort payments, with Shopper name: MobilePay Placeholder.

Finding refused MobilePay payments

Refused MobilePay payments are stored by the Adyen payments platform under the MobilePay acquirer.

To find all refused MobilePay payments in the payments list:

  • Filter by Payment method: MobilePay.

Go live

Before you can accept live MobilePay payments, you need to submit a request for MobilePay in your live Customer Area.

See also