オープンなDisputeのリスト取得

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

応答が必要なオープンなdisputeのページ分割されたリストを取得します。オープンなdisputeは、指定された期間内にevidenceで対応する必要があります。

---

🔑API認証情報

▼

---

リクエストパラメータ

Additional - 5 fieldsAdditional Parameters

▼

---

レスポンス

200

取得成功

ステータスが「open」のオープンなdisputeオブジェクトのみを含むリストオブジェクトを返します。

オープンなdisputeの特徴:

• status - このリスト内のdisputeは常に「open」
• closed_at - 常にnull（まだ解決されていません）
• message - 通常はnull（まだ応答が提出されていません）
• 応答期限は通常、created_atから14〜21日です

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

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

PHP

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

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

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

disputes, _ := client.ListOpenDisputes(&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のアクション

Action	Endpoint	Description
詳細を表示	GET /disputes/:id	完全なdispute情報を取得します
メッセージを更新	PATCH /disputes/:id	応答メッセージを追加します
evidenceをアップロード	POST /disputes/:id/documents	サポート書類を提出します

---

Try it out

追加 - 5項目

▼