ตรวจสอบยอดคงเหลือ

ใช้เพื่อสอบถามยอดคงเหลือที่ใช้ได้ของแอปพลิเคชันที่ API Key ปัจจุบันเป็นเจ้าของ แอปพลิเคชันที่สอบถามจะถูกกำหนดโดย API Key และไม่จำเป็นต้องส่ง ID ของแอปพลิเคชันในคำขอ

URL คำขอ

GET https://otp.api.engagelab.cc/v1/balance

การตรวจสอบสิทธิ์

โปรดดู การตรวจสอบสิทธิ์ เพื่อเรียนรู้วิธีดำเนินการตรวจสอบสิทธิ์ API

ตัวอย่างคำขอ

ส่วนหัวของคำขอ

              
              GET /v1/balance HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

พารามิเตอร์คำขอ

ไม่มีพารามิเตอร์คำขอ

พารามิเตอร์การตอบกลับ

การตอบกลับสำเร็จ

              
              {
    "currency": "USD",
    "balance": "123.4500",
    "gift_balance": "1.0000",
    "total_balance": "124.4500"
}

            

คำอธิบายฟิลด์

1. จำนวนเงินทั้งหมดเป็นทศนิยมแบบสตริง โดยมีทศนิยม 4 ตำแหน่ง การออกแบบนี้เพื่อหลีกเลี่ยงข้อผิดพลาดด้านความแม่นยำระหว่างการส่งและการแยกวิเคราะห์ตัวเลขทศนิยม โปรดใช้ประเภททศนิยมที่มีความแม่นยำสูง (เช่น BigDecimal / Decimal ในภาษาต่างๆ) สำหรับการแยกวิเคราะห์ และ อย่าคำนวณเป็นตัวเลขทศนิยมโดยตรง
2. สกุลเงิน: ปัจจุบัน ทุกแอปพลิเคชันชำระด้วยดอลลาร์สหรัฐ (USD)
3. ยอดคงเหลืออาจติดลบ: สำหรับแอปพลิเคชันที่เปิดใช้งานโควต้าเบิกเงินเกินบัญชี balance / total_balance อาจส่งคืนค่าติดลบ (เช่น "-12.3400") หลังจากเบิกเงินเกินบัญชี ซึ่งแสดงว่าค้างชำระ โปรดเติมเงินให้ตรงเวลา
4. total_balance จะถูกคำนวณโดยเซิร์ฟเวอร์ในเวลาเดียวกันอย่างสอดคล้องกัน และสามารถใช้โดยตรงสำหรับการแสดงผลและการกระทบยอด

การตอบกลับล้มเหลว

รหัสสถานะ HTTP คือ 4xx หรือ 5xx และเนื้อหาการตอบกลับประกอบด้วยฟิลด์ต่อไปนี้:

              
              {
    "code": 2001,
    "message": "invalid token"
}

            

รหัสข้อผิดพลาด