No momento, esta página não está disponível em português
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.

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 are redirected to MobilePay.

Requirements

Requirement Description
Integration type Make sure that you have built an API-only integration.
Setup steps Before you begin, add MobilePay in your test Customer Area.

Build your payment form for MobilePay

Include MobilePay in the list of available payment methods. You do not 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:

Country/region countryCode amount.currency amount.value
Denmark DK - DKK
- EUR		 The value of the payment, in minor units.
Finland FI - DKK
- 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
  • 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 are redirected to MobilePay.
  • returnUrl: URL to where the shopper should be taken back to after a redirection.
In the  /payments response, note the `action` object. This contains the information needed to redirect the shopper.

<div data-component-wrapper="code-sample">
<code-sample
    :title="'/payments response'"
    :id="''"
    :code-data="[{&quot;language&quot;:&quot;json&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;{\n   \&quot;resultCode\&quot;:\&quot;RedirectShopper\&quot;,\n   \&quot;action\&quot;:{\n      \&quot;paymentMethodType\&quot;:\&quot;mobilepay\&quot;,\n      \&quot;method\&quot;:\&quot;GET\&quot;,\n      \&quot;url\&quot;:\&quot;https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/checkoutPaymentRedirect?redirectData=...\&quot;,\n      \&quot;type\&quot;:\&quot;redirect\&quot;\n   }\n}&quot;}]"
    :enable-copy-link-to-code-block="true"
    :code-sample-card-size="'fullsize'"
></code-sample>

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /payments response, taking into account the following recommendations:

    • When using the HTTP GET method:
      For security reasons, when showing 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.

    • Redirection for mobile integrations:
      For mobile integrations, we strongly recommended that you redirect the shopper to the default browser of their device. Redirecting to the default browser ensures the best compatibility, handling of multi-factor authentication, app-to-app redirection, and error handling.

  2. 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 redirectResult returned when the shopper was redirected back to your site.

  3. In the response note the following:

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

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

MobilePay cannot be tested on the test environment. Use live penny tests (payments for a minimal amount) instead.

  1. Make sure that you have access to a live MobilePay account that is coupled with a Visa, Mastercard, or Dankort account, and a valid phone number.
  2. Submit a request for MobilePay in your live Customer Area.
  3. After MobilePay is added to your Customer Area, make a payment for a minimal amount choosing MobilePay as the payment method.
  4. Check the status of the penny test in your live Customer Area > Transactions > Payments.

Go live

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

See also