อัปเดต Link

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

อัปเดตคุณสมบัติของลิงก์ชำระเงิน คุณสามารถแก้ไข title, description และ metadata ของลิงก์ที่มีอยู่ได้ โปรดทราบว่า amount และ currency ไม่สามารถเปลี่ยนแปลงได้หลังจากสร้างแล้ว

---

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

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

▼

`link_id`STRING(required)

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

Example:"link_test_5xuy4w91xqz7d1w9u0t"

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

อัปเดตได้ - 3 ฟิลด์พารามิเตอร์ที่อัปเดตได้

▼

`title`STRING(optional)

ชื่อลิงก์ที่แสดงให้ลูกค้าเห็นบนหน้าชำระเงิน

Example:"Updated Invoice #12345 Payment"

`description`STRING(optional)

รายละเอียดลิงก์และบริบทเพิ่มเติมที่แสดงให้ลูกค้าเห็น

Example:"Updated payment description for February 2025"

`metadata`OBJECT(optional)

คู่คีย์-ค่าที่กำหนดเอง (รวมสูงสุด 15,000 ตัวอักษร) มีประโยชน์สำหรับเก็บ order ID, การอ้างอิงลูกค้า หรือข้อมูลที่กำหนดเอง จะแทนที่ metadata ที่มีอยู่

Example:{"order_id":"1234","customer_email":"john@example.com","updated_at":"2025-02-01"}

---

การตอบกลับ

200

อัปเดตสำเร็จ

อัปเดตลิงก์สำเร็จ ส่งคืนออบเจกต์ลิงก์ที่อัปเดตแล้วอย่างสมบูรณ์

Response รวมถึง:

• id - ตัวระบุลิงก์
• title - ชื่อลิงก์ที่อัปเดต
• description - คำอธิบายลิงก์ที่อัปเดต
• metadata - ออบเจกต์ metadata ที่อัปเดต
• payment_uri - URL ที่แชร์ได้สำหรับการชำระเงินของลูกค้า (ไม่เปลี่ยนแปลง)
• amount - จำนวนเงิน (ไม่เปลี่ยนแปลง)
• currency - รหัสสกุลเงิน (ไม่เปลี่ยนแปลง)

400

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

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

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

• พยายามอัปเดตฟิลด์ที่ไม่สามารถเปลี่ยนแปลงได้ (amount, currency)
• รูปแบบ metadata ไม่ถูกต้อง
• Metadata เกินขีดจำกัดขนาด
• ประเภทข้อมูลไม่ถูกต้อง

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 PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "title=Updated Invoice #12345 Payment" \
  -d "description=Updated payment description for February 2025"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

link = Omise::Link.retrieve('link_test_5xuy4w91xqz7d1w9u0t')
link = link.update(
  title: 'Updated Invoice #12345 Payment',
  description: 'Updated payment description for February 2025'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

link = omise.Link.retrieve('link_test_5xuy4w91xqz7d1w9u0t')
link.update(
    title='Updated Invoice #12345 Payment',
    description='Updated payment description for February 2025'
)

Node.js

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

const link = await omise.links.update('link_test_5xuy4w91xqz7d1w9u0t', {
  title: 'Updated Invoice #12345 Payment',
  description: 'Updated payment description for February 2025'
});

PHP

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

$link = OmiseLink::retrieve('link_test_5xuy4w91xqz7d1w9u0t');
$link->update([
    'title' => 'Updated Invoice #12345 Payment',
    'description' => 'Updated payment description for February 2025'
]);

Java

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

Link link = client.links().update("link_test_5xuy4w91xqz7d1w9u0t")
    .title("Updated Invoice #12345 Payment")
    .description("Updated payment description for February 2025")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var link = await client.Links.Update("link_test_5xuy4w91xqz7d1w9u0t", new UpdateLinkRequest
{
    Title = "Updated Invoice #12345 Payment",
    Description = "Updated payment description for February 2025"
});

Go

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

link, _ := client.Links().Update("link_test_5xuy4w91xqz7d1w9u0t", &operations.UpdateLink{
    Title:       "Updated Invoice #12345 Payment",
    Description: "Updated payment description for February 2025",
})

---

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

รหัส Error ทั่วไป

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

ฟิลด์ที่อัปเดตได้ vs ไม่สามารถเปลี่ยนแปลงได้

ฟิลด์	อัปเดตได้	หมายเหตุ
title	ใช่	ชื่อที่แสดงสำหรับลูกค้า
description	ใช่	บริบทเพิ่มเติมสำหรับลูกค้า
metadata	ใช่	แทนที่ metadata ที่มีอยู่ทั้งหมด
amount	ไม่	ไม่สามารถเปลี่ยนแปลงได้หลังจากสร้าง
currency	ไม่	ไม่สามารถเปลี่ยนแปลงได้หลังจากสร้าง
multiple	ไม่	ไม่สามารถเปลี่ยนแปลงได้หลังจากสร้าง

---

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

▼

ลองใช้งาน

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

▼

link_id(จำเป็น)

เพิ่มเติม - 3 ฟิลด์

▼

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