API Reference
เอกสารอ้างอิง Omise API ฉบับสมบูรณ์ - รับชำระเงิน, จัดการลูกค้า, ประมวลผลการคืนเงิน และอื่นๆ ด้วย RESTful API
เอกสารอ้างอิง Omise API ฉบับสมบูรณ์ - รับชำระเงิน, จัดการลูกค้า, ประมวลผลการคืนเงิน และอื่นๆ ด้วย RESTful API
เรียนรู้วิธีจัดการเวอร์ชัน Omise API, ระบุเวอร์ชันด้วย Omise-Version header, ทำความเข้าใจ breaking vs non-breaking changes, จัดการ deprecations และรักษาความเข้ากันได้ย้อนหลัง
จัดการ webhook signing secrets สำหรับบัญชี Omise ของคุณ ใช้ secrets เพื่อยืนยันว่าเหตุการณ์ webhook มาจาก Omise จริงและไม่ถูกดัดแปลง
โอนเงินจากยอดคงเหลือในบัญชี Omise ของคุณไปยังบัญชีธนาคารของผู้รับ การโอนเงินเป็นขั้นตอนสุดท้ายในกระบวนการจ่ายเงิน
เข้าถึงและค้นหาบันทึก audit สำหรับการติดตามกิจกรรมบัญชีอย่างครอบคลุม รวมถึงการดำเนินการของผู้ใช้ การเปลี่ยนแปลงการกำหนดค่า และเหตุการณ์ระบบ
ดึงยอดคงเหลือบัญชีและเงินที่ใช้ได้ในทุกสกุลเงินด้วย Omise Balance API
ค้นพบวิธีการชำระเงินที่ใช้ได้ สกุลเงินที่รองรับ ขีดจำกัดการทำธุรกรรม และฟีเจอร์บัญชีสำหรับการเชื่อมต่อ Omise ของคุณ
สร้างและจัดการกำหนดการเรียกเก็บเงินแบบเป็นกลุ่มด้วย Charge Schedules API อัปโหลดไฟล์ CSV เพื่อสร้างหลายกำหนดการ และหยุดชั่วคราว เปิดใช้งานต่อ หรือลบกำหนดการในการดำเนินการแบบกลุ่ม
จัดการโปรไฟล์ลูกค้าและวิธีชำระเงินที่บันทึกไว้ เก็บบัตรอย่างปลอดภัยและเรียกเก็บเงินจากลูกค้าด้วย Omise Customers API
จัดการข้อพิพาทการชำระเงิน (chargebacks) ที่ลูกค้ายื่นต่อธนาคารผู้ออกบัตร ตอบกลับพร้อมหลักฐานเพื่อโต้แย้งข้อพิพาท
จัดการไฟล์เอกสารเพื่อช่วยในการแก้ไขข้อพิพาท อ ัปโหลดหลักฐานเช่น ใบเสร็จ ใบส่งสินค้า และการติดต่อกับลูกค้า
เข้าถึงบันทึกกิจกรรมและประวัติ webhook event ในบัญชี Omise ของคุณ Events แสดงถึงการดำเนินการต่างๆ เช่น การชำระเงินที่สำเร็จ การชำระเงินที่ล้มเหลว และข้อพิพาท
เรียนรู้วิธีลอง Omise API requests ซ้ำอย่างปลอดภัยโดยใช้ idempotency keys ทำความเข้าใจ idempotency header, รูปแบบ key, การหมดอายุ และแนวทางปฏิบัติที่ดีที่สุดสำหรับการเชื่อมต่อการชำระเงินที่เชื่อถือได้
จัดการบัญชีที่เชื่อมต่อสำหรับแพลตฟอร์มของคุณ Linked accounts แสดงถึง sub-accounts ที่เชื่อมต่อซึ่งสามารถประมวลผลการชำระเงินและรับเงินผ่านแพลตฟอร์มของคุณ
เรียนรู้วิธีนำทางผ่านชุดผลลัพธ์ขนาดใหญ่อย่างมีประสิทธิภาพด้วย Omise API pagination โดยใช้ limit, offset และ list responses เชี่ยวชาญรูปแบบ pagination สำหรับ charges, customers และทรัพยากรอื่นๆ
สร้างและจัดการ Payment Links+ โดยใช้ API เฉพาะพร้อมเทมเพลต Custom Webhook และฟีเจอร์ขั้นสูง
เรียนรู้เกี่ยวกับ rate limits ของ Omise API, ทำความเข้าใจ rate limit headers, จัดการ HTTP 429 responses, ใช้ exponential backoff และเพิ่มประสิทธิภาพการเชื่อมต่อให้อยู่ภายในขีดจำกัด
จัดการบัญชีธนาคารปลายทางสำหรับการโอนเงิน Recipient แสดงถึงบัญชีธนาคารที่ได้รับการยืนยันซึ่งสามารถรับการจ่ายเงินจากยอดคงเหลือ Omise ของคุณ
ออกคำสั่งคืนเงินเต็มจำนวนหรือบางส่วนสำหรับการเรียกเก็บเงินบัตรเครดิต ดำเนินการคืนสินค้าและการยกเลิกด้วย Omise Refunds API
จัดการกฎการกำหนดเส้นทางการชำระเงินเพื่อควบคุมวิธีการประมวลผลธุรกรรมข้ามผู้ให้บริการชำระเงินและ acquirers ต่างๆ
สร้างและจัดการการชำระเงินแบบเป็นงวดๆ และการโอนเงินอัตโนมัติตามตารางเวลาโดยใช้ Schedules API
เข้าถึง OpenAPI schema สำหรับ Omise API เพื่อทำความเข้าใจ endpoints, parameters และ data structures ที่มี
ค้นหาในทรัพยากร Omise ทั้งหมดรวมถึง charges, customers, disputes และอื่นๆ ด้วย Search API แบบ universal
รับวิธีการชำระเงินทางเลือก รวมถึง PromptPay, mobile banking, QR codes และอื่น ๆ ด้วย Omise Sources API
จัดการ sub-merchants สำหรับบัญชีตลาดกลางและแพลตฟอร์ม Sub-merchants แทนผู้ขาย ผู้จำหน่าย หรือผู้ให้บริการที่ประมวลผลการชำระเง ินผ่านแพลตฟอร์มของคุณ
แปลงข้อมูลบัตรเครดิตเป็น Token อย่างปลอดภัยโดยไม่ต้องจัดการข้อมูลบัตรที่ละเอียดอ่อนบนเซิร์ฟเวอร์ของคุณ เรียนรู้วิธีใช้ Omise Tokens API สำหรับการประมวลผลการชำระเงินที่สอดคล้องกับ PCI
ดูประวัติธุรกรรมโดยละเอียดและกิจกรรมบัญชีด้วย Omise Transactions API สำหรับการกระทบยอดและการรายงาน
ค้นหาข้ามหลายประเภททรัพยากร รวมถึง charges, customers, disputes, recipients และอื่นๆ ด้วยความสามารถในการกรองและ query ขั้นสูง
เรียนรู้วิธีการจัดการข้อผิดพลาด Omise API อย่างเหมาะสม ทำความเข้าใจรูปแบบการตอบกลับข้อผิดพลาด รหัสสถานะ ประเภทข้อผิดพลาดทั่วไป และนำกลยุทธ์การจัดการข้อผิดพลาดที่แข็งแกร่งมาใช้ในการผสานรวมของคุณ
เรียนรู้วิธีการยืนยันตัวตนคำขอ API โดยใช้คีย์ API ของ Omise ทำความเข้าใจความแตกต่างระหว่างคีย์สาธารณะและคีย์ลับ และนำการยืนยันตัวตนที่ปลอดภัยมาใช้ในการผสานรวมของคุณ
ค้นหาบันทึก audit สำหรับกิจกรรมบัญชี รวมถึงการดำเนินการของผู้ใช้ การเปลี่ยนแปลงการกำหนดค่า และเหตุการณ์ระบบ
ค้นหา charge schedules โดยใช้ Omise Search API เพื่อค้นหา schedules ตามเกณฑ์ต่างๆ
ค้นหาและกรอง charges โดยใช้ Omise Search API เพื่อค้นหาธุรกรรมตามคำอธิบาย, metadata, รายละเอียดบัตร และอื่นๆ
ค้นหาและกรอง linked accounts โดยใช้ Omise Search API เพื่อค้นหาบัญชีด้วยชื่อ อีเมล สถานะ และอื่นๆ
ค้นหาลิงก์ชำระเงินด้วยเงื่อนไขต่างๆ รวมถึง title, amount, currency และ metadata
ค้นหา Recipient ตามเกณฑ์ต่างๆ รวมถึงชื่อ อีเมล ประเภท และ metadata โดยใช้ Omise Search API
ค้นหาและกรอง sub-merchants โดยใช้ Omise Search API เพื่อค้นหาร้านค้าตามชื่อ อีเมล รายละเอียดธุรกิจ และอื่นๆ
ค้นหาและกรองการคืนเงินโดยใช้ Omise Search API เพื่อค้นหาการคืนเงินตาม metadata จำนวนเงิน สถานะ และอื่นๆ
ค้นหาการโอนตามเกณฑ์ต่างๆ โดยใช้ Omise Search API
ค้นหาข้อพิพาทตามเกณฑ์ต่างๆ รวมถึงสถานะ รหัสเหตุผล จำนวนเงิน และช่วงวันที่โดยใช้ Omise Search API
ค้นหาตารางการโอนโดยใช้ Omise Search API เพื่อค้นหาตารางตามเกณฑ์ต่างๆ
ค้นหาใบเสร็จด้วยเงื่อนไขต่างๆ รวมถึงช่วงวันที่ จำนวนเงิน และคุณลักษณะใบเสร็จอื่นๆ
ค้นหาและกรองลูกค้าโดยใช้ Omise Search API เพื่อค้นหาบันทึกลูกค้าตามอีเมล, คำอธิบาย, metadata และอื่นๆ
จับยอด charge ที่ได้รับอนุมัติก่อนหน้านี้เพื่อทำให้การชำระเงินเสร็จสมบูรณ์และโอนเงินเข้าบัญชีของคุณ
ดาวน์โหลดรายงาน CSV โดยละเอี ยดที่แสดงสถานะของแต่ละแถวจากงานสร้างกำหนดการเรียกเก็บเงินแบบกลุ่ม รวมถึงข้อความข้อผิดพลาดสำหรับแถวที่ล้มเหลว
รับข้อมูลรายละเอียดเกี่ยวกับ event เฉพาะรวมถึงสถานะการส่ง webhook และข้อมูล event ที่สมบูรณ์
ดึงรายละเอียดของ linked account เฉพาะตาม ID
ดึงข้อมูลรายละเอียดเกี่ยวกับการคืนเงินเฉพาะรายการ รวมถึงสถานะ จำนวนเงิน และรายละเอียดธุรกรรม
ดึง OpenAPI schema สำหรับ Omise API เพื่อค้นหา endpoints พารามิเตอร์ และโครงสร้างข้อมูล
ดึงยอดคงเหลือบัญชี Omise รวมถึงยอดรวม จำนวนที่โอนได้ และเงินสำรองในทุกสกุลเง ิน
ดึงวิธีการชำระเงินที่ใช้ได้ สกุลเงินที่รองรับ ขีดจำกัดธุรกรรม และความสามารถของบัญชีสำหรับบัญชี Omise ของคุณ
ดึงรายละเอียดการเชื่อมต่อ chain merchant เฉพาะ
ดึงรายละเอียดของ charge ที่มีอยู่ด้วย ID เพื่อตรวจสอบสถานะการชำระเงินและรายละเอียดธุรกรรม
ดึงรายละเอียดของลิงก์ชำระเงินเฉพาะรวมถึงประวัติ charge และสถานะการใช้งาน
ดึงข้อมูล occurrence ของ schedule เฉพาะ รับรายละเอียดเกี่ยวกับการดำเนินการแต่ละครั้งของ schedule ที่เกิดขึ้นซ้ำ รวมถึงสถานะ ผลลัพธ์ และข้อความ error
ดึงข้อมูลรายละเอียดของ Recipient เฉพาะด้วย ID
ดึงข้อมูล refund ที่ระบุสำหรับ charge โดย ID
ดึงข้อมูลเกี่ยวกับ payment source ที่มีอยู่ ตรวจสอบสถานะ source, ประเภท และรายละเอียดการชำระเงิน
ดึงข้อมูลเกี่ยวกับ Token ที่มีอยู่ ตรวจสอบสถานะ Token รายละเอียดบัตร และการใช้งาน
ดึงรายละเอียดของการโอนที่ระบุโดยใช้รหัส
ดึงการโอนที่เชื่อมโยงกับ chain เฉพาะเพื่อติดตามการจ่ายเงินให้ร้านค้า
ดึงข้อมูลโดย ละเอียดเกี่ยวกับข้อพิพาทเฉพาะรวมถึงสถานะ รหัสเหตุผล เอกสารหลักฐาน และรายละเอียดการเรียกเก็บเงินที่เกี่ยวข้อง
ดึงข้อมูลความยินยอมสำหรับบัญชี รวมถึงสถานะความยินยอมและการกำหนดค่า
ดึงข้อมูลตารางเวลาเฉพาะด้วยรหัส รับรายละเอียดเกี่ยวกับการเรียกเก็บเงินแบบเป็นงวดๆ การโอนเงิน occurrence และสถานะตารางเวลา
ดึงรายละเอียดของเทมเพลต Payment Links+ ที่ระบุ
ดึงรายละเอียดของธุรกรรมที่ระบุด้วย ID รวมถึงจำนวนเงิน สกุลเงิน ทิศทาง และข้อมูลแหล่งที่มา
ดึงรายละเอียดบัญชี Omise รวมถึงอีเมล, ประเทศ, สกุลเงิน และวิธีการชำระเงินที่รองรับ
ดึงข้อมูลบัญชีสำหรับการเชื่อมต่อ chain
ดึงข้อมูลรายละเอียดเกี่ยวกับบัตรเฉพาะที่แนบกับลูกค้าด้วย Omise Cards API
ดึงรายละเอียดของใบเสร็จเฉพาะโดยใช้ตัวระบุ
ดึงรายละเอียดของ Payment Link+ ที่ระบุ
ดึงข้อมูลโปรไฟล์ลูกค้าทั้งหมด รวมถึงบัตรที่บันทึก, อีเมล และ metadata ด้วย Omise Customers API
ดึงข้อมูลเอกสารเฉพาะจากข้อพิพาท รับข้ อมูลโดยละเอียดเกี่ยวกับไฟล์หลักฐานรวมถึง URL สำหรับดาวน์โหลด
ดึงข้อมูลเอกสารเฉพาะจากข้อพิพาท รับข้อมูลรายละเอียดเกี่ยวกับไฟล์หลักฐานรวมถึง URL ดาวน์โหลด
ดึงอัตราแลกเปลี่ยนปัจจุบันสำหรับธุรกรรมหลายสกุลเงิน รับอัตราแปลงแบบ real-time ระหว่างสกุลเงินที่รองรับ
ติดตามความคืบหน้าของงานสร้างกำหนดการเรียกเก็บเงินแบบกลุ่ม รับข้อมูลสถานะแบบเรียลไทม์เกี่ยวกับการประมวลผลแถวและความสำเร็จ
ทำเครื่องหมาย test charge ว่าชำระแล้วสำหรับวัตถุประสงค์การทดสอบและการพัฒนา
ทำเครื่องหมาย test charge ว่าล้มเหลวสำหรับวัตถุประสงค์การทดสอบและการพัฒนา
ทำเครื่องหมายการโอนว่าจ่ายแล้วสำหรับการโอนแบบแมนนวลหรือออฟไลน์
ทำเครื่องหมายการโอนว่าส่งแล้วสำหรับการโอนแบบแมนนวลหรือออฟไลน์
ตั้งค่าให้ charge ที่รอดำเนินการหมดอายุก่อนที่ลูกค้าจะชำระเงินเสร็จ ใช้ได้กับวิธีการชำระเงินบางประเภท เช่น Alipay, DANA, GCash, KakaoPay, PayPay และ Touch 'n Go
เอกสารอ้างอิง bank account object สำหรับ Recipient และ Transfer ทำความเข้าใจโครงสร้าง bank_account ที่ใช้ใน การจ่ายเงินผ่าน Omise
ปิดข้อพิพาทหลังจากการแก้ไข Endpoint นี้ใช้เพื่อสรุปข้อพิพาทที่ได้รับการแก้ไขผ่านกระบวนการ chargeback
เปิดใช้งานกำหนดการเรียกเก็บเงินที่หยุดชั่วคราวหนึ่งรายการหรือหลายรายการในการดำเนินการครั้งเดียว กำหนดการที่เปิดใช้งานต่อจะเริ่มทำงานในรอบถัดไปที่กำหนดไว้
เพิกถอนการเชื่อมต่อ chain ที่มีอยู่
ย้อนกลับ charge ที่ได้รับอนุมัติล่วงหน้าเพื่อปล่อยการระงับเงินของลูกค้าโดยไม่จับยอดการชำระเงิน
ยอมรับข้อพิพาทเพื่อยอมรับการเรียกร้องของ ลูกค้า การดำเนินการนี้ไม่สามารถย้อนกลับได้และส่งผลให้จำนวนเงินที่พิพาทถูกคืนให้ลูกค้า
ยืนยันบัญชีธนาคารของ Recipient ด้วยตนเองเพื่อเปิดใช้งานการโอนเงิน
รายการ API keys สำหรับการเชื่อมต่อ chain
ดึงรายการ events แบบแบ่งหน้าสำหรับ charge เฉพาะเพื่อตรวจสอบกิจกรรม charge ดีบัก webhooks และติดตาม events ที่เกี่ยวข้องกับ charge
แสดงรายการ charge schedules ทั้งหมดสำหรับบัญชีพร้อมตัวเลือก pagination และการกรอง
ดึงรายการ charges ทั้งหมดแบบแบ่งหน้าพร้อมตัวเลือกการกรองและการเรียงลำดับ