Documents API
Documents APIは、紛争解決を支援するためのドキュメントファイルの作成、取得、削除を可能にします。スキャンされた領収書、配送伝票、顧客とのやり取りなどのドキュメントは、紛争解決プロセスにおける証拠として使用されます。
概要
ドキュメントは、紛争中にあなたの主張を裏付けるためにアップロードされるファイルです。顧客がチャージバックを申請した場合、強力な証拠書類を提供することで、紛争に勝つ可能性が高まります。
サポートされるファイル形式
| 形式 | MIMEタイプ | 最大サイズ |
|---|---|---|
| PNG | image/png | 10MB |
| JPG/JPEG | image/jpeg | 10MB |
| application/pdf | 10MB |
ドキュメントタイプ
kindパラメータを使用して証拠を分類します：
| Kind | 説明 | ドキュメント例 |
|---|---|---|
cardholder_details | 顧客の本人確認 | 顧客ID、請求先住所の証明 |
details_of_purchase | 取引および注文の詳細 | 請求書、注文確認書、領収書 |
proof_of_receipt | 配送またはサービス完了の確認 | 追跡情報、署名入り配送受領書 |
proof_of_acceptance | 顧客の承認 | メールのやり取り、規約への同意 |
利用可能なエンドポイント
- ドキュメントのアップロード - POST /disputes/:id/documents
- ドキュメントの取得 - GET /disputes/:id/documents/:document_id
- ドキュメント一覧の取得 - GET /disputes/:id/documents
- ドキュメントの削除 - DELETE /disputes/:id/documents/:document_id
ドキュメントオブジェクト
| フィールド | 型 | 説明 |
|---|---|---|
object | string | 常に "document" |
id | string | ドキュメント識別子 (docu_*) |
livemode | boolean | 本番モードまたはテストモードのドキュメントかどうか |
location | string | ドキュメントを取得するためのAPIパス |
deleted | boolean | ドキュメントが削除されたかどうか |
filename | string | アップロードされたドキュメントの元のファイル名 |
kind | string | ドキュメントタイプ (cardholder_details など) |
download_uri | string | ドキュメントをダウンロードするための一時URL |
created_at | string | ドキュメントがアップロードされた日時 (ISO 8601) |
ベストプラクティス
証拠のアップロード
- 明瞭で読みやすいドキュメントを提供する - 画像は高品質で、テキストは読みやすいものにしてください
- 説明的なファイル名を使用する - ドキュメントの整理と識別に役立ちます
- 正しく分類する - 適切な
kind値を使用してください - 早めにアップロードする - 締め切りまで待たないでください
紛争タイプ別の推奨証拠
| 紛争理由 | 推奨される証拠 |
|---|---|
| 不正利用 | 署名入り配送受領書、AVS/CVV検証、顧客とのやり取り |
| 商品未着 | 追跡番号、配送確認、配送業者の記録 |
| 商品に問題あり | 商品説明、写真、返品ポリシー、顧客とのやり取り |
| 重複請求 | 単一請求を示す取引記録 |
| 返金未処理 | 返金確認、ポリシー文書 |
重要な注意事項
- ドキュメントは
openステータスの紛争にのみアップロードできます - 紛争が
pendingに移行すると、ドキュメントは変更できません - ダウンロードURLは一時的なもので、有効期限があります
- ドキュメントあたりの最大ファイルサイズは10MBです
関連リソース
サポートが必要ですか？ 紛争証拠についてのサポートは support@omise.co までお問い合わせください。