Payment-method icon

PromptPay Component

Add PromptPay to an existing Components integration.

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

Requirements

Select the server-side flow that your integration uses:

Requirement Description
Integration type Make sure that you have built a Sessions flow Web Components integration.
Setup steps Before you begin, contact our Support Team to add PromptPay in your Customer Area.

Import resources for v6

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

Copy code
import { AdyenCheckout, PromptPay } from '@adyen/adyen-web'

API reference

You do not need to send additional fields for PromptPay. To see optional fields that you can send for all payment methods, choose the endpoint you integrated:

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:

Copy code
 <div id="promptpay-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.
Copy code
const promptpay = new PromptPay(checkout).mount('#promptpay-container');

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

Copy code
const promptpayComponent = checkout.create('promptpay').mount('#promptpay-container');

Test and go live

Test PromptPay payments with real payment details and small amounts.

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

To accept live PromptPay payments, you must contact our Support Team to add PromptPay in your live Customer Area.

See also