Payment-method icon

PromptPay Drop-in integration

Add PromptPay to your existing iOS Drop-in integration.

Our iOS Drop-in renders PromptPay in your payment form, and generates a QR code that the shopper uses to pay with their choice of app from PromptPay participating banks.

Before you begin

This page explains how to add PromptPay 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 PromptPay integration:

  1. Make sure that you have set up your back end implementation, and added Drop-in to your payment form.
  2. Contact our Support Team to enable PromptPay.

Show PromptPay 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 PromptPay in your payment form, you need to specify in your /paymentMethods request:

After the shopper selects a payment method and provides payment details, Drop-in invokes the didSubmit method which contains data.paymentMethod. Pass data.paymentMethod to your server and make a payment request.

Make a payment

When the shopper proceeds to pay, Drop-in invokes the didSubmit method which contains data.paymentMethod.

  1. Pass data.paymentMethod to your server.
  2. From your server, make a /payments request, specifying:

    • paymentMethod: The data.paymentMethod from the didSubmit event from your client app.

    Drop-in generates the QR code that the shopper uses to pay.

Show the payment result

Use the resultCode from the /payments/details response to show the payment outcome on your frontend.

You will also receive the outcome of the payment asynchronously in a webhook.

The resultCode values you can receive for PromptPay are:

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