ข้ามไปยังเนื้อหาหลัก

HTTP ธรรมดา

เรียก PAYDY ได้จากทุกภาษา

marketing.docs.http.hero.lede

ทุกการเรียก

พื้นฐานการเรียก

base URL คีย์ของคุณ และ JSON เท่านี้ก็เรียก API ได้
HTTP
POST https://api-sandbox.paydy.ai/v1/merchant/payment-links
Authorization: Bearer epk_test_…
Content-Type: application/json
Idempotency-Key: order-10428-link

Sandbox (ทดสอบ)

https://api-sandbox.paydy.ai/v1epk_test_…

Production (ใช้งานจริง)

https://api.paydy.ai/v1epk_live_…

ใช้คีย์ให้ตรงกับสภาพแวดล้อมที่เรียก

คีย์ epk_test_… ใช้ได้เฉพาะ sandbox คีย์ epk_live_… ใช้ได้เฉพาะ production และคีย์หนึ่งเรียกได้เฉพาะ endpoint ที่ scope อนุญาต กติกาการยืนยันตัวตน →

คัดลอกไปใช้ได้

ตัวอย่างการใช้งาน

สี่การเรียกที่การเชื่อมต่อส่วนใหญ่ต้องใช้ในวันแรก ห้าภาษา สร้างจากแคตตาล็อก endpoint ชุดเดียวกับเอกสารอ้างอิง API

สร้างลิงก์ชำระเงิน

วิธีรับเงินที่เร็วที่สุด เรียกครั้งเดียว ได้ URL ไปวางที่ไหนก็ได้

cURL
curl -X POST https://api-sandbox.paydy.ai/v1/merchant/payment-links \
  -H "Authorization: Bearer $PAYDY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: idem_createpaymentlink_001" \
  -d '{
       "store_id": "01JQ8V0STORE00000000000001",
       "title": "WINMAX Order #10428",
       "amount": 1290,
       "channels_enabled": [
         "promptpay",
         "visa",
         "mastercard"
       ],
       "expires_in_hours": 24,
       "reference": "ORD-2026-10428"
     }'

ตรวจสอบรายการ

อ่านสถานะ ค่าธรรมเนียม และยอดสุทธิของรายการที่หน้าชำระเงินได้รับ

cURL
curl -X GET https://api-sandbox.paydy.ai/v1/merchant/transactions/01JQ8W4M3K1L2N5P6Q7R8S9T0U \
  -H "Authorization: Bearer $PAYDY_API_KEY" \

คืนเงินรายการ

คืนทั้งหมดหรือบางส่วนผ่านพาร์ทเนอร์ที่รับเงินไว้ สถานะจะรอดำเนินการจนกว่าพาร์ทเนอร์ยืนยัน

cURL
curl -X POST https://api-sandbox.paydy.ai/v1/merchant/transactions/01JQ8W4M3K1L2N5P6Q7R8S9T0U/refund \
  -H "Authorization: Bearer $PAYDY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: idem_refundtransaction_001" \
  -d '{
       "amount": 290,
       "reason": "Customer returned 1 of 2 items"
     }'

แบ่งยอดรายการที่ชำระแล้ว

แบ่งยอดรายการที่ชำระแล้วให้ผู้ขาย พาร์ทเนอร์ และผู้ส่ง ตามกฎหรือตามรายการ ยอดที่แบ่งคือยอดของรายการนั้น และแต่ละรายการแบ่งได้ครั้งเดียว

cURL
curl -X POST https://api-sandbox.paydy.ai/v1/merchant/split-payments/execute \
  -H "Authorization: Bearer $PAYDY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: idem_splitpayment_001" \
  -d '{
       "transaction_id": "01JQ8W4M3K1L2N5P6Q7R8S9T0U",
       "items": [
         {
           "account_label": "Main shop",
           "account_type": "merchant",
           "split_type": "percentage",
           "split_value": 60
         },
         {
           "account_label": "Partner studio",
           "account_type": "vendor",
           "split_type": "percentage",
           "split_value": 30
         },
         {
           "account_label": "Courier",
           "account_type": "vendor",
           "split_type": "fixed",
           "split_value": 45
         }
       ]
     }'

พฤติกรรมของ API

แนวทางที่ควรรู้

สิ่งที่ทุกการเชื่อมต่อต้องรับมือ ไม่ว่าจะใช้ภาษาใด

จำนวนเงินเป็นบาท ทศนิยมสองตำแหน่ง

ส่งและรับจำนวนเงินเป็นบาท ทศนิยมไม่เกินสองตำแหน่ง เช่น 1290.50 คือ ฿1,290.50 ทศนิยมมากกว่านั้นจะถูกปฏิเสธ

โครง error แบบเดียว

marketing.docs.http.conventions.items.errors.desc

ส่งซ้ำด้วยคีย์เดิม

ส่ง Idempotency-Key กับการเรียกที่สร้างหรือย้ายเงิน การส่งซ้ำด้วยคีย์และ body เดิมจะได้คำตอบแรกกลับมาแทนการทำซ้ำ

แบ่งหน้า

รายการตอบ meta.page, per_page, total และ total_pages ให้ขอหน้าถัดไปจนกว่า page เท่ากับ total_pages

ตรวจลายเซ็น webhook เอง

คำนวณ HMAC SHA-256 จาก body ดิบด้วย secret ของ endpoint แล้วเทียบกับ header ลายเซ็น คู่มือ webhook มีตัวอย่างโค้ดตรวจสอบให้คัดลอก

พร้อมเรียกจริงแล้วหรือยัง?

สร้างคีย์ทดสอบในคอนโซล ตั้ง client ให้ชี้ไปที่ sandbox base URL แล้วลองตัวอย่างแรก

เรียก PAYDY API ด้วย HTTP · PAYDY.ai