ดึงข้อมูล Link

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

ดึงรายละเอียดของลิงก์ชำระเงินเฉพาะด้วยตัวระบุ ส่งคืนออบเจกต์ลิงก์ที่สมบูรณ์รวมถึงประวัติ charge และสถานะการใช้งาน

---

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

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

▼

`link_id`STRING(required)

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

Example:"link_test_5xuy4w91xqz7d1w9u0t"

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

---

การตอบกลับ

200

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

ดึงข้อมูลลิงก์สำเร็จ ส่งคืนออบเจกต์ลิงก์ที่สมบูรณ์พร้อมรายละเอียดทั้งหมด

Response รวมถึง:

• payment_uri - URL ที่แชร์ได้สำหรับการชำระเงินของลูกค้า
• used - ระบุว่าลิงก์ใช้ครั้งเดียวถูกใช้แล้วหรือไม่
• charges - รายการ charges ทั้งหมดที่ทำผ่านลิงก์นี้
• amount - จำนวนเงินในหน่วยสกุลเงินที่เล็กที่สุด
• currency - รหัสสกุลเงิน
• title - ชื่อลิงก์ที่แสดงให้ลูกค้าเห็น
• description - คำอธิบายและรายละเอียดลิงก์

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 \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

const link = await omise.links.retrieve('link_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$link = OmiseLink::retrieve('link_test_5xuy4w91xqz7d1w9u0t');

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var link = await client.Links.Get("link_test_5xuy4w91xqz7d1w9u0t");

Go

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

link, _ := client.Links().Get("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]+

ฟิลด์ออบเจกต์ลิงก์

ฟิลด์	ประเภท	คำอธิบาย
object	string	ส่งคืน "link" เสมอ
id	string	ตัวระบุลิงก์เฉพาะ
livemode	boolean	ตัวบ่งชี้สภาพแวดล้อม production หรือ test
location	string	เส้นทาง API เพื่อดึงออบเจกต์ลิงก์
amount	integer	มูลค่าธุรกรรมในหน่วยสกุลเงินที่เล็กที่สุด
charges	list	ธุรกรรมการชำระเงินที่เกี่ยวข้อง
currency	string	รหัสสกุลเงิน ISO 4217 สามตัวอักษร
deleted	boolean	ระบุว่าลิงก์ถูกลบหรือไม่
deleted_at	string	timestamp การลบ (ISO 8601), null หากไม่ได้ลบ
description	string	คำอธิบายลิงก์
merchant_name	string	ชื่อ sub-merchant (Payfac เท่านั้น)
merchant_uid	string	ตัวระบุ sub-merchant (Payfac เท่านั้น)
multiple	boolean	ระบุว่าลิงก์สามารถใช้ได้หลายครั้งหรือไม่
payment_uri	string	URL ชำระเงินที่แชร์ได้สำหรับลูกค้า
title	string	ชื่อลิงก์ที่แสดงให้ลูกค้าเห็น
used	boolean	ระบุว่าลิงก์ใช้ครั้งเดียวถูกใช้แล้วหรือไม่
used_at	string	timestamp การใช้งาน (ISO 8601), null หากยังไม่ได้ใช้
created_at	string	timestamp การสร้าง (ISO 8601)

---

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

▼

ลองใช้งาน

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

▼

link_id(จำเป็น)

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