Dispute書類のアップロード

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

disputeの応答をサポートするためのevidence書類をアップロードします。書類は、カード発行会社に証拠を提供することでケースを強化します。

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 2 fieldsRequired Parameters

▼

`id`STRING(required)

Dispute ID（パスパラメータ）。disputeのステータスは「open」である必要があります。

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

`file`FILE(required)

アップロードするevidence書類ファイル。受け付ける形式：PNG、JPG、PDF。

Example:"delivery-proof.pdf"

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

Additional - 1 fieldAdditional Parameters

▼

---

レスポンス

200

アップロード成功

書類が正常にアップロードされ、disputeに添付されました。

レスポンスに含まれる内容:

• id - 書類ID（docu_*）
• filename - 元のファイル名
• kind - 書類の種類（指定された場合）
• download_uri - 書類をダウンロードするURL
• created_at - アップロードのタイムスタンプ
• 書類はすぐに銀行の審査に利用可能です
• 一度アップロードされると削除できません

400

不正なリクエスト

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

よくある原因:

• ファイルが欠落しているか空です
• 無効なファイル形式（PNG、JPG、またはPDFではありません）
• 無効なkindパラメータ値

401

認証されていません

認証に失敗しました。API keyが無効または欠落しています。

よくある原因:

• Authorizationヘッダーが欠落しています
• 無効なsecret key
• secret keyの代わりにpublic keyを使用しています
• HTTP Basic Auth形式が正しくありません

404

見つかりません

Disputeが見つかりません。

よくある原因:

• dispute IDが正しくありません
• disputeが別のアカウントに属しています
• IDのタイプミスまたは形式エラー

413

ファイルが大きすぎます

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

解決方法:

• サイズを小さくするためにファイルを圧縮します
• 大きな書類を複数のファイルに分割します
• ファイルが10MB未満であることを確認します

422

処理できないエンティティ

このdisputeに書類をアップロードできません。

よくある原因:

• disputeのステータスが「open」ではありません（すでにpending、won、またはlostです）
• disputeがクローズされています
• 書類の最大数に達しました

---

Code samples

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::Dispute.upload_document('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.Dispute.upload_document(
        '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.disputes.uploadDocument('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 = OmiseDispute::uploadDocument('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.disputes().uploadDocument(
    "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.Disputes.UploadDocument(
        "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.UploadDisputeDocument("dspt_test_5xuy4w91xqz7d1w9u0t", file, "proof_of_receipt")

---

Error and result codes

一般的なエラーコード

Code	Description	Resolution
bad_request	無効なファイルまたはパラメータ	ファイル形式とkindパラメータを確認してください
authentication_failure	無効なAPI key	secret keyが正しいことを確認してください
not_found	Disputeが見つかりません	dispute IDが正しいことを確認してください
file_too_large	ファイルが10MBの制限を超えています	ファイルを圧縮または分割してください
invalid_file_format	サポートされていないファイル形式	PNG、JPG、またはPDFを使用してください
dispute_not_open	Disputeがopenではありません	書類はオープンなdisputeにのみ追加できます

書類のKind値

Kind	Description	Example Documents
cardholder_details	顧客の本人確認	顧客ID、請求先住所の証明
details_of_purchase	取引と注文の詳細	請求書、注文確認、領収書
proof_of_receipt	配達またはサービスの確認	追跡情報、署名付き配達証明
proof_of_acceptance	顧客の承認	メールのやり取り、利用規約の承認

---

Try it out

必須 - 2項目

▼

id(必須)

file(必須)

追加 - 1項目

▼