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

ดึงข้อมูลลูกค้า

ดึงข้อมูลทั้งหมดเกี่ยวกับลูกค้า รวมถึงบัตรที่บันทึก, อีเมล, คำอธิบาย และ metadata


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

จำเป็น - 1 ฟิลด์พารามิเตอร์ที่จำเป็น
`id`STRING(required)
Customer ID ที่ต้องการดึงข้อมูล (ต้องขึ้นต้นด้วย cust_)
Example:"cust_test_5xuy4w91xqz7d1w9u0t"
Constraints:ต้องเป็น customer ID ที่ถูกต้อง

การตอบกลับ

200

ดึงข้อมูลลูกค้าสำเร็จ

ส่งคืน customer object พร้อมรายละเอียดทั้งหมดรวมถึงบัตรที่บันทึก

Customer object ประกอบด้วย:
  • id - Customer ID
  • email - ที่อยู่อีเมลลูกค้า
  • description - ชื่อหรือคำอธิบายลูกค้า
  • default_card - ID ของบัตรชำระเงินเริ่มต้น
  • cards - List object ที่มีบัตรที่บันทึกทั้งหมด
  • metadata - ข้อมูล key-value ที่กำหนดเอง
  • created_at - เวลาสร้าง (ISO 8601)

401

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

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

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

404

ไม่พบ

ไม่พบ Customer ID

สาเหตุทั่วไป:
  • Customer ID ไม่มีอยู่
  • ลูกค้าถูกลบไปแล้ว
  • รูปแบบ customer ID ไม่ถูกต้อง

5xx

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

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

วิธีจัดการ:

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

curl https://api.omise.co/customers/cust_test_5xuy4w91xqz7d1w9u0t \
-u skey_test_5xuy4w91xqz7d1w9u0t:

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

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

รหัสคำอธิบายวิธีแก้ไข
authentication_failureAPI key ไม่ถูกต้องตรวจสอบว่า secret key ถูกต้อง
not_foundไม่พบลูกค้าตรวจสอบว่า customer ID มีอยู่
bad_requestรูปแบบ customer ID ไม่ถูกต้องตรวจสอบ ID ขึ้นต้นด้วย cust_

ฟิลด์การตอบกลับ Customer

ฟิลด์คำอธิบาย
idCustomer ID (cust_*)
emailที่อยู่อีเมลลูกค้า
descriptionชื่อหรือคำอธิบายลูกค้า
default_cardID ของบัตรชำระเงินเริ่มต้น
cardsList object ที่มีบัตรที่บันทึกทั้งหมด
cards.dataArray ของ card objects
cards.totalจำนวนบัตรที่บันทึกทั้งหมด
metadataข้อมูล key-value ที่กำหนดเอง
created_atเวลาสร้างลูกค้า

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

ลองใช้งาน

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