ドキュメントの取得

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::Document.retrieve(
  'dspt_test_5xuy4w91xqz7d1w9u0t',
  'docu_test_5xuy4w91xqz7d1w9u0t'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

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

PHP

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

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

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

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

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認してください
not_found	ドキュメントが見つかりません	紛争IDとドキュメントIDが正しいことを確認してください
invalid_document_id	ドキュメントID形式が無効	有効なdocu_形式を使用してください

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

• download_uriは一時的な署名付きURLです
• URLは一定期間後に有効期限が切れます（通常15分から1時間）
• 有効期限が切れた場合は、新しいドキュメント取得リクエストを行って新しいダウンロードURLを取得してください

---

🔑API認証情報

▼

試してみる

必須 - 2項目

▼

id(必須)

document_id(必須)

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