Document (ドキュメント)

Document APIによって、重要書類 (PDFファイルやjpeg及びpngの画像ファイルのみ)をアップロード、および追跡することができます。 このAPIは、チャージバックが発生した場合の証明書を自動でアップロードする手段を提供しています。 例えば、チャージバックが請求された時は いつでも、このAPIを使用することで、領収書や出荷納品書などの証明書を自動的にアップロードし、 チャージバックへの対応処理を迅速化することが可能です。こちらのAPIは、PNG、JPG画像、またはPDFファイルにてご利用ください。

Attribute

Name Type Description
object string

固定値 document

id object_id

/docu(_test)?_[0-9a-z]+/ と一致するA DOCUMENT_ID

livemode boolean

本番モード (true) あるいはテストモード(false) document。

location string

現在のdocumentオブジェクトを取得するためのAPIパス。

created datetime

ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)でdocument作成の協定世界時(UTC)。

filename string

アップロードされたファイルの元のファイル名。

Example

  • Json Response

チャージバック・ドキュメント・リストの取得

- GET https://api.omise.co/disputes/DISPUTE_ID/documents

documentに属するすべての チャージバックオブジェクトの list を返します。

Request Parameter

Name Type Description
offset integer

(optional、default:0) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。

limit integer

(optional, default: 20, maximum: 100) 返されたレコード数。

from datetime

(optional, default: 1970-01-01T00:00:00Z) ISO 8601 形式の返されたレコードの最初のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

to datetime

(optional, default: current UTC datetime) ISO 8601 形式で返されたレコードの最新のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

order string

(optional, default: chronological) chronological(最初のものから最新のもの)または reverse_chronological (最新のものから最初のもの)のリストのオーダーが返されます。

Example

  • チャージバックリストの取得

ドキュメントをアップロードする

- POST https://api.omise.co/disputes/DISPUTE_ID/documents

上記URLでは、HTTP multipart upload を送信して、チャージバックの証拠資料を自動的に追加することができます。 その際、オープン状態のチャージバックでのみ資料の追加が可能であることにご留意ください(係争中、裁決済みの案件には追加できません)。 また10MBを超えるファイルは送信できませんのでご注意ください。 新しく作成されたドキュメント・オブジェクトを返します。

Request Parameter

Name Type Description
file string

必須: アップロードするファイル。PNG、JPG画像およびPDFファイルのみアップロード可能です。このファイルには、ファイル名やコンテンツタイプなどのメタデータ が 含まれている必要があります。

Example

  • ドキュメントをアップロードする

ドキュメントの取得

- GET https://api.omise.co/disputes/DISPUTE_ID/documents/DOCUMENT_ID

Example

  • ドキュメントの取得

ドキュメントを削除する

- DELETE https://api.omise.co/disputes/DISPUTE_ID/documents/DOCUMENT_ID

オープン状態のチャージバックのみ、ドキュメントを削除することができます(係争中、裁決済みの案件からは削除できません)。 削除されたドキュメント・オブジェクトを返します。

Example

  • Destroy a document