API สอบถามยอดเงิน

คำขอ

API สอบถามยอดเงินช่วยให้พ่อค้าดึงข้อมูลยอดเงินบัญชีแบบเรียลไทม์สำหรับบัญชี Smilepayz ของพวกเขา

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

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

พารามิเตอร์ 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

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
accountNo	M	String(128)	ตัวระบุบัญชีพ่อค้าสำหรับการสอบถามยอดเงิน รูปแบบ: สตริงตัวอักษรและตัวเลข ความยาวสูงสุด: 128 ตัวอักษร ใช้เพื่อระบุบัญชีเฉพาะสำหรับการดึงยอดเงิน
balanceTypes	M	List(String)	ข้อกำหนดประเภทยอดเงินเพื่อดึง รูปแบบ: อาร์เรย์ของรหัสประเภทยอดเงินที่กำหนดไว้ล่วงหน้า ค่าเริ่มต้น: ["BALANCE"] ตัวอย่าง: BALANCE ใช้เพื่อระบุประเภทยอดเงินที่จะสอบถาม

หมายเหตุสำคัญ

1. สภาพแวดล้อม Sandbox: accountNo ใช้ค่าสตริงที่สร้างแบบสุ่มสำหรับการทดสอบ
2. สภาพแวดล้อม Production: accountNo สามารถดึงได้จากระบบหลังบ้านของพ่อค้า
ดู วิธีรับหมายเลขบัญชี Production
3. บัญชีชำระเงิน: ใช้สำหรับการเก็บเงินจากธุรกรรมการชำระเงินที่เข้ามาทั้งหมด
4. บัญชีถอนเงิน: ใช้สำหรับการประมวลผลธุรกรรมการจ่ายเงินและการถอนเงิน
5. การโอนบัญชี: ยอดเงินสามารถโอนระหว่างประเภทบัญชีต่างๆ ได้
ดู คู่มือการโอนเงินบัญชี

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

Content-type: application/json
X-TIMESTAMP: 2020-12-18T15:06:00+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001

{
  "accountNo": "21120030202403071031",
  "balanceTypes": [
    "BALANCE"
  ]
}

การตอบสนอง

การตอบสนอง HTTP

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

พารามิเตอร์เนื้อหา

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
code	M	String	รหัสสถานะการตอบสนอง API ที่ระบุผลลัพธ์การดำเนินการ รูปแบบ: สตริงสองหลัก สำเร็จ: "00", ข้อผิดพลาด: รหัสอื่นๆ ใช้สำหรับการจัดการการตอบสนองแบบโปรแกรม
message	M	String	คำอธิบายสถานะการตอบสนองที่อ่านได้โดยมนุษย์ รูปแบบ: สตริงที่เข้ารหัส UTF-8 ให้ข้อมูลรายละเอียดเกี่ยวกับผลลัพธ์การดำเนินการ แปลเป็นภาษาตามภาษาของคำขอ
accountNo	O	String	ตัวระบุบัญชาพ่อค้าสำหรับการสอบถามยอดเงิน รูปแบบ: สตริงตัวอักษรและตัวเลข เหมือนกับ accountNo ที่ให้ในคำขอ ใช้สำหรับการระบุตัวตนบัญชีและการยืนยัน
name	O	String	ชื่อเจ้าของบัญชีหรือคำอธิบายบัญชี รูปแบบ: สตริงที่เข้ารหัส UTF-8 ชื่อที่แสดงสำหรับบัญชี ใช้สำหรับการระบุตัวตนบัญชีและวัตถุประสงค์การแสดงผล
balanceTypes	O	Array	ข้อกำหนดประเภทยอดเงินที่ร้องขอ รูปแบบ: อาร์เรย์ของรหัสประเภทยอดเงินที่กำหนดไว้ล่วงหน้า ตัวอย่าง: ["BALANCE"] ระบุประเภทยอดเงินที่สอบถาม
accountInfos	M	Object	ภาชนะข้อมูลยอดเงินรายละเอียด ประกอบด้วยรายละเอียดยอดเงินที่ครอบคลุมสำหรับบัญชีที่ระบุ
balanceType	M	String	ประเภทยอดเงินที่รายงาน รูปแบบ: รหัสประเภทยอดเงินที่กำหนดไว้ล่วงหน้า ตัวอย่าง: BALANCE ระบุหมวดหมู่ยอดเงินเฉพาะ
amount	M	Object	จำนวนยอดเงินบัญชีรวม ประกอบด้วยข้อมูลสกุลเงินและมูลค่า ดู โมเดลเงิน
currency	M	String	ข้อกำหนดรหัสสกุลเงิน ISO 4217 ค่าคงที่: THB (บาทไทย) กำหนดหน่วยสกุลเงินสำหรับจำนวนยอดเงิน
value	M	String	จำนวนยอดเงินเป็นค่าสตริง รูปแบบ: การแสดงค่าตัวเลขเป็นสตริง ตัวอย่าง: "250000" แทน THB 250000 ใช้สำหรับการแสดงยอดเงินที่แม่นยำ
availableBalance	M	Object	ยอดเงินที่ใช้ได้สำหรับธุรกรรม ประกอบด้วยข้อมูลสกุลเงินและมูลค่า อาจแตกต่างจากยอดเงินรวมเนื่องจากข้อจำกัดหรือการระงับ ดู โมเดลเงิน
currency	M	String	ข้อกำหนดรหัสสกุลเงิน ISO 4217 ค่าคงที่: THB (บาทไทย) กำหนดหน่วยสกุลเงินสำหรับยอดเงินที่ใช้ได้
value	M	String	จำนวนยอดเงินที่ใช้ได้เป็นค่าสตริง รูปแบบ: การแสดงค่าตัวเลขเป็นสตริง ตัวอย่าง: "250000" แทน THB 250000 ใช้สำหรับการแสดงยอดเงินที่ใช้ได้ที่แม่นยำ
additionalInfo	O	Object	ข้อมูลบัญชีเพิ่มเติมและเมทาดาต้า รูปแบบ: วัตถุ JSON ประกอบด้วยรายละเอียดบัญชีเพิ่มเติมเมื่อพร้อมใช้งาน ใช้สำหรับข้อมูลบัญชีที่ขยาย

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

{
  "code": "00",
  "message": "Successful",
  "accountNo": "21120030202403071031",
  "name": "Sandbox Test",
  "balanceTypes": [
    "BALANCE"
  ],
  "accountInfos": {
    "balanceType": "BALANCE",
    "amount": {
      "currency": "THB",
      "value": "250000"
    },
    "availableBalance": {
      "currency": "THB",
      "value": "250000"
    }
  }
}