チャージの返金一覧

GEThttps://api.omise.co/charges/:id/refunds

特定のチャージのすべての返金を一覧表示します。作成日でソートされた返金をページネーション機能付きで返します。

---

リクエストパラメータ

必須 - 1項目必須パラメータ

▼

`id`STRING(required)

返金を取得するチャージID。アカウントの有効なチャージIDである必要があります。

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:chrg_で始まる必要があります, テストチャージ: chrg_test_, 本番チャージ: chrg_live_

推奨 - 3項目推奨パラメータ

▼

`limit`INTEGER(optional)

1ページあたりに返す返金の数。

Example:20

Constraints:最小値: 1, 最大値: 100

Default:20

`offset`INTEGER(optional)

ページネーションのためにスキップする返金の数。limitと組み合わせてページを移動します。

Example:0

Default:0

`order`STRING(optional)

作成日によるソート順。

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

追加 - 2項目追加パラメータ

▼

---

レスポンス

200

一覧取得成功

返金データ配列とページネーションメタデータを含むリストオブジェクトを返します。

レスポンス内容:

• data - 返金オブジェクトの配列
• total - このチャージの返金の総数
• limit - 1ページあたりの項目数
• offset - 現在のページネーションオフセット
• order - 適用されたソート順
• from / to - 適用された日付範囲

400

不正なリクエスト

無効なパラメータが指定されました。

一般的な原因:

• 無効な日付形式（ISO 8601である必要があります）
• limitが範囲外（1-100である必要があります）
• 無効なoffset値

401

認証エラー

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

一般的な原因:

• Authorizationヘッダーの欠落
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用

404

見つかりません

チャージIDが存在しません。

一般的な原因:

• 不正なチャージID
• 別のアカウントのチャージ
• 本番チャージにテストキーを使用（またはその逆）

5xx

サーバーエラー

サーバー側でエラーが発生しました。まれですが、適切に処理してください。

対処方法:

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

---

コードサンプル

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = Omise::Charge.retrieve('chrg_test_5xuy4w91xqz7d1w9u0t')
refunds = charge.refunds(limit: 20, offset: 0)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = omise.Charge.retrieve('chrg_test_5xuy4w91xqz7d1w9u0t')
refunds = charge.refunds(limit=20, offset=0)

Node.js

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

const refunds = await omise.charges.listRefunds('chrg_test_5xuy4w91xqz7d1w9u0t', {
  limit: 20,
  offset: 0
});

PHP

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

$charge = OmiseCharge::retrieve('chrg_test_5xuy4w91xqz7d1w9u0t');
$refunds = $charge->refunds(array(
    'limit' => 20,
    'offset' => 0
));

Java

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

ScopedList<Refund> refunds = client.charges()
    .get("chrg_test_5xuy4w91xqz7d1w9u0t")
    .refunds()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var refunds = await client.Charges.ListRefunds("chrg_test_5xuy4w91xqz7d1w9u0t", new ListOptions {
    Limit = 20,
    Offset = 0
});

Go

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

refunds, _ := client.ListChargeRefunds("chrg_test_5xuy4w91xqz7d1w9u0t", &operations.ListChargeRefunds{
    List: operations.List{
        Limit:  20,
        Offset: 0,
    },
})

---

エラーと結果コード

返金ステータス値

ステータス	説明	次のステップ
pending	返金処理中	完了を待つ
closed	返金が正常に完了	資金が顧客に返還済み
failed	返金失敗	失敗理由を確認

ページネーション計算

フィールド	計算	用途
次のページ	offset + limit	次の結果セットを取得
前のページ	offset - limit（最小0）	前のページに戻る
さらにあるか	offset + limit < total	さらにページがあるか確認
ページ番号	(offset / limit) + 1	現在のページ番号

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

推奨 - 3項目

▼

追加 - 2項目

▼

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