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

ลบบัตร

ลบบัตรออกจากบัญชีลูกค้าอย่างถาวร การดำเนินการนี้ไม่สามารถย้อนกลับได้


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

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

จำเป็น - 2 ฟิลด์พารามิเตอร์ของเส้นทาง
`id`STRING(required)
Customer ID (ต้องเป็น Customer ID ที่ถูกต้องและขึ้นต้นด้วย cust_)
Example:"cust_test_5xuy4w91xqz7d1w9u0t"
Constraints:Must be a valid customer ID
`card_id`STRING(required)
Card ID ที่ต้องการลบ (ต้องเป็น Card ID ที่ถูกต้องและขึ้นต้นด้วย card_)
Example:"card_test_5xuy4w91xqz7d1w9u0t"
Constraints:Must be a valid card ID, Card must belong to the customer

การตอบกลับ

200

ลบบัตรสำเร็จ

บัตรถูกลบออกจากบัญชีลูกค้าอย่างถาวรแล้ว

ผลกระทบของการลบ:
  • บัตรถูกลบออกจากลูกค้าอย่างถาวร
  • ไม่สามารถเข้าถึงรายละเอียดของบัตรได้อีกต่อไป
  • ไม่สามารถใช้บัตรสำหรับการเรียกเก็บเงินในอนาคต
  • การเรียกเก็บเงินที่ผ่านมาจะยังคงอยู่ในบันทึก แต่ฟิลด์ card จะเป็น null
  • หากนี่เป็นบัตรเริ่มต้น default_card ของลูกค้าจะเป็น null
  • ไม่สามารถยกเลิกการลบได้

400

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

รูปแบบ customer ID หรือ card ID ไม่ถูกต้อง

สาเหตุทั่วไป:
  • รูปแบบ ID ไม่ถูกต้อง
  • ID ไม่ได้ขึ้นต้นด้วย cust_ หรือ card_

401

ไม่ได้รับการยืนยันตัวตน

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

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

404

ไม่พบ

ไม่พบ Customer หรือ Card

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

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

curl https://api.omise.co/customers/cust_test_5xuy4w91xqz7d1w9u0t/cards/card_test_5xuy4w91xqz7d1w9u0t \
-X DELETE \
-u skey_test_5xuy4w91xqz7d1w9u0t:

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

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

CodeDescriptionResolution
bad_requestรูปแบบ ID ไม่ถูกต้องตรวจสอบรูปแบบ customer ID และ card ID
authentication_failureAPI key ไม่ถูกต้องตรวจสอบว่า secret key ถูกต้อง
not_foundไม่พบ Customer หรือ Cardตรวจสอบว่า ID มีอยู่และบัตรเป็นของลูกค้า
conflictไม่สามารถลบบัตรที่กำลังใช้งานรอให้การเรียกเก็บเงินที่รอดำเนินการเสร็จสิ้น

การตอบกลับการลบ

FieldDescription
objectประเภทของออบเจ็กต์ (เป็น "card" เสมอ)
idID ของ Card ที่ถูกลบ
deletedค่าบูลีน (เป็น true เสมอเมื่อลบสำเร็จ)
livemodeว่าเป็นบัตรในโหมดจริงหรือไม่

ลองใช้งาน

จำเป็น - 2 ฟิลด์