Disputeの取得

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

ステータス、理由コード、evidence書類、関連する課金を含む、特定のdisputeの詳細情報を取得します。

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

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

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

取得成功

ステータス、書類、トランザクション情報を含む完全な詳細を持つdisputeオブジェクトを返します。

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

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

401

認証されていません

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

よくある原因:

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

404

見つかりません

Disputeが見つかりません。

よくある原因:

• dispute IDが正しくありません
• disputeが別のアカウントに属しています
• IDのタイプミスまたは形式エラー

---

Code samples

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")

---

Error and result codes

一般的なエラーコード

Code	Description	Resolution
authentication_failure	無効なAPI key	secret keyが正しいことを確認してください
not_found	Disputeが見つかりません	dispute IDが正しいことを確認してください
invalid_dispute_id	Dispute IDの形式が無効です	有効なdspt_形式を使用してください

Disputeのステータス値

Status	Description
open	新規に開始され、応答を待っています
pending	加盟店の応答が提出され、審査中です
won	加盟店が勝訴したdispute
lost	加盟店が敗訴したdispute

理由コード

Code	Description
fraudulent	顧客が不正な取引であると主張しています
unrecognized	顧客が課金を認識していません
duplicate	顧客が重複課金を主張しています
goods_or_services_not_provided	商品/サービスが受領されていません
not_as_described	商品が説明と大きく異なります
credit_not_processed	返金が約束されたが受領されていません
general	その他の理由

---

Try it out

必須 - 1項目

▼

id(必須)