クローズされたDisputeのリスト取得

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

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

---

🔑API認証情報

▼

---

リクエストパラメータ

Additional - 5 fieldsAdditional Parameters

▼

---

レスポンス

200

取得成功

ステータスが「won」または「lost」のクローズされたdisputeオブジェクトのみを含むリストオブジェクトを返します。

クローズされたdisputeの特徴:

• status - 「won」（加盟店勝訴）または「lost」（加盟店敗訴）のいずれか
• closed_at - disputeが解決された時のISO 8601タイムスタンプ
• message - 提供された応答メッセージ（提供された場合）
• documents - 提出されたevidence書類
• 勝訴したdispute: 資金は加盟店アカウントに返還されます
• 敗訴したdispute: 資金は顧客に永久的に没収されます

400

不正なリクエスト

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

よくある原因:

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

401

認証されていません

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

よくある原因:

• Authorizationヘッダーが欠落しています
• 無効なsecret key
• secret keyの代わりにpublic keyを使用しています
• HTTP Basic Auth形式が正しくありません

---

Code samples

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

---

Error and result codes

一般的なエラーコード

Code	Description	Resolution
bad_request	無効なパラメータ	日付形式とパラメータ値を確認してください
authentication_failure	無効なAPI key	secret keyが正しいことを確認してください
invalid_date_format	ISO 8601形式ではない日付	YYYY-MM-DDTHH:MM:SSZ形式を使用してください

クローズされたDisputeのステータス値

Status	Description	Financial Impact
won	加盟店が勝訴したdispute	資金は加盟店アカウントに返還されます
lost	加盟店が敗訴したdispute	資金は顧客に永久的に没収されます

---

Try it out

追加 - 5項目

▼