Document API

The Document API allows you to upload and keep track of important documents in the form of image scans and PDF files. Currently this API offers a way to automate dispute evidence uploads. Whenever a dispute has been opened, you can use this API to automatically upload evidence such as receipts or shipment delivery slips to speed up the dispute resolution process. Supported file types include PNG and JPG images and PDF files.

Attribute

Name Type Description
object string

The string document.

id object_id

A DOCUMENT_ID matching /docu(_test)?_[1-9a-z]+/.

livemode boolean

Whether this is a live (true) or test (false) document.

location string

Path to retrieve the document object.

filename string

Original filename of the uploaded file.

Example

  • Json Response

List all dispute documents

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

Returns a list of dispute objects.

Return all dispute documents that was uploaded to the dispute. You can learn more about lists in the pagination documentation.

Query Parameter

Name Type Description
offset integer

(optional, default: 0) The offset of the first record returned. I.e.: How many records to skip from the beginning.

limit integer

(optional, default: 20, maximum: 100) The maximum amount of records returned.

from datetime

(optional, default: 1970-01-01T00:00:00Z, format: ISO 8601) The UTC date and time limiting the beginning of returned records. E.g.: 2014-10-20T00:00:00Z

to datetime

(optional, default: current UTC Datetime, format: ISO 8601) The UTC date and time limiting the end of returned records. E.g.: 2015-01-20T00:00:00Z

order string

(optional, default: chronological) The order of the list returned. I.e.: chronological (from earliest to latest), reverse_chronological (from latest to earliest).

Example

  • List all dispute documents.

Upload a document

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

This endpoint allows you to send an HTTP multipart upload to add a dispute evidence document automatically.

Note that documents may only be added to an open dispute and document file size may not exceed 10MB.

Returns the newly created document object.

Request Parameter

Name Type Description
file File

required The file to upload. Valid files include PNG and JPG images and PDF files. The uploaded file should also includes metadata such as filename and content type.

Example

  • Upload a document

Retrieve a document

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

Example

  • Retrieve a document

Destroy a document

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

Note that documents may only be removed from open disputes.

Returns the destroyed document object.

Example

  • Destroy a document