เวอร์ชัน: ล่าสุด

เอกสารอ้างอิง Omise API

สร้างการผสานการชำระเงินที่ทรงพลังด้วย Omise RESTful API ประมวลผลการชำระเงินผ่านช่องทางการชำระเงินกว่า 40+ วิธีในเอเชียตะวันออกเฉียงใต้และญี่ปุ่น

ภาพรวม

Omise API จัดระเบียบตามหลักการ REST พร้อม URL ที่มีโครงสร้างทรัพยากรที่คาดเดาได้ คำขอและการตอบกลับที่เข้ารหัส JSON และใช้รหัสตอบกลับและคำกริยา HTTP มาตรฐาน

URL พื้นฐาน

เซิร์ฟเวอร์	URL	วัตถุประสงค์
เซิร์ฟเวอร์ API	`https://api.omise.co`	การเรียกเก็บเงิน ลูกค้า การโอนเงิน และการดำเนินการบัญชี
เซิร์ฟเวอร์ Vault	`https://vault.omise.co`	การสร้างโทเค็น (การจัดการข้อมูลบัตรอย่างปลอดภัย)

เวอร์ชัน API ปัจจุบัน

เวอร์ชัน: 2019-05-29

ระบุเวอร์ชัน API โดยใช้ header Omise-Version (ไม่บังคับ ค่าเริ่มต้นคือเวอร์ชัน API ของบัญชีของคุณ):

Omise-Version: 2019-05-29

เริ่มต้นอย่างรวดเร็ว

1. รับคีย์ API ของคุณ

ค้นหาคีย์ API ของคุณใน Omise Dashboard:

คีย์สาธารณะ (pkey_*) - สำหรับการดำเนินการฝั่งไคลเอนต์ (โทเค็น, แหล่งที่มา)
คีย์ลับ (skey_*) - สำหรับการดำเนินการฝั่งเซิร์ฟเวอร์ (การเรียกเก็บเงิน, ลูกค้า)

เก็บคีย์ลับของคุณให้ปลอดภัย

อย่าเปิดเผยคีย์ลับของคุณในโค้ดฝั่งไคลเอนต์ ที่เก็บ GitHub หรือสถานที่สาธารณะ ใช้ตัวแปรสภาพแวดล้อมและโค้ดฝั่งเซิร์ฟเวอร์เท่านั้น

2. การยืนยันตัวตนคำขอ

Omise ใช้ HTTP Basic การยืนยันตัวตน:

ชื่อผู้ใช้: คีย์ API ของคุณ
รหัสผ่าน: เว้นว่าง (สตริงว่าง)

# ใช้คีย์ลับ
curl https://api.omise.co/charges \
  -u skey_test_YOUR_SECRET_KEY:

# ใช้คีย์สาธารณะ
curl https://vault.omise.co/tokens \
  -u pkey_test_YOUR_PUBLIC_KEY:

3. ทำคำขอแรกของคุณ

สร้างการเรียกเก็บเงินทดสอบ:

curl https://api.omise.co/charges \
  -X POST \
  -u skey_test_YOUR_SECRET_KEY: \
  -d "amount=100000" \
  -d "currency=thb" \
  -d "card=tokn_test_no1t4tnemucod0e51mo"

การตอบกลับ:

{
  "object": "charge",
  "id": "chrg_test_5xuy4w91xqz7d1w9u0t",
  "amount": 100000,
  "currency": "thb",
  "status": "successful",
  "authorized": true,
  "captured": true,
  ...
}

ทรัพยากร API

การประมวลผลการชำระเงินหลัก

💳 การเรียกเก็บเงิน

สร้าง เรียกเก็บ และจัดการค่าธรรมเนียมการชำระเงินผ่านวิธีการชำระเงินที่รองรับทั้งหมด

POST /charges • GET /charges/:id • PATCH /charges/:id

🔐 โทเค็น

เปลี่ยนข้อมูลบัตรเครดิตเป็นโทเค็นอย่างปลอดภัยโดยไม่ต้องรับภาระการปฏิบัติตาม PCI

POST /tokens • GET /tokens/:id

📱 แหล่งที่มา

สร้างแหล่งการชำระเงินสำหรับวิธีการชำระเงินทางเลือกเช่น PromptPay ธนาคารมือถือ และรหัส QR

POST /sources • GET /sources/:id

↩️ การคืนเงิน

ออกการคืนเงินทั้งหมดหรือบางส่วนสำหรับการเรียกเก็บเงินที่เสร็จสมบูรณ์

POST /charges/:id/refunds • GET /refunds/:id

การจัดการลูกค้า

👤 ลูกค้า

จัดเก็บข้อมูลลูกค้าและวิธีการชำระเงินที่บันทึกไว้สำหรับการเรียกเก็บเงินซ้ำ

POST /customers • GET /customers/:id • PATCH /customers/:id

💳 บัตร

จัดการบัตรเครดิต/เดบิตที่บันทึกไว้ซึ่งแนบกับลูกค้า

