API สอบถามสถานะ

คำขอ

API สอบถามสถานะธุรกรรมช่วยให้พ่อค้าดึงข้อมูลสถานะธุรกรรมแบบเรียลไทม์

เส้นทางคำขอ:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/inquiry-status
production: https://gateway.smilepayz.com/v2.0/inquiry-status

พารามิเตอร์ Header

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
Content-Type	M	String	ข้อกำหนดประเภทเนื้อหา HTTP ค่าคงที่: application/json จำเป็นสำหรับการแยกวิเคราะห์คำขอที่เหมาะสม
X-TIMESTAMP	M	String	รูปแบบวันที่เวลา ISO 8601 พร้อม offset เขตเวลา รูปแบบ: yyyy-MM-ddTHH:mm:ss±HH:mm ตัวอย่าง: 2020-12-17T10:55:00+07:00 หมายเหตุ: ต้องเป็นเวลาเซิร์ฟเวอร์ปัจจุบันภายใน ±5 นาที
X-SIGNATURE	M	String	ลายเซ็นดิจิทัลสำหรับการยืนยันตัวตนคำขอ ดู การสร้างลายเซ็น
X-PARTNER-ID	M	String	ตัวระบุพ่อค้าเฉพาะที่ได้รับมอบหมายจากแพลตฟอร์ม รูปแบบ: สตริงตัวอักษรและตัวเลข ใช้สำหรับการยืนยันตัวตนพ่อค้าและการเส้นทางธุรกรรม กรุณาใส่ merchantID

พารามิเตอร์ Body

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
tradeType	M	Number	ข้อกำหนดประเภทธุรกรรม รูปแบบ: ค่าจำนวนเต็ม ค่า: 1 (ชำระเงิน), 2 (ถอนเงิน) ใช้เพื่อระบุหมวดหมู่ธุรกรรมสำหรับการสอบถามสถานะ
orderNo	C	String(32)	ตัวระบุธุรกรรมของพ่อค้า รูปแบบ: สตริงตัวอักษรและตัวเลข ความยาวสูงสุด: 32 ตัวอักษร ใช้เมื่อสอบถามโดยอ้างอิงธุรกรรมของพ่อค้า
tradeNo	C	String(32)	ตัวระบุธุรกรรมภายใน รูปแบบ: สตริงตัวอักษรและตัวเลข ความยาวสูงสุด: 32 ตัวอักษร ใช้เมื่อสอบถามโดยอ้างอิงธุรกรรมของระบบ

ข้อกำหนดสำคัญ

ต้องมีตัวระบุธุรกรรม: ต้องให้ tradeNo หรือ orderNo อย่างน้อยหนึ่งตัวสำหรับการสอบถามสถานะธุรกรรม

ตัวอย่าง Body – คำขอสอบถามสถานะ:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001

{
    "tradeType": 1,
    "orderNo": "2000112900000000000001"
}

{
    "tradeType": 2,
    "tradeNo": "112200312406111311517153"
}

การตอบสนอง

การตอบสนอง HTTP

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
Content-Type	M	String	ข้อกำหนดประเภทเนื้อหาการตอบสนอง HTTP ค่าคงที่: application/json ระบุรูปแบบการตอบสนอง JSON
X-TIMESTAMP	M	String	รูปแบบวันที่เวลา ISO 8601 พร้อม offset เขตเวลา รูปแบบ: yyyy-MM-ddTHH:mm:ss±HH:mm ตัวอย่าง: 2020-12-17T10:55:00+07:00

พารามิเตอร์ Body

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
code	M	String	รหัสสถานะการตอบสนอง API ที่ระบุผลการดำเนินการ รูปแบบ: สตริงสองหลัก สำเร็จ: "00", ข้อผิดพลาด: รหัสอื่นๆ ใช้สำหรับการจัดการการตอบสนองแบบโปรแกรม
message	M	String	คำอธิบายสถานะการตอบสนองที่อ่านได้ รูปแบบ: สตริงที่เข้ารหัส UTF-8 ให้ข้อมูลรายละเอียดเกี่ยวกับผลการดำเนินการ แปลเป็นภาษาตามภาษาของคำขอ
tradeNo	O	String	หมายเลขอ้างอิงธุรกรรมภายในสำหรับการติดตามระบบ รูปแบบ: สตริงตัวอักษรและตัวเลขที่สร้างโดยระบบ ใช้สำหรับการจัดการธุรกรรมภายในและการสนับสนุน
tradeType	O	Number	ข้อกำหนดประเภทธุรกรรม รูปแบบ: ค่าจำนวนเต็ม ค่า: 1 (ชำระเงิน), 2 (ถอนเงิน) ระบุหมวดหมู่ธุรกรรมที่ถูกสอบถาม
paymentMethod	O	String	วิธีการชำระเงินที่ใช้สำหรับการประมวลผลธุรกรรม รูปแบบ: รหัสวิธีการชำระเงินที่กำหนดไว้ล่วงหน้า ตัวอย่าง: KBANK, BBL, SCB, QRPAY ระบุช่องทางการชำระเงินที่ใช้จริง ดู รายการวิธีการชำระเงิน
money	O	Object	รายละเอียดจำนวนธุรกรรมพร้อมข้อกำหนดสกุลเงิน ประกอบด้วยจำนวนธุรกรรมที่ยืนยันและสกุลเงิน ดู โมเดลเงิน
currency	M	String	ข้อกำหนดรหัสสกุลเงิน ISO 4217 ค่าคงที่: THB (บาทไทย) กำหนดกฎการประมวลผลการชำระเงินและสกุลเงินการชำระบัญชี
amount	M	Number	จำนวนธุรกรรมในหน่วยสกุลเงินที่เล็กที่สุด รูปแบบ: ค่าจำนวนเต็ม ตัวอย่าง: 20000 แทน THB 20000 ช่วง: 100-999999999
status	O	String	สถานะการประมวลผลธุรกรรมปัจจุบัน รูปแบบ: รหัสสถานะที่กำหนดไว้ล่วงหน้า ตัวอย่าง: PROCESSING, SUCCESS, FAILED, CANCELLED ระบุสถานะปัจจุบันของธุรกรรม ดู โมเดลสถานะ
remark	O	String	ข้อมูลธุรกรรมเพิ่มเติมหรือหมายเหตุ รูปแบบ: สตริงที่เข้ารหัส UTF-8 ประกอบด้วยรายละเอียดเพิ่มเติมเกี่ยวกับสถานะธุรกรรม

Content-type: application/json 
X-TIMESTAMP: 2020-12-17T10:55:00+07:00

{
    "code": "00",
    "message": "Successful",
    "money": {
        "amount": 20000,
        "currency": "THB"
    },
    "paymentMethod": "KBANK",
    "status": "SUCCESS",
    "tradeNo": "122200312406111311517153",
    "tradeType": 2
}