ドキュメント一覧の取得

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

紛争に添付されたすべてのドキュメントを一覧表示します。このエンドポイントは、紛争対応を支援するためにアップロードされたすべての証拠ファイルを取得します。

---

リクエストパラメータ

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

▼

`id`STRING(required)

ドキュメントを一覧表示する紛争ID（パスパラメータ）。

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

追加 - 3項目追加パラメータ

▼

---

レスポンス

200

取得成功

紛争に添付されたドキュメントオブジェクトを含むリストオブジェクトを返します。

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

• object - 常に "list"
• data - ドキュメントオブジェクトの配列
• limit - ページあたりの結果数
• offset - スキップされた結果数
• total - この紛争のドキュメントの総数

各ドキュメントオブジェクトに含まれる項目：

• object - 常に "document"
• id - ドキュメントID (docu_*)
• livemode - 本番モードのドキュメントかどうか
• location - ドキュメントを取得するためのAPIパス
• deleted - ドキュメントが削除されたかどうか
• filename - 元のファイル名
• kind - ドキュメントタイプ（指定された場合）
• download_uri - ドキュメントをダウンロードするためのURL
• created_at - アップロード日時

400

不正なリクエスト

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

一般的な原因：

• 無効な紛争ID形式
• limitが最大値（100）を超えている
• 無効なorderパラメータ
• offsetまたはlimitの値が負の数

401

認証エラー

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

一般的な原因：

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

404

見つかりません

紛争が見つかりません。

一般的な原因：

• 紛争IDが正しくない
• 紛争が別のアカウントに属している
• IDの入力ミスまたはフォーマットエラー

5xx

サーバーエラー

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

対処方法：

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

---

コードサンプル

cURL

curl https://api.omise.co/disputes/dspt_test_5xuy4w91xqz7d1w9u0t/documents \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "limit=20" \
  -d "offset=0"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

documents = Omise::Document.list('dspt_test_5xuy4w91xqz7d1w9u0t', {
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

documents = omise.Document.list(
    'dspt_test_5xuy4w91xqz7d1w9u0t',
    limit=20,
    offset=0
)

Node.js

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

const documents = await omise.documents.list('dspt_test_5xuy4w91xqz7d1w9u0t', {
  limit: 20,
  offset: 0
});

PHP

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

$documents = OmiseDocument::retrieve('dspt_test_5xuy4w91xqz7d1w9u0t', [
    'limit' => 20,
    'offset' => 0
]);

Java

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

ScopedList<Document> documents = client.documents().list("dspt_test_5xuy4w91xqz7d1w9u0t")
    .limit(20)
    .offset(0)
    .execute();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var documents = await client.Documents.List("dspt_test_5xuy4w91xqz7d1w9u0t", new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

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

documents, _ := client.Document.List("dspt_test_5xuy4w91xqz7d1w9u0t", &operations.ListDocuments{
    Limit:  20,
    Offset: 0,
})

---

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

一般的なエラーコード

コード	説明	解決方法
bad_request	無効なパラメータ	パラメータ値を確認してください
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認してください
not_found	紛争が見つかりません	紛争IDが正しいことを確認してください

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

追加 - 3項目

▼

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