ドキュメントの削除

DELETEhttps://api.omise.co/disputes/:id/documents/:document_id

紛争からドキュメントを削除します。このアクションは、以前にアップロードされた証拠ファイルを削除します。ドキュメントは紛争がまだオープンの間のみ削除できます。

---

リクエストパラメータ

必須 - 2項目必須パラメータ

▼

`id`STRING(required)

紛争ID（パスパラメータ）。ドキュメントの削除を許可するには、紛争のステータスが"open"である必要があります。

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

`document_id`STRING(required)

削除するドキュメントID（パスパラメータ）。形式：docu_test_ または docu_live_ の後に英数字。

Example:"docu_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

削除成功

ドキュメントが正常に削除されました。deletedがtrueに設定された削除済みドキュメントオブジェクトを返します。

レスポンスに含まれる項目：

• object - 常に "document"
• id - ドキュメントID (docu_*)
• livemode - 本番モードのドキュメントだったかどうか
• location - ドキュメントへのAPIパス
• deleted - 削除成功を示すtrueに設定

削除後：

• ドキュメントは紛争から完全に削除されます
• ダウンロードURLは機能しなくなります
• このアクションは元に戻せません - 必要な場合は再アップロードが必要です

400

不正なリクエスト

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

一般的な原因：

• 無効な紛争ID形式
• 無効なドキュメントID形式

401

認証エラー

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

一般的な原因：

• Authorizationヘッダーがありません
• 無効なシークレットキー
• シークレットキーの代わりに公開キーを使用している
• HTTP Basic Authの形式が正しくない

404

見つかりません

紛争またはドキュメントが見つかりません。

一般的な原因：

• 紛争IDが正しくない
• ドキュメントIDが正しくない
• ドキュメントがこの紛争に属していない
• ドキュメントは既に削除されている
• 紛争またはドキュメントが別のアカウントに属している

422

処理不能なエンティティ

ドキュメントを削除できません。

一般的な原因：

• 紛争のステータスが"open"ではない（すでにpending、won、またはlost）
• 紛争がクローズしている - ドキュメントは変更できません
• ドキュメントは既に銀行に提出されてレビュー中

5xx

サーバーエラー

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

対処方法：

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

---

コードサンプル

cURL

curl https://api.omise.co/disputes/dspt_test_5xuy4w91xqz7d1w9u0t/documents/docu_test_5xuy4w91xqz7d1w9u0t \
  -X DELETE \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

document = Omise::Document.destroy(
  'dspt_test_5xuy4w91xqz7d1w9u0t',
  'docu_test_5xuy4w91xqz7d1w9u0t'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

document = omise.Document.destroy(
    'dspt_test_5xuy4w91xqz7d1w9u0t',
    'docu_test_5xuy4w91xqz7d1w9u0t'
)

Node.js

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

const document = await omise.documents.destroy(
  'dspt_test_5xuy4w91xqz7d1w9u0t',
  'docu_test_5xuy4w91xqz7d1w9u0t'
);

PHP

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

$document = OmiseDocument::destroy(
    'dspt_test_5xuy4w91xqz7d1w9u0t',
    'docu_test_5xuy4w91xqz7d1w9u0t'
);

Java

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

Document document = client.documents().destroy(
    "dspt_test_5xuy4w91xqz7d1w9u0t",
    "docu_test_5xuy4w91xqz7d1w9u0t"
);

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var document = await client.Documents.Destroy(
    "dspt_test_5xuy4w91xqz7d1w9u0t",
    "docu_test_5xuy4w91xqz7d1w9u0t"
);

Go

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

document, _ := client.Document.Destroy(
    "dspt_test_5xuy4w91xqz7d1w9u0t",
    "docu_test_5xuy4w91xqz7d1w9u0t",
)

---

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

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認してください
not_found	紛争またはドキュメントが見つかりません	紛争IDとドキュメントIDが正しいことを確認してください
dispute_not_open	紛争がopenではありません	ドキュメントはopen状態の紛争からのみ削除できます
document_already_submitted	ドキュメントは既に銀行に送信されています	レビュー中のドキュメントは削除できません

重要な注意事項

注意事項	説明
タイミング	ドキュメントは紛争が"open"の間のみ削除できます
永続性	削除は永続的で元に戻せません
再アップロード	ドキュメントを置き換えるには、まず削除してから新しいバージョンをアップロードします
保留中の紛争	紛争がpendingになると、ドキュメントは変更できません

---

🔑API認証情報

▼

試してみる

必須 - 2項目

▼

id(必須)

document_id(必須)

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