PromptPay iOS Component

Our PromptPay Component renders PromptPay in your payment form and collects your shopper's selected bank.

Requirements

Select which endpoint you are using:

Show PromptPay in your payment form

Include PromptPay in the list of available payment methods.

1. Specify in your /paymentMethods request:

   • countryCode: TH.
   • amount.currency: THB.
   • channel: Specify iOS.

2. Decode the /paymentMethods response with the PaymentMethods structure.

   let paymentMethods = try JSONDecoder().decode(PaymentMethods.self, from: paymentMethodsResponse)

   Find paymentMethods.type promptpay and put it into an object. For example, promptpayPaymentMethod.

3. Create an instance of APIContext with the following parameters:

   Parameter name	Required	Description
   clientKey		Your client key.
   environment		Use test. When you are ready to accept live payments, change the value to one of our live environments.

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

1. Pass the data.paymentMethod to your server.

2. From your server, make a /payments request, specifying:

   • paymentMethod.type: The data.paymentMethod from your client app.

   The response contains the following data:

• resultCode: Pending
• action: Contains the QR code url and qrCodeData.

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

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:

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