📖 API Documentation

คู่มือการใช้งาน API ของ Paynoi

Base URL: https://paynoi.com/ppay_api
Content-Type: application/json
Authentication: ใช้ api_key จากตาราง users

สำคัญ! ก่อนใช้งาน

เปิดการแจ้งเตือน SMS Banking เงินเข้า มาที่เบอร์ 0956511824

Create Transaction

สร้างธุรกรรมพร้อมเพย์และ QR Code โดยรับ amount เป็นจำนวนเต็ม (หน่วยบาท) และ API จะสุ่มทศนิยม 2 ตำแหน่ง (เช่น 100 บาทอาจกลายเป็น 100.24 บาท) ** สุ่มเริ่มตั้งแต่ .00-.99

Request POST

Endpoint: /ppay_api

JSON Request

{
    "method": "create",
    "api_key": "your_test_api_key",
    "amount": 100,
    "ref1": "testpay",
    "key_id": "100568",
    "account": "1234567890",
    "type": "1"
}

method คงที่เป็น "create"
api_key API key จากตาราง users
amount จำนวนเต็ม (หน่วยบาท เช่น 100)
ref1 อ้างอิงธุรกรรม (เช่น รหัสคำสั่งซื้อ)
key_id รหัส 6 หลักจาก user_settings (เช่น 100568 สำหรับกสิกร, 100569 สำหรับกรุงศรี, 100570 สำหรับไทยพาณิชย์)
account เลขที่พร้อมเพย์ (เบอร์มือถือ หรือ เลขบัตรประชาชน)
type ประเภทบัญชี (1: เบอร์มือถือ หรือ 2: เลขบัตรประชาชน)

Response

Success (สมมติสุ่มทศนิยมได้ 0.24):

JSON Response

{
    "status": 1,
    "trans_id": "PPAY_123456789",
    "qr_image_base64": "base64_string",
    "amount_check": 10024,
    "amount": "100.24",
    "account": "1234567890", 
    "type": "1",
    "expire_at": "2025-04-28T12:15:00+07:00"
}

status 1 (สำเร็จ)
trans_id รหัสธุรกรรมที่สร้าง
qr_image_base64 รูป QR Code ในรูปแบบ Base64
amount_check ยอดรวม (สตางค์ เช่น 10024)
amount ยอดรวมที่มีทศนิยม (บาท เช่น 100.24)
expire_at เวลาหมดอายุ (ISO 8601)

Error:

JSON Error Response

{
    "status": 0,
    "msg": "จำนวนเงิน, ref1, หรือ key_id ไม่ถูกต้อง"
}

Cancel Transaction

ยกเลิกธุรกรรมที่อยู่ในสถานะ pending หรือหมดอายุ (เกิน 15 นาทีจาก created_at)

Request POST

Endpoint: /ppay_api

JSON Request

{
    "method": "cancel",
    "api_key": "your_test_api_key",
    "trans_id": "PPAY_123456789"
}

method คงที่เป็น "cancel"
api_key API key จากตาราง users
trans_id รหัสธุรกรรมจากคำขอ create

Response

Success:

JSON Response

{
    "status": 1
}

Error:

JSON Error Response

{
    "status": 0,
    "msg": "ธุรกรรมยังไม่หมดอายุและอยู่ในสถานะที่ไม่สามารถยกเลิกได้"
}

Check Transaction Status

ตรวจสอบสถานะและรายละเอียดของธุรกรรม

Request POST

Endpoint: /ppay_api

JSON Request

{
    "method": "check",
    "api_key": "your_test_api_key",
    "trans_id": "PPAY_123456789"
}

method คงที่เป็น "check"
api_key API key จากตาราง users
trans_id รหัสธุรกรรมจากคำขอ create

Response

Success:

JSON Response

{
    "status": 1,
    "trans_id": "PPAY_123456789",
    "amount_check": 10024,
    "amount": "100.24",
    "ref1": "testpay",
    "payment_status": "pending",
    "created_at": "2025-04-28 12:00:00",
    "expire_at": "2025-04-28T12:15:00+07:00",
    "type": "1",
    "key_id": "100568"
}

status 1 (สำเร็จ)
trans_id รหัสธุรกรรม
amount_check ยอดรวม (สตางค์ เช่น 10024)
amount ยอดรวมที่มีทศนิยม (บาท เช่น 100.24)
ref1 อ้างอิงธุรกรรม
payment_status สถานะการชำระเงิน (เช่น pending, completed, failed)
created_at เวลาสร้าง
expire_at เวลาหมดอายุ (ISO 8601)
type ชนิดพร้อมเพย์ (1 = เบอร์โทร, 2 = เลขบัตรประชาชน)
key_id รหัส 6 หลัก (เช่น 100568)

