Document API

The Document API allows you to create, retrieve, and delete document files. Documents (for example, scanned receipts or shipment delivery slips) are used to help resolve disputes. Supported file types include PNG, JPG, and PDF.

Attribute

Name Type Description
object string

The string document.

id object_id

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

livemode boolean

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

location string

API path to retrieve the current document object.

created datetime

The UTC datetime of the creation of the document in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

filename string

The filename of the uploaded document.

Example

  • Json Response

List all dispute documents

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

Returns a list of all document objects belonging to the dispute.

Request 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 number of records returned.

from datetime

(optional, default: 1970-01-01T00:00:00Z) The earliest UTC date and time for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

to datetime

(optional, default: current UTC datetime) The latest UTC date and time for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

order string

(optional, default: chronological) The order of the list returned. Either chronological (earliest to latest) or reverse_chronological (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.

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 string

(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