不審請求の書類を削除

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_*)
• deleted - 削除成功を示す true
• livemode - 本番モードの書類かどうか

削除後:

• 書類は不審請求から永久に削除されます
• ダウンロード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::Dispute.delete_document(
  'dspt_test_5xuy4w91xqz7d1w9u0t',
  'docu_test_5xuy4w91xqz7d1w9u0t'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

document = omise.Dispute.delete_document(
    'dspt_test_5xuy4w91xqz7d1w9u0t',
    'docu_test_5xuy4w91xqz7d1w9u0t'
)

Node.js

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

const document = await omise.disputes.deleteDocument(
  'dspt_test_5xuy4w91xqz7d1w9u0t',
  'docu_test_5xuy4w91xqz7d1w9u0t'
);

PHP

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

$document = OmiseDispute::deleteDocument(
    'dspt_test_5xuy4w91xqz7d1w9u0t',
    'docu_test_5xuy4w91xqz7d1w9u0t'
);

Java

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

Document document = client.disputes().deleteDocument(
    "dspt_test_5xuy4w91xqz7d1w9u0t",
    "docu_test_5xuy4w91xqz7d1w9u0t"
);

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var document = await client.Disputes.DeleteDocument(
    "dspt_test_5xuy4w91xqz7d1w9u0t",
    "docu_test_5xuy4w91xqz7d1w9u0t"
);

Go

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

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

---

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

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認してください
not_found	不審請求または書類が見つかりません	不審請求IDと書類IDの両方が正しいことを確認してください
dispute_not_open	不審請求がオープンではありません	書類はオープンな不審請求からのみ削除できます
document_already_submitted	書類は既に銀行に送信済み	審査中の書類は削除できません

書類を削除すべきケース

以下の場合に書類の削除を検討してください:

• 誤ったファイルをアップロードした（間違った書類）
• ファイルに誤った情報や古い情報が含まれている
• 重複した書類をアップロードした
• より高品質のバージョンに置き換える場合（最初に削除してから再アップロード）

重要な注意事項

注意事項	説明
タイミング	書類は不審請求が「open」の間のみ削除可能
永続性	削除は永続的で取り消すことはできません
再アップロード	書類を置き換えるには、最初に削除してから新しいバージョンをアップロード
pending状態の不審請求	不審請求がpendingになると、書類は変更できません

---

🔑API認証情報

▼

試してみる

必須 - 2項目

▼

id(必須)

document_id(必須)

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