Error:

JSON Error Response

{
    "status": 0,
    "msg": "ไม่พบธุรกรรม"
}

Webhook Notification

เมื่อมีการชำระเงินสำเร็จ API จะส่ง webhook ไปยัง webhook_url ที่กำหนดใน user_settings

Webhook Payload

JSON Webhook Payload

{
    "data": {
        "trans_id": "PPAY_123456789",
        "ref1": "testpay",
        "amount_check": 10024,
        "amount": "100.24",
        "transaction_date: "2025-04-28",
		"transaction_time: "12:00:00",
        "status": "1",
        "payment_status": "completed"
    },
    "signature": "hmac_signature"
}

data ข้อมูลการชำระเงิน
signature ลายเซ็น HMAC-SHA256 (ใช้ api_key จาก users)

Expected Response

Webhook endpoint ต้องตอบกลับ:

JSON Response

{
    "status": 1
}

PHP Example Code

ตัวอย่างโค้ด PHP สำหรับเรียก API โดยใช้ cURL

PHP Code

<?php

function callPromptPayApi($method, $data) {
    $url = 'https://paynoi.com/ppay_api';
    $payload = json_encode($data);

    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
    curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $response = curl_exec($ch);
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);

    return [
        'http_code' => $httpCode,
        'response' => json_decode($response, true)
    ];
}

// ตัวอย่าง: Create Transaction
$createData = [
    'method' => 'create',
    'api_key' => 'your_test_api_key',
    'amount' => 100,
    'ref1' => 'testpay',
    'key_id' => '100568',
    'account' => '1234567890',
    'type' => '1'
];
$result = callPromptPayApi('create', $createData);
echo "Create Response: " . print_r($result, true) . "\n";

// ตัวอย่าง: Cancel Transaction
$cancelData = [
    'method' => 'cancel',
    'api_key' => 'your_test_api_key',
    'trans_id' => 'PPAY_123456789'
];
$result = callPromptPayApi('cancel', $cancelData);
echo "Cancel Response: " . print_r($result, true) . "\n";

// ตัวอย่าง: Check Transaction
$checkData = [
    'method' => 'check',
    'api_key' => 'your_test_api_key',
    'trans_id' => 'PPAY_123456789'
];
$result = callPromptPayApi('check', $checkData);
echo "Check Response: " . print_r($result, true) . "\n";

?>

หมายเหตุ

ข้อควรทราบ

Amount: ส่งเป็นจำนวนเต็ม (บาท เช่น 100) API จะสุ่มทศนิยม 2 ตำแหน่ง (เช่น 0.24) ทำให้ได้ยอดรวมเช่น 100.24 บาท
Key ID: ใช้ 100568 (กสิกร) หรือ 100569 (กรุงศรี) หรือ 100570 (ไทยพาณิชย์) จาก user_settings
Security: ใช้ HTTPS และเก็บ api_key อย่างปลอดภัย
Logs: การดำเนินการบันทึกใน logs/app.log

สำหรับการตั้งค่า user_settings หรือการเชื่อมต่อธนาคาร กรุณาติดต่อทีมพัฒนา

เกี่ยวกับ LINE Connect API

API ของเราอนุญาตให้ผู้ใช้ดึงข้อมูลธุรกรรมและจัดการ LINE โดยใช้ api_key & record_key ที่ได้รับจากบัญชีของคุณ ทดสอบ API ได้โดยใช้ Postman หรือเครื่องมืออื่นๆ

เราแนะนำให้สร้างการตรวจสอบด้วยรูปแบบ จำนวนเงินสุ่มทศนิยม 2 ตำแหน่ง (เช่น 100 บาทอาจกลายเป็น 100.24 บาท) ** สุ่มเริ่มตั้งแต่ .00-.99 เพื่อให้ตรงการทำธุรกรรมของแต่ละรายการนั้นๆ เพื่อง่ายต่อการตรวจสอบ และมีเวลาจำกัดต่อรายการนั้นๆเพื่อความแม่นยำมากขึ้น

GET ดึงข้อมูลธุรกรรม HAR

API นี้ใช้สำหรับดึงข้อมูลธุรกรรมจากไฟล์ HAR ที่ผู้ใช้อัปโหลดผ่านหน้า อัปโหลด HAR

