แสดงรายการ Charge ทั้งหมด

GEThttps://api.omise.co/charges

ดึงข้อมูลรายการ Charge ทั้งหมดแบบแบ่งหน้า ส่งคืน Charge ที่เรียงลำดับตามวันที่สร้างพร้อมความสามารถในการกรอง

---

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

▼

---

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

แนะนำ - 3 รายการพารามิเตอร์แนะนำ

▼

`limit`INTEGER(optional)

จำนวน Charge ที่จะส่งคืนต่อหน้า

Example:20

Constraints:ต่ำสุด: 1, สูงสุด: 100

Default:20

`offset`INTEGER(optional)

จำนวน Charge ที่จะข้ามสำหรับการแบ่งหน้า ใช้ร่วมกับ limit เพื่อนำทางผ่านหน้าต่างๆ

Example:0

Default:0

`order`STRING(optional)

ลำดับการเรียงตามวันที่สร้าง

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

เพิ่มเติม - 3 รายการพารามิเตอร์เพิ่มเติม

▼

---

การตอบกลับ

200

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

ส่งคืนออบเจ็กต์รายการที่มีอาร์เรย์ข้อมูล Charge และ metadata ของการแบ่งหน้า

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

• data - อาร์เรย์ของออบเจ็กต์ Charge
• total - จำนวน Charge ทั้งหมดที่ตรงกับตัวกรอง
• limit - จำนวนรายการต่อหน้า
• offset - ตำแหน่งการแบ่งหน้าปัจจุบัน
• order - ลำดับการเรียงที่ใช้
• from / to - ช่วงวันที่ที่ใช้

400

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

พารามิเตอร์ที่ให้มาไม่ถูกต้อง

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

• รูปแบบวันที่ไม่ถูกต้อง (ต้องเป็น ISO 8601)
• limit อยู่นอกช่วง (ต้องอยู่ระหว่าง 1-100)
• รูปแบบ ID ลูกค้าไม่ถูกต้อง

401

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

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

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

• ไม่มีส่วนหัว Authorization
• secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key

---

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

cURL

curl "https://api.omise.co/charges?limit=20&offset=0" \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

charges = Omise::Charge.list(limit: 20, offset: 0)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

charges = omise.Charge.list(limit=20, offset=0)

Node.js

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

const charges = await omise.charges.list({
  limit: 20,
  offset: 0
});

PHP

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

$charges = OmiseCharge::retrieve(array(
    'limit' => 20,
    'offset' => 0
));

Java

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

ScopedList<Charge> charges = client.charges().list()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var charges = await client.Charges.GetList(new ListOptions {
    Limit = 20,
    Offset = 0
});

Go

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

charges, _ := client.ListCharges(&operations.ListCharges{
    List: operations.List{
        Limit:  20,
        Offset: 0,
    },
})

---

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

รูปแบบการใช้งานทั่วไป

รูปแบบ	คำอธิบาย	ตัวอย่าง
การแบ่งหน้าพื้นฐาน	ดึงข้อมูลหน้าตามลำดับ	limit=20&offset=0 จากนั้น offset=20 เป็นต้น
ตัวกรองช่วงวันที่	กรองตามวันที่สร้าง	from=2025-01-01T00:00:00Z&to=2025-01-31T23:59:59Z
ประวัติลูกค้า	ดึงข้อมูล Charge ทั้งหมดของลูกค้า	customer=cust_test_5xuy4w91xqz7d1w9u0t
ล่าสุดก่อน	แสดง Charge ใหม่ล่าสุดก่อน	order=reverse_chronological

การคำนวณการแบ่งหน้า

ฟิลด์	การคำนวณ	การใช้งาน
หน้าถัดไป	offset + limit	ดึงข้อมูลชุดผลลัพธ์ถัดไป
หน้าก่อนหน้า	offset - limit (ต่ำสุด 0)	กลับไปหน้าก่อนหน้า
มีเพิ่มเติม	offset + limit < total	ตรวจสอบว่ามีหน้าเพิ่มเติมหรือไม่
หมายเลขหน้า	(offset / limit) + 1	หมายเลขหน้าปัจจุบัน

---

ลองใช้งาน

แนะนำ - 3 ฟิลด์

▼

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

▼