リンクの課金一覧

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

特定の支払いリンクから作成されたすべての課金のページネーションされたリストを取得します。特定のリンクを通じて行われた支払いを追跡するのに便利です。

---

リクエストパラメータ

必須 - 1フィールド必須パラメータ

▼

`link_id`STRING(required)

パターン /link(_test)?_[0-9a-z]+/ に一致するリンク識別子。URLパスで指定します。

Example:"link_test_5xuy4w91xqz7d1w9u0t"

Constraints:有効なリンクIDである必要があります

ページネーション - 5フィールドページネーションパラメータ

▼

---

レスポンス

200

取得成功

課金リストが正常に取得されました。課金オブジェクトのページネーションされたリストを返します。

レスポンス構造:

• object - 常に "list" を返す
• data - リンクに関連する課金オブジェクトの配列
• limit - ページあたりのレコード数
• offset - スキップされたレコード数
• total - このリンクの課金の総数
• order - 適用されたソート順
• from - 適用された開始日フィルター
• to - 適用された終了日フィルター

400

不正なリクエスト

リクエストの検証に失敗しました。詳細はエラーメッセージを確認してください。

一般的な原因:

• 無効な日付形式（ISO 8601である必要があります）
• 無効なlimit値（最大値を超過）
• 無効なorder値
• 不正なパラメータ

401

認証エラー

認証に失敗しました。APIキーが無効または欠落しています。

一般的な原因:

• Authorizationヘッダーの欠落
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用
• 不正なHTTP Basic Auth形式

404

見つかりません

指定されたIDのリンクが見つかりません。

一般的な原因:

• 無効なリンクID形式
• リンクが存在しない
• リンクが別のアカウントに属している
• ライブリンクIDでテストキーを使用（またはその逆）

5xx

サーバーエラー

サーバー側でエラーが発生しました。これらは稀ですが、適切に処理する必要があります。

対処方法:

• 指数バックオフでリクエストを再試行
• status.omise.coでサービスインシデントを確認
• 詳細なガイダンスはエラー処理を参照

---

コードサンプル

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,
})

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認
not_found	リンクが見つかりません	リンクIDが正しく存在することを確認
invalid_link_id	不正なリンクID	IDがフォーマット link(test)?[0-9a-z]+ に一致することを確認
invalid_date_format	日付形式の検証に失敗	ISO 8601形式（YYYY-MM-DDTHH:MM:SSZ）を使用

課金オブジェクトフィールド

フィールド	型	説明
object	string	常に "charge" を返す
id	string	一意の課金識別子
livemode	boolean	本番環境かテスト環境かのインジケーター
amount	integer	最小通貨単位でのトランザクション値
currency	string	ISO通貨コード
status	string	課金ステータス（successful、failed、pending など）
paid	boolean	課金が支払われたかどうか
link	string	関連するリンクID
created_at	string	作成タイムスタンプ（ISO 8601）

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

link_id(必須)

追加 - 5項目

▼

あなたのIP: ...読み込み中...