不審請求の書類一覧を取得

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

不審請求に添付されたすべての書類の一覧を取得します。このエンドポイントは、不審請求への対応をサポートするためにアップロードされたすべての証拠ファイルを取得します。

---

リクエストパラメータ

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

▼

`id`STRING(required)

書類一覧を取得する不審請求ID（パスパラメータ）。

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

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

▼

---

レスポンス

200

取得成功

不審請求に添付された書類オブジェクトを含むリストオブジェクトを返します。

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

• object - 常に "list"
• data - 書類オブジェクトの配列
• limit - 1ページあたりの結果数
• 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::Dispute.list_documents('dspt_test_5xuy4w91xqz7d1w9u0t', {
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

documents = omise.Dispute.list_documents(
    'dspt_test_5xuy4w91xqz7d1w9u0t',
    limit=20,
    offset=0
)

Node.js

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

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

PHP

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

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

Java

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

ScopedList<Document> documents = client.disputes().listDocuments("dspt_test_5xuy4w91xqz7d1w9u0t")
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

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

一般的なエラーコード

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

書類の種類の値

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

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

追加 - 3項目

▼

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