Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

MobilePay iOS Drop-in

Add MobilePay to an existing iOS Drop-in integration.

Our iOS Drop-in renders MoMo ATM in your payment form, and redirects the shopper to complete the payment. As with other redirect payment methods, you need to handle the redirect result after the shopper returns to your app.

Before you begin

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

Before starting your MobilePay integration:

  1. Make sure that you have set up your back end implementation, and added Drop-in to your payment form.
  2. Add MobilePay in your Customer Area.

Show MobilePay in your payment form

Drop-in uses the countryCode and the amount.currency from your /paymentMethods request to show the available payment methods to your shopper.

To show MobilePay in your payment form:

  1. 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.
  2. When the shopper proceeds to pay, Drop-in invokes the didSubmit method which contains data.paymentMethod.

    Pass the data.paymentMethod 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 data.paymentMethod from the didSubmit event from your client app.
  • returnUrl: The URL where the shopper will be redirected back to after completing the payment. Use the custom URL for your app, for example, my-app://. For more information on setting custom URL schemes, refer to the Apple Developer documentation.
curl https://checkout-test.adyen.com/v64/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":"my-app://"
}'
# 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 => "my-app://",
  :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("my-app://");

    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" => "my-app://",
  "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': 'my-app://',
   '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 = @"my-app://",
  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: "my-app://"
}).then(res => res);

The /payments response contains:

  • action: Object containing information about the redirect.
/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 result

Drop-in uses dropInComponent.handle(action) to redirect the shopper to the MobilePay app.  

  1. To inform Drop-in when the shopper returns to your app, implement the following in your UIApplicationDelegate:
    func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey: Any] = [:]) -> Bool {
       RedirectComponent.applicationDidOpen(from: url)
    
       return true
    }
    After Drop-in completes the action, it invokes the didProvide method.
  2. From your server, make a POST /payments/details request providing the data from the didProvide method from your client app.
    /payments/details request
    {
       "{hint:data.paymentData from didProvide}paymentData{/hint}":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
       "{hint:data.details from didProvide}details{/hint}":{
         "payload":"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.
We recommend that you do a penny test using a live MobilePay account, as this is the fastest way to test your integration. If that is not possible, you can request test credentials for the MobilePay test app.

Penny test (recommended)

  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.
  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 test app

  1. Add the MobilePay payment method in your test Customer Area.
  2. Contact our Support Team to get MobilePay test credentials for the MobilePay test app.
    The test credentials you will receive will only be valid for a limited amount of time.
  3. Download and install the MobilePay test app. Visit the MobilePay website. See the instructions under the header Test app .
  4. Log on to the test app with the test credentials that you received from our Support Team.
  5. Make a test payment.
  6. 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