การโอนจ่าย (Pay-out · อียิปต์)

API Pay-out ภูมิภาค อียิปต์ (EGP). ดู วิธีชำระเงิน

คำขอ

POST/v2.0/disbursement/pay-out

URL คำขอ:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/disbursement/pay-out
production: https://gateway.smilepayz.com/v2.0/disbursement/pay-out

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

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

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

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
orderNo	M	String(32)	หมายเลข order ที่ไม่ซ้ำของ merchant, 6–32 ตัวอักษรและตัวเลข
purpose	M	String(64)	ข้อความสรุปของธุรกรรม, 1–64 อักขระ UTF-8
merchant	M	Object	มี merchantId และ field sub-merchant ที่ไม่บังคับ
merchantId	M	String	merchantId ของ Smilepayz สำหรับคำขอนี้
merchantName	O	String	ชื่อแสดงผลของ merchant แบบ UTF-8 (ไม่บังคับ)
subMerchantId	O	String	ID ของ sub-merchant (ไม่บังคับ)
subMerchantName	O	String	ชื่อ UTF-8 ของ subMerchantId (ไม่บังคับ)
money	M	Object	ออบเจ็กต์ยอดเงินที่มี currency และ amount ของธุรกรรม
currency	M	String	รหัสสกุลเงินสำหรับคำขอนี้
amount	M	Number	ยอดธุรกรรมสกุล EGP ต้องมากกว่า 0
paymentMethod	M	String	รหัสธนาคารของอียิปต์ ดู วิธีชำระเงิน
cashAccount	M	String(64)	เลขบัญชีธนาคารผู้รับเงิน
receiver	O	Object	ข้อมูลผู้รับเงิน หากไม่ส่ง Smilepayz จะเติมข้อมูลที่ channel ต้องใช้
name	O	String	ชื่อผู้รับเงิน (UTF-8)
email	O	String	อีเมลผู้รับเงิน
phone	O	String	เบอร์โทรผู้รับเงิน
callbackUrl	O	String(256)	URL HTTPS สำหรับแจ้งสถานะแบบ async สูงสุด 256 อักขระ

---

ตัวอย่าง body – คำขอจ่ายเงิน:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+02:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001

{
    "orderNo": "2000102900000000000001",
    "purpose": "จ่ายเงินผู้รับเหมา - Cairo",
    "merchant": {
        "merchantId": "20001"
    },
    "money": {
        "currency": "EGP",
        "amount": 20000
    },
    "paymentMethod": "NBE",
    "cashAccount": "0012345678",
    "receiver": {
        "name": "Ahmed Hassan El-Masry",
        "email": "[email protected]",
        "phone": "201234567890"
    }
}

การตอบกลับ

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 ที่อ่านได้
orderNo	M	String	หมายเลข order ที่ไม่ซ้ำของ merchant, 6–32 ตัวอักษรและตัวเลข
tradeNo	O	String	tradeNo ของ Smilepayz สำหรับ order นี้
status	O	String	ค่า enum ของสถานะ order หรือการชำระเงิน
disbursementTime	M	String	รูปแบบ yyyy-MM-ddTHH:mm:ss±HH:mm
merchant	M	Object	มี merchantId และ field sub-merchant ที่ไม่บังคับ
merchantId	M	String	merchantId ของ Smilepayz สำหรับคำขอนี้
merchantName	O	String	ชื่อแสดงผลของ merchant แบบ UTF-8 (ไม่บังคับ)
subMerchantId	O	String	ID ของ sub-merchant (ไม่บังคับ)
subMerchantName	O	String	ชื่อ UTF-8 ของ subMerchantId (ไม่บังคับ)
accountNo	O	String	accountNo สำหรับ settlement เมื่อ gateway ส่งกลับมา
money	M	Object	ออบเจ็กต์ยอดเงินที่มี currency และ amount ของธุรกรรม
currency	M	String	รหัสสกุลเงินสำหรับคำขอนี้
amount	M	Number	ยอดธุรกรรมสกุล EGP ต้องมากกว่า 0
channel	M	Object	ข้อมูล channel เช่น paymentUrl, qrString และอื่น ๆ
paymentMethod	M	String	รหัสวิธีชำระเงิน (ดูเอกสาร วิธีชำระเงิน)
cashAccount	M	String	เลขบัญชีธนาคารของผู้รับเงิน
accountName	O	String	ชื่อแสดงผลของผู้รับเงินเมื่อ channel ส่งกลับมา

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

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

{
    "code": "00",
    "message": "Successful",
    "orderNo": "2000102900000000000001",
    "tradeNo": "1522000109e998347483949",
    "status": "PROCESSING",
    "disbursementTime": "2024-12-17T10:55:00+02:00",
    "merchant": {
        "merchantId": "20001",
        "merchantName": "Smilepayz Demo Store",
        "accountNo": "2000124234782342"
    },
    "money": {
        "currency": "EGP",
        "amount": 20000
    },
    "channel": {
        "paymentMethod": "NBE",
        "cashAccount": "0012345678",
        "accountName": "Ahmed Hassan El-Masry"
    }
}

การแจ้งเตือน/Callback

Header HTTP

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

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

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
orderNo	M	String	หมายเลข order ที่ไม่ซ้ำของ merchant, 6–32 ตัวอักษรและตัวเลข
tradeNo	M	String	tradeNo ของ Smilepayz สำหรับ order นี้
merchantId	M	String	merchantId ของ Smilepayz สำหรับคำขอนี้
merchantName	M	String	ชื่อแสดงผลของ merchant แบบ UTF-8 (ไม่บังคับ)
subMerchantId	O	String	ID ของ sub-merchant (ไม่บังคับ)
subMerchantName	O	String	ชื่อ UTF-8 ของ subMerchantId (ไม่บังคับ)
paymentMethod	M	String	รหัสวิธีชำระเงิน (ดูเอกสาร วิธีชำระเงิน)
transactionTime	M	String	เวลาที่เสร็จสิ้น
money	M	Object	ออบเจ็กต์ยอดเงินที่มี currency และ amount ของธุรกรรม
currency	M	String	รหัสสกุลเงินสำหรับคำขอนี้
amount	M	Number	ยอดธุรกรรมสกุล EGP ต้องมากกว่า 0
status	M	String	ค่า enum ของสถานะ order หรือการชำระเงิน

ค่าที่ต้องตอบกลับ

สำคัญ

ตอบกลับเฉพาะ string SUCCESS เท่านั้น

{
    "orderNo": "2000102900000000000001",
    "tradeNo": "1522000109e998347483949",
    "merchantId": "20001",
    "merchantName": "Smilepayz Demo Store",
    "subMerchantId": "",
    "subMerchantName": "",
    "paymentMethod": "NBE",
    "transactionTime": "2024-12-17T10:55:00+02:00",
    "money": {
        "currency": "EGP",
        "amount": 20000
    },
    "status": "SUCCESS"
}

SUCCESS