สอบถามยอดคงเหลือ (อียิปต์)

API สอบถามยอดเงิน ภูมิภาค อียิปต์ (EGP).

คำขอ

POST/v2.0/inquiry-balance

URL คำขอ:

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

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

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
Content-Type	M	String	Body JSON application/json
X-TIMESTAMP	M	String	รูปแบบ: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATURE	M	String	ลายเซ็นของ body JSON (ดูเอกสาร การสร้างลายเซ็น)
X-PARTNER-ID	M	String	merchantID ของคุณ (ตัวอักษรและตัวเลข)

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

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
accountNo	M	String(128)	accountNo สำหรับ settlement เมื่อ gateway ส่งกลับมา
balanceTypes	M	List(String)	เช่น ["BALANCE"]; ประเภทยอดเงินที่ต้องการให้ส่งกลับ

หมายเหตุ

Sandbox: accountNo เป็นค่าทดสอบที่ระบบสร้าง
Production: รับจาก merchant backend; ดู วิธีดูหมายเลขบัญชี production

---

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

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

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

การตอบกลับ

Header HTTP

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
Content-Type	M	String	Body JSON application/json
X-TIMESTAMP	M	String	รูปแบบ: yyyy-MM-ddTHH:mm:ss±HH:mm

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

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
code	M	String	00 หมายถึงสำเร็จ ค่าอื่นหมายถึงล้มเหลว
message	M	String	ข้อความผลลัพธ์แบบ UTF-8 ที่อ่านได้
accountInfos	M	Object	มี balanceType, amount และ availableBalance
balanceType	M	String	เช่น BALANCE
amount	M	Object	ออบเจ็กต์ยอดเงินคงเหลือ
currency	M	String	รหัสสกุลเงินสำหรับคำขอนี้
value	M	String	ค่ายอดเงินในรูปแบบ string
availableBalance	M	Object	ยอดเงินที่ใช้ได้ โครงสร้างเดียวกับ amount
currency	M	String	รหัสสกุลเงินสำหรับคำขอนี้
value	M	String	ยอดเงินที่ใช้ได้ในรูปแบบ string
accountNo	O	String	accountNo สำหรับ settlement เมื่อ gateway ส่งกลับมา
name	O	String	ชื่อเต็มของผู้รับเงิน (UTF-8)
balanceTypes	O	Array	ส่งกลับประเภทยอดเงินที่ร้องขอ

ตัวอย่าง body – การตอบกลับยอดเงิน:

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

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