GET /customers/:id/cards • DELETE /customers/:id/cards/:card_id

การจัดการเงิน

💸 การโอนเงิน

โอนเงินไปยังบัญชีธนาคารและจัดการกำหนดการโอนเงินอัตโนมัติ

POST /transfers • GET /transfers/:id • GET /transfers/schedules

🏦 ผู้รับ

สร้างและยืนยันผู้รับบัญชีธนาคารสำหรับการโอนเงิน

POST /recipients • GET /recipients/:id • POST /recipients/:id/verify

💰 ยอดคงเหลือ

ตรวจสอบยอดคงเหลือที่พร้อมใช้งานและที่รอดำเนินการของคุณในทุกสกุลเงิน

GET /balance

📊 ธุรกรรม

ดูประวัติธุรกรรมโดยละเอียดสำหรับการบัญชีและการกระทบยอด

GET /transactions • GET /transactions/:id

ทรัพยากรเพิ่มเติม

⚖️ ข้อพิพาท

จัดการการเรียกคืนเงินและข้อพิพาท

📢 เหตุการณ์

เข้าถึงบันทึกเหตุการณ์สำหรับ webhooks

📅 กำหนดการ

ตั้งค่าการเรียกเก็บเงินและการโอนเงินซ้ำ

🔗 ลิงก์ชำระเงิน

สร้างลิงก์การชำระเงินที่แชร์ได้

🔍 ค้นหา

ค้นหาข้ามทรัพยากรทั้งหมด

⚙️ บัญชี

ดูและอัปเดตการตั้งค่าบัญชี

คู่มือที่จำเป็น

ก่อนเจาะลึกถึงปลายทางเฉพาะ ทำความคุ้นเคยกับแนวคิดหลักเหล่านี้:

⏱️ การจำกัดอัตรา

อยู่ภายในขีดจำกัดอัตรา API และจัดการข้อผิดพลาดการจำกัดอัตรา

ขั้นตอนการทำงานทั่วไป

รับชำระเงินด้วยบัตรเครดิต

ฝั่งไคลเอนต์: สร้างโทเค็นด้วยข้อมูลบัตร
```
POST https://vault.omise.co/tokens
```
ฝั่งเซิร์ฟเวอร์: สร้างการเรียกเก็บเงินด้วยโทเค็น
```
POST https://api.omise.co/charges
```

ดูคู่มือฉบับสมบูรณ์ →

รับชำระเงิน PromptPay QR

ฝั่งเซิร์ฟเวอร์: สร้างแหล่งที่มา PromptPay
```
POST https://api.omise.co/sources
```
แสดงรหัส QR ให้กับลูกค้า
รับ webhook เมื่อการชำระเงินเสร็จสมบูรณ์

ดูคู่มือฉบับสมบูรณ์ →

บันทึกบัตรสำหรับการเรียกเก็บเงินในอนาคต

สร้างลูกค้า
```
POST https://api.omise.co/customers
```
แนบโทเค็นบัตรกับลูกค้า
```
PATCH https://api.omise.co/customers/:id
```
เรียกเก็บเงินจากบัตรเริ่มต้นของลูกค้า
```
POST https://api.omise.co/charges
```

ดูคู่มือฉบับสมบูรณ์ →

รูปแบบการตอบกลับ

การตอบกลับ API ทั้งหมดเป็นออบเจ็กต์ที่เข้ารหัส JSON พร้อมฟิลด์ object ที่ระบุประเภททรัพยากร:

{
  "object": "charge",
  "id": "chrg_test_5xuy4w91xqz7d1w9u0t",
  "livemode": false,
  "amount": 100000,
  "currency": "thb",
  ...
}

รายการออบเจ็กต์

ปลายทางรายการส่งคืนผลลัพธ์ที่แบ่งหน้า:

{
  "object": "list",
  "data": [
    { "object": "charge", "id": "chrg_..." },
    { "object": "charge", "id": "chrg_..." }
  ],
  "limit": 20,
  "offset": 0,
  "total": 142,
  "from": "2025-01-01T00:00:00Z",
  "to": "2025-02-07T23:59:59Z"
}

การทดสอบ

ใช้คีย์ API ทดสอบ (ที่มี _test_) สำหรับการพัฒนา:

คีย์สาธารณะทดสอบ: pkey_test_...
คีย์ลับทดสอบ: skey_test_...

คีย์ทดสอบ:

✅ ไม่ดำเนินการชำระเงินจริง
✅ ยอมรับหมายเลขบัตรทดสอบ
✅ ส่งคืนการตอบกลับที่สมจริง
✅ ทริกเกอร์ webhooks ไปยังปลายทางทดสอบ

ดูบัตรทดสอบ →

ไลบรารีสำหรับลูกค้า

ไลบรารีอย่างเป็นทางการสำหรับภาษาโปรแกรมยอดนิยม:

การขอความช่วยเหลือ