Our PromptPay Component renders PromptPay in your payment form and collects your shopper's selected bank.
Before you begin
This page explains how to add PromptPay to your existing iOS Components integration. The iOS Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.
Before starting your PromptPay integration:
- Make sure that you have set up your back end implementation for making API requests.
- Contact our Support Team to enable PromptPay.
Show PromptPay in your payment form
Include PromptPay in the list of available payment methods.
Specify in your /paymentMethods request:
/paymentMethodsresponse with the
let paymentMethods = try JSONDecoder().decode(PaymentMethods.self, from: paymentMethodsResponse)
paymentMethods.typepromptpay and put it into an object. For example,
Create an instance of
APIContextwith the following parameters:
||Your client key.|
||Use test. When you're ready to accept live payments, change the value to one of our live environments.|
- Initialize the PromptPay Component:
let promptpayComponent = PromptPayComponent(paymentMethod: promptpayPaymentMethod, apiContext: apiContext) promptpayComponent.delegate = self // In this example, the Pay button will show 10 <strong>THB</strong>. // The value is in minor units. Change the currencyCode to the currency for the PromptPay Component. promptpayComponent.payment = Payment(amount: Amount(value: 1000, currencyCode: "<strong>THB</strong>")) present(promptpayComponent.viewController, animated: true)
Make a payment
When the shopper proceeds to pay, the Component invokes the
didSubmit method containing the
data.paymentMethod from the
- Pass the
data.paymentMethodto your server.
From your server, make a /payments request, specifying:
data.paymentMethodfrom your client app.
The response contains the following data:
action: Contains the QR code
Show the QR code
Use the information in the
action object of the /payments response to render the QR code.
action.url: Use this URL to download the QR code.
action.qrCodeData: Use this to render the QR code on your checkout page.
The shopper can either scan the QR code, or take a screenshot of the QR code and upload it to their bank app.
Show the payment result
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.
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.