---
title: "Prompt Pay"
slug: "prompt-pay"
updated: 2025-02-19T15:44:59Z
published: 2025-02-19T15:44:59Z
canonical: "docs.apcopay.com/prompt-pay"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apcopay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Prompt Pay

PromptPay is Thailand's real-time electronic payment system, launched in 2017 as part of the National e-Payment Master Plan. It allows instant money transfers and payments using mobile numbers, national ID numbers, or corporate tax IDs, simplifying transactions for individuals, businesses, and government entities. With widespread adoption by Thai banks, PromptPay enhances convenience, accessibility, and efficiency, enabling real-time, low-cost transactions and promoting financial inclusion across the country.

## Supported Transaction Types

- [ ] Authorisation
- [ ] Capture
- [x] Purchase
- [ ] Refund
- [ ] Void

## Integrations Supported

**Deposit**

- [x] Hosted Payment Page
- [ ] Direct Connect ( server-to-server)

**Withdrawal**

- [ ] Hosted Payment Page
- [x] Direct Connect ( server-to-server)

## Currencies & Countries Supported

| Title | Description |
| --- | --- |
| **Currencies Supported** | **THB** |
| **Countries Supported** | - **Thailand** - |

## Additional attributes to process Prompt Pay

You must include the following JSON Attributes to the payload. These attributes inform us to proceed with the redirection to PromptPay in order to finalize the payment process.

| Description | Hosted Payment Page |
| --- | --- |
| **Force Transaction Routing** | "Routing":{ "ForcePayment": "PROMPTPAY” } |
| **Client Details** | "Client": { "FirstName": "Joe", "LastName": "Bloggs", "IPAddress": "127.0.0.1" } |
| **Test Indicator** (required in Sandbox Environment only) | "isTest”: true |

Below is a sample request. You can find a more detailed explanation on our APIs in our [API reference documentation](https://apcopay.redoc.ly/).

```json
{
  "TransactionType": "PURC",
  "Amount": "200.00",
  "Currency": "THB",
  "OrderReference": "PROMPTPAY TEST",
  "UniqueReference": "3a9f50f7-2deb-4dbf-a186-d58641s36665",
  "RedirectionURL": "https://www.yourURLhere.com/Redirect/",
  "CallBackURL": "https://www.yourURLhere.com/Listener",
  "FailRedirectionURL": "https://www.yourURLhere.com/Redirect/",
  "Language": "EN",
  "Routing": {
    "ForcePayment": "PROMPTPAY"
  },
  "Client": {
    "FirstName": "Apco",
    "LastName": "Test",
    "ClientAccount": "APCOPAY TEST",
    "Email": "johndoe@mail.com",
    "IPAddress": "127.0.0.1",
    "City": "Valletta"
  },
  "IsTest": true
}
```

### **Testing your integration**

Testing will require intervention from our support team. Please reach out to our [support team](/v1/docs/contacting-apcopay) to assist you in testing your integration.