Disputeの更新

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

応答メッセージとメタデータを提供して、オープンなdisputeを更新します。メッセージを提出すると、disputeのステータスがopenからpendingに変わります。

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

更新するdispute ID（パスパラメータ）。disputeのステータスは「open」である必要があります。

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

Recommended - 1 fieldRecommended Parameters

▼

Additional - 1 fieldAdditional Parameters

▼

---

レスポンス

200

更新成功

Disputeが正常に更新されました。メッセージが提供された場合、ステータスは「open」から「pending」に変わります。

更新後:

• メッセージが提供された場合：ステータスが「pending」に変わり、disputeは審査プロセスに入ります
• POST /disputes/:id/documentsを使用してサポート書類をアップロードします
• 一度pendingになると、それ以上の更新はできません
• 解決には通常60〜90日かかります

400

不正なリクエスト

リクエストの検証に失敗しました。詳細はエラーメッセージを確認してください。

よくある原因:

• 無効なメタデータ形式
• メタデータが15,000文字を超えています
• メッセージが長すぎます

401

認証されていません

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

よくある原因:

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

404

見つかりません

Disputeが見つかりません。

よくある原因:

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

422

処理できないエンティティ

Disputeを更新できません。

よくある原因:

• disputeのステータスが「open」ではありません（すでにpending、won、またはlostです）
• disputeがクローズされており、変更できません
• 更新期限が過ぎています

---

Code samples

cURL

curl https://api.omise.co/disputes/dspt_test_5xuy4w91xqz7d1w9u0t \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "message=顧客は2025年2月1日に商品を受け取りました。追跡は配達確認を示しています。" \
  -d "metadata[case_id]=CASE-12345"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

dispute = Omise::Dispute.update('dspt_test_5xuy4w91xqz7d1w9u0t', {
  message: '顧客は2025年2月1日に商品を受け取りました...',
  metadata: {
    case_id: 'CASE-12345'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

dispute = omise.Dispute.update('dspt_test_5xuy4w91xqz7d1w9u0t', {
    'message': '顧客は2025年2月1日に商品を受け取りました...',
    'metadata': {
        'case_id': 'CASE-12345'
    }
})

Node.js

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

const dispute = await omise.disputes.update('dspt_test_5xuy4w91xqz7d1w9u0t', {
  message: '顧客は2025年2月1日に商品を受け取りました...',
  metadata: {
    case_id: 'CASE-12345'
  }
});

PHP

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

$dispute = OmiseDispute::update('dspt_test_5xuy4w91xqz7d1w9u0t', [
    'message' => '顧客は2025年2月1日に商品を受け取りました...',
    'metadata' => [
        'case_id' => 'CASE-12345'
    ]
]);

Java

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

Dispute dispute = client.disputes().update("dspt_test_5xuy4w91xqz7d1w9u0t")
    .message("顧客は2025年2月1日に商品を受け取りました...")
    .metadata("case_id", "CASE-12345")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var dispute = await client.Disputes.Update("dspt_test_5xuy4w91xqz7d1w9u0t", new UpdateDisputeRequest
{
    Message = "顧客は2025年2月1日に商品を受け取りました...",
    Metadata = new Dictionary<string, object>
    {
        { "case_id", "CASE-12345" }
    }
});

Go

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

dispute, _ := client.UpdateDispute("dspt_test_5xuy4w91xqz7d1w9u0t", &operations.UpdateDispute{
    Message: "顧客は2025年2月1日に商品を受け取りました...",
    Metadata: map[string]interface{}{
        "case_id": "CASE-12345",
    },
})

---

Error and result codes

一般的なエラーコード

Code	Description	Resolution
bad_request	無効なパラメータ	メッセージとメタデータの形式を確認してください
authentication_failure	無効なAPI key	secret keyが正しいことを確認してください
not_found	Disputeが見つかりません	dispute IDが正しいことを確認してください
dispute_not_open	Disputeがopenではありません	ステータスが「open」のdisputeのみ更新できます
dispute_closed	Disputeはすでにクローズされています	クローズされたdisputeは変更できません

ステータスの遷移

Before	After	Condition
open	pending	更新でメッセージが提供されました
open	open	メタデータのみが更新され、メッセージはありません

---

Try it out

必須 - 1項目

▼

id(必須)

推奨 - 1項目

▼

追加 - 1項目

▼