Document (ドキュメント)

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

Attributes

Name Type Description
object string

固定値 document

id string

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

livemode boolean

本番モード (true) あるいはテストモード(false) ドキュメント。

location string

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

created_at string

ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ)でドキュメントが作成されたUTC日時。

deleted boolean

ドキュメントが削除されたかどうか。

download_uri string

ダウンロードするドキュメントのURI。

filename string

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

kind string

Document kind

Example

  • JSON Response

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

- POST https://api.omise.co/disputes/{id}/documents

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

Request Parameters

Name Type Description
file string

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

kind string

(任意) Document kind. When providing evidence for a dispute, kind must be one of cardholder_details, details_of_purchase, proof_of_receipt, proof_of_acceptance.

Example

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

ドキュメントを削除する

- DELETE https://api.omise.co/disputes/{id}/documents/{document_id}

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

Example

  • Destroy a document

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

- GET https://api.omise.co/disputes/{id}/documents

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

Request Parameters

Name Type Description
from string

(任意, default: 1970-01-01T00:00:00Z) ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日時。

limit integer

(任意, default: 20) 返されるレコードの数。

offset integer

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

order string

(任意, default: chronological, one of: chronological, reverse_chronological) listのオーダーがchronological (古い順) or reverse_chronological (新しい順)で返されます。エントリがない場合は nullとなります。

to string

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

Example

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

ドキュメントの取得

- GET https://api.omise.co/disputes/{id}/documents/{document_id}

Returns the document matching :document_id.

Example

  • ドキュメントの取得

Omiseは、お客様のウェブサイト全般における利便性を向上するためにクッキーを利用し、お客様のアクセス、閲覧履歴に関する情報を収集します。 当社のウェブサイトを閲覧し続けることにより、お客様は当社のプライバシーポリシーに同意することとします。 詳細はこちら