Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

MobilePay for API only

Add MobilePay to an existing API-only integration.

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.

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:

  1. Make sure that you have set up your back end implementation.
  2. Add MobilePay in your Customer Area.

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 which 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:

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.

The response contains paymentMethod.type: mobilepay.

Make a payment

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

  • paymentMethod: mobilepay
  • returnUrl: URL to where the shopper should be taken back to after a redirection.
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":"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.url: Link to where you should redirect your shopper.
  • 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 in the next step, you also need the following from the /payments response:

  • action.paymentData: 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/skipDetails.shtml?brandCode"
   },
   "details":[
      {
         "key":"payload",
         "type":"text"
      }
   ],
   ...
}

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /payments response.
    When using the HTTP GET method:
    For security reasons, when displaying the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.
  2. After the shopper is redirected back to your website or app, 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 website or app. 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.
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