ลบ Link

DELETEhttps://api.omise.co/links/:link_id

ลบลิงก์ชำระเงินเพื่อป้องกันการชำระเงินเพิ่มเติมผ่านลิงก์นั้น เมื่อลบแล้ว URL ชำระเงินจะไม่สามารถเข้าถึงได้สำหรับลูกค้า Charges ที่มีอยู่ที่เกี่ยวข้องกับลิงก์จะถูกเก็บรักษาไว้

---

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

จำเป็น - 1 ฟิลด์พารามิเตอร์ที่จำเป็น

▼

`link_id`STRING(required)

ตัวระบุลิงก์ที่ตรงกับรูปแบบ /link(_test)?_[0-9a-z]+/ ระบุใน URL path

Example:"link_test_5xuy4w91xqz7d1w9u0t"

Constraints:ต้องเป็น link ID ที่ถูกต้อง

---

การตอบกลับ

200

ลบสำเร็จ

ลบลิงก์สำเร็จ ส่งคืนออบเจกต์ลิงก์ที่ถูกลบพร้อมแฟล็ก deleted เป็น true

Response รวมถึง:

• object - ส่งคืน "link" เสมอ
• id - ตัวระบุของลิงก์ที่ถูกลบ
• deleted - ตั้งค่าเป็น true แสดงว่าลบสำเร็จ
• livemode - ตัวบ่งชี้สภาพแวดล้อม production หรือ test

400

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

การตรวจสอบคำขอล้มเหลว ตรวจสอบข้อความ error สำหรับรายละเอียด

สาเหตุทั่วไป:

• ลิงก์ถูกลบไปแล้ว
• ลิงก์ไม่สามารถลบได้เนื่องจากมีการดำเนินการที่รอดำเนินการ
• รูปแบบคำขอไม่ถูกต้อง

401

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

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

สาเหตุทั่วไป:

• ขาด Authorization header
• Secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

404

ไม่พบ

ไม่พบลิงก์ด้วย ID ที่ระบุ

สาเหตุทั่วไป:

• รูปแบบ link ID ไม่ถูกต้อง
• ลิงก์ไม่มีอยู่
• ลิงก์เป็นของบัญชีอื่น
• ใช้ test key กับ live link ID (หรือกลับกัน)
• ลิงก์ถูกลบไปแล้ว

5xx

เซิร์ฟเวอร์ error

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

วิธีจัดการ:

• ลองส่งคำขอใหม่ด้วย exponential backoff
• ตรวจสอบ status.omise.co สำหรับเหตุการณ์บริการ
• ดู การจัดการ Error สำหรับคำแนะนำโดยละเอียด

---

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

cURL

curl https://api.omise.co/links/link_test_5xuy4w91xqz7d1w9u0t \
  -X DELETE \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

link = Omise::Link.retrieve('link_test_5xuy4w91xqz7d1w9u0t')
link.destroy

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

link = omise.Link.retrieve('link_test_5xuy4w91xqz7d1w9u0t')
link.destroy()

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const result = await omise.links.destroy('link_test_5xuy4w91xqz7d1w9u0t');

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$link = OmiseLink::retrieve('link_test_5xuy4w91xqz7d1w9u0t');
$link->destroy();

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Link link = client.links().destroy("link_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var result = await client.Links.Destroy("link_test_5xuy4w91xqz7d1w9u0t");

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

link, _ := client.Links().Destroy("link_test_5xuy4w91xqz7d1w9u0t")

---

รหัส Error และผลลัพธ์

รหัส Error ทั่วไป

รหัส	คำอธิบาย	วิธีแก้ไข
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง
not_found	ไม่พบลิงก์	ตรวจสอบว่า link ID ถูกต้องและมีอยู่
invalid_link_id	link ID ไม่ถูกต้อง	ตรวจสอบให้แน่ใจว่า ID ตรงกับรูปแบบ link(test)?[0-9a-z]+
already_deleted	ลิงก์ถูกลบไปแล้ว	ลิงก์ถูกลบก่อนหน้านี้แล้ว

หมายเหตุสำคัญ

หัวข้อ	คำอธิบาย
การลบเป็นแบบถาวร	เมื่อลบแล้ว ลิงก์ไม่สามารถกู้คืนได้
Charges ยังคงอยู่	Charges ที่มีอยู่ที่ทำผ่านลิงก์ยังคงอยู่ในบัญชีของคุณ
URL ชำระเงินถูกปิดใช้งาน	ลูกค้าไม่สามารถเข้าถึงหน้าชำระเงินได้อีกต่อไป
Webhooks	Event link.deleted จะถูกส่งเมื่อลบ

---

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

▼

ลองใช้งาน

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

▼

link_id(จำเป็น)

IP ของคุณ: ...กำลังโหลด...