Charge API
Charge API ช่วยให้คุณสามารถสร้างและจัดการการเรียกเก็บเงินสำหรับวิธีการชำระเงินทั้งหมดที่ Omise รองรับ
Endpoints
- สร้าง Charge - สร้าง charge ใหม่
- ดึงข้อมูล Charge - ดูรายละเอียดของ charge ที่ระบุ
- อัปเดต Charge - อัปเดตข้อมูล charge
- รายการ Charges - แสดงรายการ charges ทั้งหมด
- ค้นหา Charges - ค้นหา charges ที่ต้องการ
- จับยอด Charge - จับยอด charge ที่ได้รับอนุมัติล่วงหน้า
- ย้อนกลับ Charge - ย้อนกลับ charge ที่ยังไม่ได้จับยอด
- ทำให้ Charge หมดอายุ - ทำให้ charge หมดอายุด้วยตนเอง
- ทำเครื่องหมาย Charge ว่าชำระแล้ว - ทำเครื่องหมาย charge ว่าชำระแล้ว (โหมดทดสอบเท่านั้น)
- ทำเครื่องหมาย Charge ว่าล้มเหลว - ทำเครื่องหมาย charge ว่าล้มเหลว (โหมดทดสอบเท่านั้น)
กรณีการใช้งานทั่วไป
- การชำระเงินครั้งเดียว: สร้าง charges สำหรับการชำระเงินทันที
- การอนุมัติล่วงหน้า: อนุมัติเงินและจับยอดทีหลัง
- การเรียกเก็บเงินแบบประจำ: สร้าง charges สำหรับวิธีการชำระเงินที่บันทึกไว้
- หลายสกุลเงิน: ประมวลผล charges ในสกุลเ งินต่างๆ
รหัสความล้มเหลวของ Charge
เมื่อ charge ล้มเหลว แอตทริบิวต์ failure_code จะระบุสาเหตุ รหัสความล้มเหลวที่เป็นไปได้ทั้งหมดมีดังนี้:
รหัสความล้มเหลวการชำระเงิน
| รหัส | ข้อความ | คำอธิบาย |
|---|---|---|
confirmed_amount_mismatch | "final amount from payment channel does not match original amount charged" | จำนวนเงินไม่ตรงกับผู้ให้บริการชำระเงิน |
expired_card | "card is expired" | บัตรหมดอายุ |
failed_fraud_check | "fraud check failed" | บัตรถูกตั้งค่าสถานะว่าเป็นการฉ้อโกง |
failed_processing | "processing failed" | ความล ้มเหลวในการประมวลผลการชำระเงินทั่วไป |
insufficient_balance | "insufficient balance" | ยอดเงินในบัญชีไม่เพียงพอ |
insufficient_fund | "insufficient funds" | บัตรถึงวงเงินหรือยอดเงินไม่เพียงพอ |
invalid_account | "invalid account" | ไม่พบบัญชีที่ถูกต้องสำหรับวิธีการชำระเงิน |
invalid_account_number | "invalid account number" | หมายเลขบัญชีไม่ถูกต้อง |
invalid_security_code | "invalid security code" | รหัส CVV/CVC ไม่ถูกต้อง |
payment_cancelled | "payment cancelled" | การชำระเงินถูกยกเลิกโดยผู้ชำระเงิน |
payment_rejected | "payment rejected" | การชำระเงินถูกปฏิเสธโดยผู้ออกบัตร |
stolen_or_lost_card | "stolen or lost card" | บัตรถูกรายงานว่าถูกขโมยหรือสูญหาย |
timeout | "timeout" | ผู้ให้บริการชำระเงินไม่ตอบสนองทันเวลา |
รหัสความล้มเหลวการดำเนินการ
| รหัส | ข้อความ | คำอธิบาย |
|---|---|---|
failed_capture | "capture failed" | การจับยอด charge ไม่สำเร็จ |
failed_void | "void failed" | การยกเลิก charge ไม่สำเร็จ |
failed_reverse | "reverse failed" | การย้อนกลับ charge ไม่สำเร็จ |
failed_refund | "refund failed" | เกิดข้อผิดพลาดในการประมวลผลการคืนเงิน |
expired_charge | "charge expired" | เกินกรอบเวลาการอนุมัติ |
รหัสความล้มเหลว 3D Secure
| รหัส | ข้อความ | คำอธิบาย |
|---|---|---|
3ds_authentication_failed | "3D Secure authentication failed" | ลูกค้าล้มเหลวในการยืนยัน 3D Secure |
3ds_rejected | "3D Secure rejected" | 3D Secure ถูกป ฏิเสธโดยผู้ออกบัตร |
ค่าสถานะ Charge
| สถานะ | คำอธิบาย |
|---|---|
successful | การชำระเงินเสร็จสมบูรณ์ |
pending | รอการดำเนินการของลูกค้า (เช่น สแกน QR code, ทำ 3DS ให้เสร็จ) |
failed | การชำระเงินล้มเหลว (ตรวจสอบ failure_code สำหรับสาเหตุ) |
reversed | charge ที่ยังไม่ได้จับยอดถูกย้อนกลับ |
expired | charge หมดอายุก่อนที่จะเสร็จสมบูรณ์ |
ทรัพยากรที่เกี่ยวข้อง
- Tokens - สร้าง token วิธีการชำระเงินก่อนสร้าง charges
- Sources - วิธีการชำระเง ินทางเลือก
- Customers - บันทึกวิธีการชำระเงินสำหรับ charges แบบประจำ
- Refunds - คืนเงินจำนวนที่เรียกเก็บ
- การจัดการข้อผิดพลาด - เอกสารอ้างอิงข้อผิดพลาด API ฉบับสมบูรณ์