แสดงรายการ Charges ของ Link

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

ดึงรายการ charges ทั้งหมดที่สร้างจากลิงก์ชำระเงินเฉพาะแบบแบ่งหน้า มีประโยชน์สำหรับติดตามการชำระเงินที่ทำผ่านลิงก์เฉพาะ

---

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

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

▼

`link_id`STRING(required)

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

Example:"link_test_5xuy4w91xqz7d1w9u0t"

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

การแบ่งหน้า - 5 ฟิลด์พารามิเตอร์การแบ่งหน้า

▼

---

การตอบกลับ

200

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

ดึงรายการ charges สำเร็จ ส่งคืนรายการออบเจกต์ charge แบบแบ่งหน้า

โครงสร้าง Response:

• object - ส่งคืน "list" เสมอ
• data - อาร์เรย์ของออบเจกต์ charge ที่เกี่ยวข้องกับลิงก์
• limit - จำนวนรายการต่อหน้า
• offset - จำนวนรายการที่ถูกข้าม
• total - จำนวน charges ทั้งหมดสำหรับลิงก์นี้
• order - ลำดับการเรียงที่ใช้
• from - ตัวกรองวันที่เริ่มต้นที่ใช้
• to - ตัวกรองวันที่สิ้นสุดที่ใช้

400

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

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

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

• รูปแบบวันที่ไม่ถูกต้อง (ต้องเป็น ISO 8601)
• ค่า limit ไม่ถูกต้อง (เกินค่าสูงสุด)
• ค่า order ไม่ถูกต้อง
• พารามิเตอร์ไม่ถูกต้อง

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/charges \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d "limit=20" \
  -d "offset=0" \
  -d "order=reverse_chronological"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

link = Omise::Link.retrieve('link_test_5xuy4w91xqz7d1w9u0t')
charges = link.charges(
  limit: 20,
  offset: 0,
  order: 'reverse_chronological'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

link = omise.Link.retrieve('link_test_5xuy4w91xqz7d1w9u0t')
charges = link.charges(
    limit=20,
    offset=0,
    order='reverse_chronological'
)

Node.js

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

const charges = await omise.links.listCharges('link_test_5xuy4w91xqz7d1w9u0t', {
  limit: 20,
  offset: 0,
  order: 'reverse_chronological'
});

PHP

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

$link = OmiseLink::retrieve('link_test_5xuy4w91xqz7d1w9u0t');
$charges = $link->charges([
    'limit' => 20,
    'offset' => 0,
    'order' => 'reverse_chronological'
]);

Java

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

ScopedList<Charge> charges = client.links()
    .get("link_test_5xuy4w91xqz7d1w9u0t")
    .charges()
    .list()
    .limit(20)
    .offset(0)
    .order(Ordering.ReverseChronological)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var charges = await client.Links.ListCharges("link_test_5xuy4w91xqz7d1w9u0t", new ListOptions
{
    Limit = 20,
    Offset = 0,
    Order = ListOrder.ReverseChronological
});

Go

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

charges, _ := client.Links().ListCharges("link_test_5xuy4w91xqz7d1w9u0t", &omise.ListParams{
    Limit:  20,
    Offset: 0,
    Order:  omise.ReverseChronological,
})

---

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

รหัส Error ทั่วไป

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

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

ฟิลด์	ประเภท	คำอธิบาย
object	string	ส่งคืน "charge" เสมอ
id	string	ตัวระบุ charge เฉพาะ
livemode	boolean	ตัวบ่งชี้สภาพแวดล้อม production หรือ test
amount	integer	มูลค่าธุรกรรมในหน่วยสกุลเงินที่เล็กที่สุด
currency	string	รหัสสกุลเงิน ISO
status	string	สถานะ charge (successful, failed, pending ฯลฯ)
paid	boolean	ระบุว่า charge ได้รับการชำระแล้วหรือไม่
link	string	link ID ที่เกี่ยวข้อง
created_at	string	timestamp การสร้าง (ISO 8601)

---

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

▼

ลองใช้งาน

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

▼

link_id(จำเป็น)

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

▼

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