異議を取得

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

ステータス、理由コード、証拠書類、関連する請求を含む特定の異議の詳細情報を取得します。

---

リクエストパラメータ

必須 - 1フィールド必須パラメータ

▼

`id`STRING(required)

取得する異議ID（パスパラメータ）。形式：dspt_test_またはdspt_live_に続く英数字文字列。

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

取得成功

ステータス、書類、取引情報を含む完全な詳細を持つ異議オブジェクトを返します。

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

• id - 異議ID
• status - 現在のステータス（open、pending、won、lost）
• amount - 最小通貨単位での異議金額
• currency - 3文字のISO通貨コード
• reason_code - 異議の理由（fraudulent、unrecognizedなど）
• reason_message - 人間が読める理由の説明
• charge - 関連する請求ID
• message - 回答メッセージ（提供された場合）
• documents - アップロードされた証拠書類のリスト
• created_at - 異議が作成された日時
• closed_at - 異議がクローズされた日時（open/pendingの場合はnull）

401

認証エラー

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

一般的な原因：

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

404

見つかりません

異議が見つかりません。

一般的な原因：

• 異議IDが正しくない
• 異議が別のアカウントに属している
• IDのタイプミスまたはフォーマットエラー

5xx

サーバーエラー

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

対処方法：

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

---

コードサンプル

cURL

curl https://api.omise.co/disputes/dspt_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

dispute = Omise::Dispute.retrieve('dspt_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

dispute = omise.Dispute.retrieve('dspt_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const dispute = await omise.disputes.retrieve('dspt_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$dispute = OmiseDispute::retrieve('dspt_test_5xuy4w91xqz7d1w9u0t');

Java

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

Dispute dispute = client.disputes().get("dspt_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var dispute = await client.Disputes.Get("dspt_test_5xuy4w91xqz7d1w9u0t");

Go

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

dispute, _ := client.GetDispute("dspt_test_5xuy4w91xqz7d1w9u0t")

---

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

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認
not_found	異議が見つからない	異議IDが正しいことを確認
invalid_dispute_id	異議ID形式が無効	有効なdspt_形式を使用

異議のステータス値

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

理由コード

コード	説明
fraudulent	顧客が不正取引を主張
unrecognized	顧客が請求を認識していない
duplicate	顧客が重複請求を主張
goods_or_services_not_provided	商品/サービスを受け取っていない
not_as_described	商品が説明と大きく異なる
credit_not_processed	約束された返金を受け取っていない
general	その他の理由

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

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