API INQUIRY BALANCE

API สอบถามยอดเงิน ภูมิภาค USDT (USDT).

Request

API สอบถามยอดเงินคงเหลือ (Balance Inquiry) ช่วยให้ร้านค้าสามารถตรวจสอบยอดเงินคงเหลือของบัญชี Smilepayz ได้แบบเรียลไทม์ โดยจะแสดงข้อมูลยอดคงเหลือแยกตามประเภทบัญชี เช่น บัญชีรับเงิน (Pay-In) และบัญชีจ่ายเงิน (Pay-Out)

เส้นทางคำขอ (Request Path):

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

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

Field	Required	Type	Description
Content-Type	M	String	application/json request body.
X-TIMESTAMP	M	String	Datetime with zone offset, format yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATURE	M	String	Signature of JSON body (see product Signature doc).
X-PARTNER-ID	M	String	Your merchantID

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

Field	Required	Type	Description
accountNo	M	String(128)	Settlement accountNo if gateway returns it.
balanceTypes	M	List(String)	รายการประเภทยอดคงเหลือที่ต้องการสอบถาม รูปแบบ: อาร์เรย์ของรหัสประเภทยอดคงเหลือที่ระบบกำหนดไว้ล่วงหน้า ค่าเริ่มต้น: ["BALANCE"] ตัวอย่าง: BALANCE ใช้ระบุว่าต้องการสอบถามยอดคงเหลือประเภทใดบ้าง

ข้อควรทราบที่สำคัญ

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

ตัวอย่าง Body – คำขอสอบถามยอดคงเหลือ (Balance Inquiry Request):

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

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

Response

HTTP Response

Field	Required	Type	Description
Content-Type	M	String	application/json request body.
X-TIMESTAMP	M	String	Datetime with zone offset, format yyyy-MM-ddTHH:mm:ss±HH:mm

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

Field	Required	Type	Description
code	M	String	00 success, other values error.
message	M	String	UTF-8 human-readable result line.
accountNo	O	String	Settlement accountNo if gateway returns it.
name	O	String	Beneficiary full name (UTF-8).
balanceTypes	O	Array	รายการประเภทยอดคงเหลือที่ร้องขอ รูปแบบ: อาร์เรย์ของรหัสประเภทยอดคงเหลือที่กำหนดไว้ล่วงหน้า ตัวอย่าง: ["BALANCE"] ใช้ระบุว่าระบบตอบข้อมูลของยอดคงเหลือประเภทใดบ้าง
accountInfos	M	Object	ข้อมูลรายละเอียดของยอดคงเหลือในบัญชีที่สอบถาม ประกอบด้วยยอดคงเหลือรวมและยอดคงเหลือที่สามารถใช้ทำธุรกรรมได้
balanceType	M	String	ประเภทของยอดคงเหลือที่รายงาน รูปแบบ: รหัสประเภทยอดคงเหลือที่กำหนดไว้ล่วงหน้า ตัวอย่าง: BALANCE ใช้ระบุหมวดหมู่ของยอดคงเหลือที่แสดง
amount	M	Object	Amount
currency	M	String	Fixed to USDT.
value	M	String	มูลค่ายอดคงเหลือรวมในรูปแบบสตริงตัวเลข ตัวอย่าง: "250000" หมายถึง 250000 USDT ใช้แสดงค่าตัวเลขอย่างแม่นยำ
availableBalance	M	Object	ยอดคงเหลือที่สามารถใช้ทำธุรกรรมได้ในขณะนั้น ภายในประกอบด้วยข้อมูลสกุลเงินและมูลค่า อาจแตกต่างจากยอดรวมเนื่องจากยอดที่ถูกกันไว้หรือมีเงื่อนไขจำกัดการใช้
currency	M	String	Fixed to USDT.
value	M	String	มูลค่ายอดคงเหลือที่สามารถใช้ได้ในรูปแบบสตริงตัวเลข ตัวอย่าง: "250000" หมายถึง 250000 USDT ใช้แสดงค่าตัวเลขอย่างแม่นยำ

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": "USDT",
               "value": "250000"
          },
          "availableBalance": {
               "currency": "USDT",
               "value": "250000"
          }
     }
}