เอกสาร API

บทนำ

Payman API เป็น REST API ที่ใช้รูปแบบ JSON การร้องขอทั้งหมดจะส่งไปที่ https://payman33.com/v1 ผ่าน HTTPS

การยืนยันตัวตน

ส่งโทเค็นการเข้าถึงที่คุณได้รับเมื่อสร้างบัญชีเป็น bearer token โทเค็นนี้จะแสดงเพียงครั้งเดียวและไม่สามารถออกใหม่ได้ ดังนั้นควรเก็บเป็นความลับและห้ามใส่ในโค้ดฝั่งไคลเอ็นต์

Authorization: Bearer pm_live_xxxxxxxxxxxxxxxx

ส่งข้อความ

POST /messages

{
  "id": "msg_01J9Z3K8V2",
  "status": "queued",
  "recipients": 1,
  "segments": 1,
  "cost": 0.0063
}

เพิ่มส่วนหัว Idempotency-Key เพื่อลองส่งซ้ำอย่างปลอดภัย: การใช้คีย์เดียวกันภายใน 24 ชั่วโมงจะส่งผลลัพธ์เดิมแทนการส่งซ้ำ

สถานะข้อความ

GET /messages/{id}

สถานะ: queued, ตามด้วย sent, แล้วจึง delivered หรือ failed ข้อความที่กำหนดเวลาจะคงสถานะ scheduled จนกว่าจะส่งออก สามารถยกเลิก (และได้รับเงินคืน) ด้วย POST /messages/{id}/cancel

เว็บฮุค

เมื่อรายงานการส่งมาถึง เราจะ POST ไปยัง callback_url ของคุณ แต่ละการร้องขอจะมีส่วนหัว X-Payman-Signature: HMAC-SHA256 ของเนื้อหากับรหัสลับเว็บฮุคของคุณ (ในแดชบอร์ด แท็บ API) เพื่อให้คุณสามารถยืนยันได้ การส่งที่ล้มเหลวจะลองใหม่สูงสุด 3 ครั้ง

{
  "id": "msg_01J9Z3K8V2",
  "to": "+14155550123",
  "status": "delivered",
  "delivered_at": "2026-10-09T08:12:03Z"
}

ยอดเงิน

GET /balance

ส่งคืนยอดคงเหลือปัจจุบันของคุณใน USDT ราคาจะแสดงเป็น USD โดย 1 USDT = 1 USD

ข้อผิดพลาด

ข้อจำกัดอัตรา

ขีดจำกัดเริ่มต้นคือ 50 ร้องขอต่อวินาทีต่อบัญชี ใช้การส่งแบบกลุ่ม (หลายหมายเลขใน to) สำหรับแคมเปญขนาดใหญ่ บัญชีที่ยังไม่ยืนยันสามารถส่งถึงผู้รับได้สูงสุด 500 รายต่อวัน