不審請求の書類を取得

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

不審請求から特定の書類を取得します。このエンドポイントは、ファイルにアクセスするためのダウンロードURLを含む証拠ファイルの詳細情報を返します。

---

リクエストパラメータ

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

▼

`id`STRING(required)

不審請求ID（パスパラメータ）。

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

`document_id`STRING(required)

取得する書類ID（パスパラメータ）。形式: docu_test_ または docu_live_ の後に英数字文字列。

Example:"docu_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

取得成功

ダウンロードURLを含む完全な詳細情報を持つ書類オブジェクトを返します。

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

• object - 常に "document"
• id - 書類ID (docu_*)
• livemode - 本番モードの書類かどうか
• location - 書類を取得するためのAPIパス
• deleted - 書類が削除されたかどうか
• filename - 元のファイル名
• kind - 書類の種類 (cardholder_details, details_of_purchase, proof_of_receipt, proof_of_acceptance)
• download_uri - 書類をダウンロードするための一時URL
• created_at - 書類がアップロードされた日時

400

不正なリクエスト

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

一般的な原因:

• 不審請求IDの形式が無効
• 書類IDの形式が無効

401

認証エラー

認証に失敗しました。APIキーが無効または見つかりません。

一般的な原因:

• Authorizationヘッダーがない
• シークレットキーが無効
• シークレットキーではなくパブリックキーを使用している
• HTTP Basic Auth形式が正しくない

404

見つかりません

不審請求または書類が見つかりません。

一般的な原因:

• 不審請求IDが正しくない
• 書類IDが正しくない
• 書類がこの不審請求に属していない
• 不審請求または書類が別のアカウントに属している
• IDのタイプミスまたは形式エラー

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

document = Omise::Dispute.retrieve_document(
  'dspt_test_5xuy4w91xqz7d1w9u0t',
  'docu_test_5xuy4w91xqz7d1w9u0t'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

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

PHP

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

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

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

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

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認してください
not_found	不審請求または書類が見つかりません	不審請求IDと書類IDの両方が正しいことを確認してください
invalid_document_id	書類IDの形式が無効	有効な docu_ 形式を使用してください

書類の種類の値

種類	説明	書類の例
cardholder_details	顧客の本人確認	顧客ID、請求先住所の証明
details_of_purchase	取引および注文の詳細	請求書、注文確認書、領収書
proof_of_receipt	配達またはサービスの確認	追跡情報、署名入り配達証明
proof_of_acceptance	顧客の承認	メールのやり取り、利用規約の同意

ダウンロードURLに関する注意事項

• download_uri は一時的な署名付きURLです
• URLは一定期間後に失効します（通常15分から1時間）
• 失効した場合は、書類を再度取得して新しいダウンロードURLを入手してください

---

🔑API認証情報

▼

試してみる

必須 - 2項目

▼

id(必須)

document_id(必須)

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