すべての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
• secret keyの代わりにpublic 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,
    },
})

---

エラーと結果コード

一般的な使用パターン

Pattern	Description	Example
基本的なページネーション	ページを順次取得します	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

ページネーション計算

Field	Calculation	Use
次のページ	offset + limit	次の結果セットを取得します
前のページ	offset - limit（最小0）	前のページに戻ります
さらにあるか	offset + limit < total	さらにページが存在するか確認します
ページ番号	(offset / limit) + 1	現在のページ番号

---

試してみる

推奨 - 3項目

▼

追加 - 3項目

▼