PromptPay

PromptPay is a network of the National Bank of Thailand, which supports Thai users to use mainstream bank accounts to transfer payments.

Properties

The properties of the PromptPay payment method are shown in the following table:

User experience

Note: The following payment flows on different terminals are reference only, and represent this payment method's flow on different terminal types. For supported merchants' terminal types, consult Antom Technical Support.

The following graphics show the user experience for the App terminal.

1. The user selects PromptPay to pay.
2. The user obtains the payment code.
3. The user manually opens a bank app.
4. The user taps Scan on the bank page.
5. The user is redirected to the merchant result page.

Integration considerations

The following section outlines integration considerations for various payment types, detailing customized integration solutions and payment method features.

About normalUrl

• When accepting payments from PromptPay, you can choose whether to use normalUrl:

• If choosing not to use normalUrl, you can directly render the codeValue in the API response on the merchant page to display the QR code or payment code, reducing page redirections and improving the payment experience.
• If choosing to use normalUrl, redirect your buyer to the address specified by normalUrl and proceed the payment process as indicated in User experience.

• For Web, WAP, and App terminals, normalUrl is returned in the response of the pay API. The buyer is redirected to the address specified by normalUrl and uses the payment code displayed on the page to proceed with the payment. The buyer completes the payment by scanning the code on the mobile phone, and the middle page automatically redirects to the merchant result page.
• Different terminal types have specific integration features when returning normalUrl.

• WAP: The returned normalUrl is the payment code and payment operation display page. The buyer takes a screenshot of the QR code first, and manually opens the specific payment method app to identify and pay.
• App: The returned normalUrl does not trigger the payment method app. It is recommended to render the URL page directly within the merchant app and provide payment operation steps to guide the buyer to complete the payment.

After payments

• After the buyer completes the payment in the bank app, the banking app will not automatically redirect to the merchant's results page. The buyer needs to manually navigate to the transaction initiation app (the merchant app or browser).
• This payment method does not support refunds. It is recommended to communicate directly with the buyer offline.
• Obtain the payment result from the payment result notification (notifyPayment) or by making inquiries (inquiryPayment). Handle the redirection and display of the payment result page to avoid duplicate payments.

Default timeout

• Add the expireTime parameter in the API response to display the timeout time. When displaying the payment code, enable the copy function for the payment code and allow the buyer to conveniently paste the payment code into the payment method app.
• This payment method may result in a situation where the merchant closes the order while the buyer is still able to complete the payment, leading to potential payment discrepancies.

Response sample

The following is a code example in the payment response:

{
    "normalUrl": "https://iexpfront-sea-global.alipay.com/payments/method/checkout/code.html?merchantId=188iwOYLsWM%2B3OM5i43oAN6sL7yTti1YlTOEpSbxNsmiew%3D&paymentRequestId=jNWtKr1NuNslNZI9bMSfKlezbo6TU5Z8Vc4r0js%2BJqk%3D&clientId=5Y607N2YJU8006726",
    "orderCodeForm": {
        "codeDetails": [
            {
                "codeValue": "https://iexpfront-sea.alipay.com/showQrImage.htm?code=eZhzE9rX8OM9t%252Fce8MFMfc0Dx0u3wBVn3oCmdfp9qqrzkmP37J40Gk5IIIFnjCZP7P7w4G3%252BmQVNKCjO%252B6j1F4UewQGtMv5Nq4pKsB4re6jQ6vZzUsqePuN5zzVMF32CJpI5a0CbtXinyDmKB5Eij4p%252FiV7a2pOHaJcApShfBb86Sni27fd%252FsWj%252FvtEpLV5pNqIJrr6kX9mFmR3KMLTnpoE8zlt04rcpE2nF8iObXx%252FGmneNcwctjLwNw46pJSBbn%252FPP9v5OfXs9kzzpO967gijOE8PalKQKBSq4M16fsjc%253D&size=M&sid=188",
                "displayType": "MIDDLEIMAGE"
            }
        ],
        "expireTime": "2024-03-13T23:08:10-07:00"
    },
    "paymentActionForm": "{\"paymentActionFormType\":\"PaymentCodeForm\",\"paymentCodeExpireTime\":1710396490000,\"paymentCodeInfos\":[{\"paymentCodeDetails\":[{\"codeValue\":\"00020101021230650016A00000067701011201150105552061356500209111175911030924461022052047399530376454043.005802TH5925EMVQR - AliPay Singapore 6007Bangkok62550109111175911050911117591107011082020240314909804823525630474C3\",\"codeValueType\":\"QRCODE\",\"displayType\":\"IMAGE\"}],\"paymentCodeInfoType\":\"PAYMENT_CODE\"}]}",
    "paymentAmount": {
        "currency": "THB",
        "value": "300"
    },
    "paymentCreateTime": "2024-03-13T22:54:10-07:00",
    "paymentId": "20240314194010800100188980210741856",
    "paymentRequestId": "PAY_20240314135409345",
    "redirectActionForm": {
        "method": "GET",
        "redirectUrl": "https://iexpfront-sea-global.alipay.com/payments/method/checkout/code.html?merchantId=188iwOYLsWM%2B3OM5i43oAN6sL7yTti1YlTOEpSbxNsmiew%3D&paymentRequestId=jNWtKr1NuNslNZI9bMSfKlezbo6TU5Z8Vc4r0js%2BJqk%3D&clientId=5Y607N2YJU8006726"
    },
    "result": {
        "resultCode": "PAYMENT_IN_PROCESS",
        "resultMessage": "payment in process",
        "resultStatus": "U"
    }
}