ข้ามไปยังเนื้อหาหลัก
เวอร์ชัน: ล่าสุด

สร้าง Linked Account

สร้าง linked account ใหม่เพื่อเริ่มการลงทะเบียนวิธีการชำระเงิน การตอบกลับจะรวม registration_uri ที่เจ้าของบัญชีสามารถดำเนินการลงทะเบียนให้เสร็จสมบูรณ์ได้


พารามิเตอร์คำขอ

จำเป็น - 2 ฟิลด์พารามิเตอร์จำเป็น
`type`STRING(required)
ประเภทของ linked account ประเภทที่ใช้ได้ขึ้นอยู่กับวิธีการชำระเงิน (เช่น direct_debit_kbank, direct_debit_scb, direct_debit_bbl สำหรับธนาคารไทย)
Example:"direct_debit_kbank"
`return_uri`STRING(required)
URI สำหรับ redirect เจ้าของบัญชีหลังจากดำเนินการลงทะเบียนเสร็จสิ้น
Example:"https://example.com/linked-accounts/complete"
เพิ่มเติม - 2 ฟิลด์พารามิเตอร์เพิ่มเติม

การตอบกลับ

200

สร้าง linked account สำเร็จ

สร้าง Linked account แล้ว Redirect เจ้าของบัญชีไปยัง registration_uri เพื่อดำเนินการลงทะเบียนให้เสร็จสิ้น

ฟิลด์อ็อบเจกต์ linked account:
  • object - เป็น "linked_account" เสมอ
  • id - Linked account ID (lacct_*) เก็บไว้ในฐานข้อมูลของคุณ
  • livemode - เป็น linked account โหมด live หรือ test
  • status - สถานะบัญชี: failed, expired, pending, successful หรือ deleted
  • type - ประเภทของ linked account
  • last_digits - ตัวเลขท้ายของ linked account identifier (ถ้ามี)
  • registration_uri - URI ที่เจ้าของบัญชีดำเนินการลงทะเบียนให้เสร็จสิ้น
  • return_uri - URI สำหรับ redirect หลังลงทะเบียน
  • expires_at - เวลาหมดอายุของลิงก์ลงทะเบียน
  • created_at - timestamp การสร้าง linked account
  • registered_at - เวลาที่ลงทะเบียนเสร็จสิ้น (null ถ้ายังรอดำเนินการ)
  • failure_code - รหัสข้อผิดพลาดถ้าลงทะเบียนล้มเหลว (null ถ้าไม่ล้มเหลว)
  • failure_message - ข้อความข้อผิดพลาดถ้าลงทะเบียนล้มเหลว (null ถ้าไม่ล้มเหลว)
  • metadata - ข้อมูลคีย์-ค่าที่กำหนดเอง

400

คำขอไม่ถูกต้อง

การตรวจสอบคำขอล้มเหลว ตรวจสอบข้อความแสดงข้อผิดพลาดสำหรับรายละเอียด

สาเหตุทั่วไป:
  • ไม่มีพารามิเตอร์จำเป็น (type หรือ return_uri)
  • ค่า type ไม่ถูกต้อง
  • รูปแบบ return_uri ไม่ถูกต้อง
  • รูปแบบ citizen_id ไม่ถูกต้อง
  • Metadata เกิน 15,000 ตัวอักษร

401

ไม่ได้รับอนุญาต

การยืนยันตัวตนล้มเหลว API key ไม่ถูกต้องหรือไม่มี

สาเหตุทั่วไป:
  • ไม่มี Authorization header
  • Secret key ไม่ถูกต้อง
  • ใช้ public key แทน secret key
  • รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

422

ไม่สามารถประมวลผลได้

คำขอถูกต้องแต่ไม่สามารถประมวลผลได้

สาเหตุทั่วไป:
  • ประเภท linked account ไม่ได้เปิดใช้งานสำหรับบัญชีของคุณ
  • ถึงขีดจำกัดบัญชี
  • วิธีการชำระเงินไม่มีในภูมิภาคของคุณ

5xx

ข้อผิดพลาดเซิร์ฟเวอร์

เกิดข้อผิดพลาดฝั่งเซิร์ฟเวอร์ เหตุการณ์เหล่านี้หายากแต่ควรจัดการอย่างเหมาะสม

วิธีจัดการ:

ตัวอย่างโค้ด

curl https://api.omise.co/linked_accounts \
-u skey_test_5xuy4w91xqz7d1w9u0t: \
-d "type=direct_debit_kbank" \
-d "return_uri=https://example.com/linked-accounts/complete"

รหัสข้อผิดพลาดและผลลัพธ์

รหัสข้อผิดพลาดทั่วไป

รหัสคำอธิบายวิธีแก้ไข
bad_requestพารามิเตอร์ขาดหายหรือไม่ถูกต้องตรวจสอบว่า type และ return_uri ถูกต้อง
authentication_failureAPI key ไม่ถูกต้องตรวจสอบ secret key ของคุณ
invalid_linked_account_typeไม่รองรับประเภทตรวจสอบประเภท linked account ที่มี
not_enabledฟีเจอร์ไม่ได้เปิดใช้งานติดต่อฝ่ายสนับสนุนเพื่อเปิดใช้งาน linked accounts

ค่าสถานะ Linked Account

สถานะคำอธิบาย
pendingกำลังดำเนินการลงทะเบียน รอดำเนินการให้เสร็จสิ้น
successfulลงทะเบียนสำเร็จ
failedลงทะเบียนล้มเหลว (ตรวจสอบ failure_code และ failure_message)
expiredลิงก์ลงทะเบียนหมดอายุก่อนดำเนินการเสร็จสิ้น
deletedLinked account ถูกลบแล้ว

ฟิลด์ Linked Account

ฟิลด์คำอธิบาย
idLinked account ID (เก็บไว้ในฐานข้อมูลของคุณ)
typeประเภทของ linked account
statusสถานะปัจจุบันของ linked account
registration_uriURL สำหรับเจ้าของบัญชีดำเนินการลงทะเบียนให้เสร็จสิ้น
return_uriURL redirect หลังลงทะเบียน
last_digitsตัวเลขท้ายของ account identifier
expires_atเวลาหมดอายุของลิงก์ลงทะเบียน
registered_atเวลาที่ลงทะเบียนเสร็จสิ้น
failure_codeรหัสข้อผิดพลาดถ้าลงทะเบียนล้มเหลว
failure_messageข้อความข้อผิดพลาดที่อ่านได้
metadataข้อมูลคีย์-ค่าที่กำหนดเอง
created_attimestamp การสร้าง linked account

🔑ข้อมูลยืนยันตัวตน API

ทดลองใช้งาน

จำเป็น - 2 ฟิลด์
เพิ่มเติม - 2 ฟิลด์
IP ของคุณ: ...กำลังโหลด...