クローズ済み異議を一覧

GEThttps://api.omise.co/disputes/closed

すべてのクローズ済み異議のページ分割されたリストを取得します。クローズ済み異議には、勝訴した異議（資金が返還）と敗訴した異議（資金が没収）の両方が含まれます。

---

リクエストパラメータ

追加 - 5フィールド追加パラメータ

▼

---

レスポンス

200

取得成功

ステータスが"won"または"lost"のクローズ済み異議オブジェクトのみを含むリストオブジェクトを返します。

クローズ済み異議の特徴：

• status - "won"（加盟店が勝訴）または"lost"（加盟店が敗訴）
• closed_at - 異議が解決された時刻のISO 8601タイムスタンプ
• message - 回答メッセージ（提供された場合）
• documents - 提出された証拠書類
• 勝訴した異議：資金が加盟店アカウントに返還
• 敗訴した異議：資金が永久に顧客に没収

400

不正なリクエスト

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

一般的な原因：

• 無効な日付形式（ISO 8601である必要があります）
• limitが最大値（100）を超えている
• 無効なorderパラメータ
• 負のoffsetまたはlimit値

401

認証エラー

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

一般的な原因：

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

5xx

サーバーエラー

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

対処方法：

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

---

コードサンプル

cURL

curl https://api.omise.co/disputes/closed \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "limit=20" \
  -d "offset=0"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

disputes = Omise::Dispute.list_closed({
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

disputes = omise.Dispute.list_closed(
    limit=20,
    offset=0
)

Node.js

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

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

PHP

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

$disputes = OmiseDispute::retrieve('/disputes/closed', [
    'limit' => 20,
    'offset' => 0
]);

Java

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

ScopedList<Dispute> disputes = client.disputes().listClosed()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var disputes = await client.Disputes.GetClosedList(new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

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

disputes, _ := client.ListClosedDisputes(&operations.ListDisputes{
    Limit:  20,
    Offset: 0,
})

---

エラーコードと結果コード

一般的なエラーコード

コード	説明	解決方法
bad_request	無効なパラメータ	日付形式とパラメータ値を確認
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認
invalid_date_format	日付がISO 8601形式ではない	YYYY-MM-DDTHH:MM:SSZ形式を使用

クローズ済み異議のステータス値

ステータス	説明	財務的影響
won	加盟店が異議に勝訴	資金が加盟店アカウントに返還
lost	加盟店が異議に敗訴	資金が永久に顧客に没収

---

🔑API認証情報

▼

試してみる

追加 - 5項目

▼

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