URL: https://paynoi.com/api_line
Method: GET
Parameters:
api_key (required)
record_key (required)
Response: JSON ประกอบด้วย status และ data (array ของธุรกรรม)

ตัวอย่างโค้ด

ตัวอย่างการเรียก API ด้วยภาษาโปรแกรมต่างๆ

PHP

$api_key = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
$record_key = "12345";
$api_url = "https://paynoi.com/api_line?api_key=" . urlencode($api_key) . "&record_key=" . urlencode($record_key);

$ch = curl_init($api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($response === false || $http_code != 200) {
    echo "Error: Failed to fetch data (HTTP $http_code)";
} else {
    $data = json_decode($response, true);
    if ($data['status'] === 'success') {
        foreach ($data['data'] as $transaction_group) {
            foreach ($transaction_group as $transaction) {
                echo "บัญชี: " . $transaction['bankaccount'] . "";
                echo "จำนวน: " . $transaction['amount'] . " " . $transaction['currency'] . "";
                echo "วันที่: " . $transaction['date'] . "";
                echo "ยอดคงเหลือ: " . $transaction['balance'] . "";
                echo "ประเภท: " . $transaction['type'] . "";
            }
        }
    } else {
        echo "Error: " . $data['status'];
    }
}

JavaScript

const apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
const record_key = "12345";
const apiUrl = `https://paynoi.com/api_line?api_key=${encodeURIComponent(apiKey)}&record_key=${encodeURIComponent(record_key)}`;

fetch(apiUrl)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error: ${response.status}`);
        }
        return response.json();
    })
    .then(data => {
        if (data.status === "success") {
            data.data.forEach(group => {
                group.forEach(transaction => {
                    console.log(`บัญชี: ${transaction.bankaccount}`);
                    console.log(`จำนวน: ${transaction.amount} ${transaction.currency}`);
                    console.log(`วันที่: ${transaction.date}`);
                    console.log(`ยอดคงเหลือ: ${transaction.balance}`);
                    console.log(`ประเภท: ${transaction.type}`);
                });
            });
        } else {
            console.error("Error:", data.status);
        }
    })
    .catch(error => {
        console.error("Fetch error:", error);
    });

Postman

{
  "method": "GET",
  "url": "https://paynoi.com/api_line?api_key=xxxxxxxxxxxxxxxxxxxxxxxxxxx&record_key=xxxxx",
  "headers": {
    "Accept": "application/json"
  },
  "body": null
}

ตัวอย่างการตอบกลับ

ตัวอย่าง JSON ที่ API ส่งคืนเมื่อเรียกสำเร็จ

{
  "status": "success",
  "data": [
    [
      {
        "bankaccount": "xxx-x-x8685-x",
        "amount": "1.00",
        "currency": "บาท",
        "date": "2025-04-25 23:44:00",
        "balance": "239.50",
        "type": "เงินเข้า"
      }
    ],
    [
      {
        "bankaccount": "xxx-x-x8685-x",
        "amount": "800.00",
        "currency": "บาท",
        "date": "2025-04-24 22:06:00",
        "balance": "895.50",
        "type": "เงินเข้า"
      }
    ]
  ]
}

ตารางข้อมูลธุรกรรม

บัญชี	จำนวน	สกุลเงิน	วันที่	ยอดคงเหลือ	ประเภท
xxx-x-x8685-x	1.00	บาท	2025-04-25 23:44:00	239.50	เงินเข้า
xxx-x-x8685-x	30.00	บาท	2025-04-25 16:30:00	240.50	เงินเข้า

1. Gen QR Code Scan

<img src="https://promptpay.io/เบอร์พร้อมเพย์ หรือ เลขประจำตัวประชาชน/จำนวนเงิน.เศษสตางค์.png">

ข้อดีของการใช้พร้อมเพย์ QR CODE ในการรับเงิน คือ สามารถล็อคจำนวนเงินที่ให้ลูกค้าชำระได้ ทำให้ง่ายและสะดวกในการตรวจสอบรายการโอนเงินเพื่อยืนยันตนในการชำระเงินของลูกค้าในยอดจำนวนเงินนั้นๆได้

2. รับเงินผ่านบัญชีธนาคาร

ใช้เลขบัญชีธนาคารปกติในการรับเงินโอนจากลูกค้าของคุณได้เลย
เนื่องจาก API สามารถดึงรายการเงินเข้าผ่าน Line Connect ได้ปกติ