すべてのDisputeのリスト取得

GEThttps://api.omise.co/disputes

オープン、保留中、勝訴、敗訴を含む、アカウント内のすべてのdisputeのページ分割されたリストを取得します。

---

🔑API認証情報

▼

---

リクエストパラメータ

Additional - 5 fieldsAdditional Parameters

▼

---

レスポンス

200

取得成功

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

レスポンスに含まれる内容:

• object - 常に「list」
• data - disputeオブジェクトの配列
• limit - ページごとの結果数
• offset - スキップされた結果数
• total - フィルターに一致するdisputeの総数
• from - フィルター範囲の開始日
• to - フィルター範囲の終了日
• order - 使用されたソート順

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 \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "limit=20" \
  -d "offset=0" \
  -d "order=reverse_chronological"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

disputes = Omise::Dispute.list({
  limit: 20,
  offset: 0,
  order: 'reverse_chronological'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

disputes = omise.Dispute.list(
    limit=20,
    offset=0,
    order='reverse_chronological'
)

Node.js

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

const disputes = await omise.disputes.list({
  limit: 20,
  offset: 0,
  order: 'reverse_chronological'
});

PHP

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

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

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

disputes, _ := client.ListDisputes(&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
open	新規に開始され、応答を待っています
pending	加盟店の応答が提出され、審査中です
won	加盟店が勝訴したdispute
lost	加盟店が敗訴したdispute

---

Try it out

追加 - 5項目

▼