Payment-method icon

PayMe Component

Add PayMe QR to an existing Components integration.

This page explains how to add PayMe to your existing Web Components integration.

Depending on whether your shopper is using a desktop or laptop, or the browser on their mobile device, the Component:

  • Shows the shopper a QR code which they can scan to pay using their PayMe app.
  • Redirects the shopper to the PayMe app on their mobile device.

Implement both flows to make sure that your shoppers can pay on different devices.

PayMe is supported from Web Components version 5.56.0.

Requirements

Select which endpoint you are using:

Import resources for v6

If you are using Web Components v6, import the Component that you need for PayMe:

import { AdyenCheckout, PayMe } from '@adyen/adyen-web'

API reference

Select which endpoint you are using:

See the Web Components integration guide to get the payment outcome and show your shopper the result of the payment.

Component configuration

Step 1: Create a DOM element

Create a DOM element on your checkout page, placing it where you want the payment method form to be rendered:

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

Step 2: Create an instance of the Component

v6.0.0 or later

Create an instance of the Component, passing:

  • Your instance of AdyenCheckout.
const payMe = new PayMe(checkout).mount('#payme-container');

Use the create method of your AdyenCheckout instance, in this case checkout, to create the Component:

const payMeComponent = checkout.create('payme').mount('#payme-container');

Test and go live

Use the PayMe sandbox to test your integration. You do not need to use the PayMe app to test using the sandbox.

Use the amounts specified below to simulate different payment outcomes.

Amount ending in Result Description
30 or 81 Authorised Successful payment.
77 or 90 OfferCancelled The payment request expired after PayMe's default expiry time of ten minutes.
40 or 44 Error There was an error when creating the payment request.