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

คำขอ

API สอบถามยอดเงินช่วยให้ผู้ค้าสามารถดึงข้อมูลยอดเงินในบัญชีแบบเรียลไทม์สำหรับบัญชี Smilepayz ของตน API นี้ให้ข้อมูลยอดเงินรายละเอียดสำหรับประเภทบัญชีต่างๆ รวมถึงบัญชีรับเงินและบัญชีจ่ายเงิน

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

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

พารามิเตอร์ส่วนหัว

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
Content-Type	M	String	ข้อกำหนดประเภทเนื้อหา HTTP ค่าคงที่: application/json จำเป็นสำหรับการแยกวิเคราะห์คำขอที่เหมาะสม
X-TIMESTAMP	M	String	รูปแบบวันที่เวลา ISO 8601 พร้อมออฟเซ็ตเขตเวลา รูปแบบ: 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

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

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

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

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

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

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

{
  "accountNo": "21320030202403071031",
  "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"], ["AVAILABLE"] ระบุประเภทยอดเงินที่ถูกสอบถาม
accountInfos	M	Object	คอนเทนเนอร์ข้อมูลยอดเงินรายละเอียด มีรายละเอียดยอดเงินที่ครอบคลุมสำหรับบัญชีที่ระบุ ดู โมเดลบัญชียอดเงิน
balanceType	M	String	ประเภทของยอดเงินที่รายงาน รูปแบบ: รหัสประเภทยอดเงินที่กำหนดไว้ล่วงหน้า ตัวอย่าง: BALANCE, AVAILABLE ระบุหมวดหมู่อยอดเงินเฉพาะ
amount	M	Object	ยอดเงินรวมในบัญชี มีข้อมูลสกุลเงินและมูลค่า ดู โมเดลเงิน
currency	M	String	ข้อกำหนดรหัสสกุลเงิน ISO 4217 ค่าคงที่: BRL (Real บราซิล) กำหนดหน่วยสกุลเงินสำหรับจำนวนยอดเงิน
value	M	String	จำนวนยอดเงินเป็นค่าสตริง รูปแบบ: การแสดงสตริงของค่าตัวเลข ตัวอย่าง: "250000" แทน BRL 250000 ใช้สำหรับการแสดงยอดเงินที่แม่นยำ
availableBalance	M	Object	ยอดเงินที่ใช้ได้สำหรับธุรกรรม มีข้อมูลสกุลเงินและมูลค่า อาจแตกต่างจากยอดเงินรวมเนื่องจากการระงับหรือข้อจำกัด ดู โมเดลเงิน
currency	M	String	ข้อกำหนดรหัสสกุลเงิน ISO 4217 ค่าคงที่: BRL (Real บราซิล) กำหนดหน่วยสกุลเงินสำหรับยอดเงินที่ใช้ได้
value	M	String	จำนวนยอดเงินที่ใช้ได้เป็นค่าสตริง รูปแบบ: การแสดงสตริงของค่าตัวเลข ตัวอย่าง: "250000" แทน BRL 250000 ใช้สำหรับการแสดงยอดเงินที่ใช้ได้ที่แม่นยำ
additionalInfo	O	Object	ข้อมูลบัญชีเพิ่มเติมและเมทาดาต้า รูปแบบ: วัตถุ JSON มีรายละเอียดบัญชีเพิ่มเติมเมื่อมี ใช้สำหรับข้อมูลบัญชีที่ขยาย

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

{
  "code": "00",
  "message": "สำเร็จ",
  "accountNo": "21320030202403071031",
  "name": "Sandbox Test",
  "balanceTypes": [
    "BALANCE"
  ],
  "accountInfos": {
    "balanceType": "BALANCE",
    "amount": {
      "currency": "BRL",
      "value": "250000"
    },
    "availableBalance": {
      "currency": "BRL",
      "value": "250000"
    }
  }
}