ドキュメントのアップロード

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

紛争対応を支援するための証拠ドキュメントをアップロードします。ドキュメントはカード発行会社への証明を提供することで、あなたの主張を強化します。

---

リクエストパラメータ

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

▼

`id`STRING(required)

紛争ID（パスパラメータ）。紛争のステータスは"open"である必要があります。

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

`file`FILE(required)

アップロードする証拠ドキュメントファイル。対応形式：PNG、JPG、PDF。

Example:"delivery-proof.pdf"

Constraints:最大ファイルサイズ：10MB, 形式：PNG、JPG、PDF

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

▼

---

レスポンス

200

アップロード成功

ドキュメントが正常にアップロードされ、紛争に添付されました。

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

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

400

不正なリクエスト

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

一般的な原因：

• ファイルが見つからないか空です
• 無効なファイル形式（PNG、JPG、PDF以外）
• 無効なkindパラメータ値

401

認証エラー

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

一般的な原因：

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

404

見つかりません

紛争が見つかりません。

一般的な原因：

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

413

ファイルサイズ超過

ファイルサイズが10MBの制限を超えています。

解決方法：

• ファイルを圧縮してサイズを減らす
• 大きなドキュメントを複数のファイルに分割する
• ファイルが10MB以下であることを確認する

422

処理不能なエンティティ

この紛争にドキュメントをアップロードできません。

一般的な原因：

• 紛争のステータスが"open"ではない（すでにpending、won、またはlost）
• 紛争がクローズしている
• ドキュメントの最大数に達している

5xx

サーバーエラー

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

対処方法：

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

---

コードサンプル

cURL

curl https://api.omise.co/disputes/dspt_test_5xuy4w91xqz7d1w9u0t/documents \
  -X POST \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -F "file=@/path/to/delivery-proof.pdf" \
  -F "kind=proof_of_receipt"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

document = Omise::Document.create('dspt_test_5xuy4w91xqz7d1w9u0t', {
  file: File.open('/path/to/delivery-proof.pdf'),
  kind: 'proof_of_receipt'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

with open('/path/to/delivery-proof.pdf', 'rb') as file:
    document = omise.Document.create(
        'dspt_test_5xuy4w91xqz7d1w9u0t',
        file=file,
        kind='proof_of_receipt'
    )

Node.js

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

const document = await omise.documents.create('dspt_test_5xuy4w91xqz7d1w9u0t', {
  file: fs.createReadStream('/path/to/delivery-proof.pdf'),
  kind: 'proof_of_receipt'
});

PHP

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

$document = OmiseDocument::create('dspt_test_5xuy4w91xqz7d1w9u0t', [
    'file' => '@/path/to/delivery-proof.pdf',
    'kind' => 'proof_of_receipt'
]);

Java

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

File file = new File("/path/to/delivery-proof.pdf");

Document document = client.documents().create(
    "dspt_test_5xuy4w91xqz7d1w9u0t",
    file,
    "proof_of_receipt"
);

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

using (var fileStream = File.OpenRead("/path/to/delivery-proof.pdf"))
{
    var document = await client.Documents.Create(
        "dspt_test_5xuy4w91xqz7d1w9u0t",
        fileStream,
        "proof_of_receipt"
    );
}

Go

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

file, _ := os.Open("/path/to/delivery-proof.pdf")
defer file.Close()

document, _ := client.Document.Create("dspt_test_5xuy4w91xqz7d1w9u0t", file, "proof_of_receipt")

---

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

一般的なエラーコード

コード	説明	解決方法
bad_request	無効なファイルまたはパラメータ	ファイル形式とkindパラメータを確認してください
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認してください
not_found	紛争が見つかりません	紛争IDが正しいことを確認してください
file_too_large	ファイルが10MB制限を超えています	ファイルを圧縮または分割してください
invalid_file_format	サポートされていないファイル形式	PNG、JPG、またはPDFを使用してください
dispute_not_open	紛争がopenではありません	ドキュメントはopen状態の紛争にのみ追加できます

ドキュメントKind値

Kind	説明	ドキュメント例
cardholder_details	顧客の本人確認	顧客ID、請求先住所の証明
details_of_purchase	取引および注文の詳細	請求書、注文確認書、領収書
proof_of_receipt	配送またはサービス完了の確認	追跡情報、署名入り配送受領書
proof_of_acceptance	顧客の承認	メールのやり取り、規約への同意

---

🔑API認証情報

▼

試してみる

必須 - 2項目

▼

id(必須)

file(必須)

Choose FileSelect file...

追加 - 1項目

▼

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