ดึงข้อมูล Link

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

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

---

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

▼

---

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

Required - 1 fieldRequired Parameters

▼

`link_id`STRING(required)

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

Example:"link_test_5xuy4w91xqz7d1w9u0t"

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

---

การตอบกลับ

200

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

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

การตอบกลับประกอบด้วย:

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

401

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

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

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

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

404

ไม่พบ

ไม่พบ link ที่มี ID ที่ระบุ

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

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

---

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

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")

---

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

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

Code	Description	Resolution
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ของคุณถูกต้อง
not_found	ไม่พบ link	ตรวจสอบว่า link ID ถูกต้องและมีอยู่จริง
invalid_link_id	link ID ไม่ถูกต้อง	ตรวจสอบว่า ID ตรงกับรูปแบบ link(test)?[0-9a-z]+

ฟิลด์ออบเจ็กต์ Link

Field	Type	Description
object	string	ส่งคืน "link" เสมอ
id	string	ตัวระบุ link ที่ไม่ซ้ำ
livemode	boolean	ตัวบ่งชี้สภาพแวดล้อม production และ test
payment_uri	string	URL การชำระเงินที่แชร์ได้
amount	integer	มูลค่าธุรกรรมในหน่วยสกุลเงินที่เล็กที่สุด
currency	string	รหัสสกุลเงิน ISO
used	boolean	สถานะการใช้ link ใช้ครั้งเดียว
multiple	boolean	แฟล็กการใช้ซ้ำได้
title	string	หัวข้อ link
description	string	คำอธิบาย link
charges	list	ธุรกรรมการชำระเงินที่เกี่ยวข้อง
created_at	string	ประทับเวลาการสร้าง (ISO 8601)

---

ทดลองใช้งาน

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

▼

link_id(จำเป็น)