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	string	ドキュメントが作成されたISO 8601 形式(`YYYY-MM-DDThh:mm:ssZ`)でのUTC日時。
deleted	boolean	ドキュメントが削除されたかどうか。
download_uri	string	ダウンロードするドキュメントのURI。
filename	string	アップロードされたファイルの元のファイル名。
kind	string	Document kind

Example

JSON Response

{
  "object": "document",
  "livemode": false,
  "id": "docu_test_no1t4tnemucod0e51mo",
  "filename": "this_is_fine.png",
  "location": "/disputes/dspt_test_no1t4tnemucod0e51mo/documents/docu_test_no1t4tnemucod0e51mo",
  "kind": "details_of_purchase",
  "created": "2019-12-31T12:59:59Z"
}

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

- 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

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

curl
ruby

curl https://api.omise.co/disputes/dspt_test_5g5ih3pybo7v4wwrbjw/documents \
  -u $OMISE_SECRET_KEY: \
  -F kind=details_of_purchase \
  -F file=@evidence.png

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

dispute = Omise::Dispute.retrieve("dspt_test_4zgf15h89w8t775kcm8")

File.open("some/path.doc", "r") do |file|
  dispute.documents.upload(file)
end

ドキュメントを削除する

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

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

Example

Destroy a document

curl
ruby

curl https://api.omise.co/disputes/dspt_test_5g5ih3pybo7v4wwrbjw/documents/docu_test_5g5iiejzhyhbfyj6kzs \
  -X DELETE \
  -u $OMISE_SECRET_KEY:

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

dispute  = Omise::Dispute.retrieve("dspt_test_4zgf15h89w8t775kcm8")
document = dispute.documents.retrieve("docu_test_53f7n2a4rzvii1p8tn7")

document.destroy

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

- 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

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

curl
ruby

curl https://api.omise.co/disputes/dspt_test_5g5ih3pybo7v4wwrbjw/documents \
  -u $OMISE_SECRET_KEY:

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

dispute   = Omise::Dispute.retrieve("dspt_test_4zgf15h89w8t775kcm8")
documents = dispute.documents

ドキュメントの取得

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

Returns the document matching :document_id.

Example

ドキュメントの取得

curl
ruby

curl https://api.omise.co/disputes/dspt_test_5g5ih3pybo7v4wwrbjw/documents/docu_test_5g5iiejzhyhbfyj6kzs \
  -u $OMISE_SECRET_KEY:

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

dispute  = Omise::Dispute.retrieve("dspt_test_4zgf15h89w8t775kcm8")
document = dispute.documents.retrieve("docu_test_53f7n2a4rzvii1p8tn7")