すべての異議を一覧

GEThttps://api.omise.co/disputes

アカウント内のすべての異議（open、pending、won、lostを含む）のページ分割されたリストを取得します。

---

リクエストパラメータ

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

▼

---

レスポンス

200

取得成功

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

レスポンスに含まれるもの：

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

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

---

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

一般的なエラーコード

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

異議のステータス値

ステータス	説明
open	新しく開始、対応待ち
pending	加盟店の回答が提出され、審査中
won	加盟店が異議に勝訴
lost	加盟店が異議に敗訴

---

🔑API認証情報

▼

試してみる

追加 - 5項目

▼

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