Dispute API

Attribute

Name Type Description
object string

The string dispute.

id string

The DISPUTE_ID.

livemode boolean

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

location string

Path to retrieve the dispute.

amount integer

The amount in the smallest subunits of the currency used. So for thb (Thai Baht) you'll need to pass the amount in satangs. #Maxmum and Minimum amount by supported currencies

currency string

The currency as its lower-cased international 3-letter code, defined by the ISO 4217 standard. #Supported Currencies

status string

The dispute status. One of open, pending, won or lost.

message string

The dispute message. A short explanation for the dispute.

charge string

The CHARGE_ID

created datetime

Creation date of the customer in ISO 8601 format.

Example

  • Json Response

List all disputes

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

Returns a list of dispute objects.

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 disputes

List all open disputes

- GET https://api.omise.co/disputes/open

Returns a list of open dispute objects.

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

Example

  • List all open disputes

List all pending disputes

- GET https://api.omise.co/disputes/pending

Returns a list of pending dispute objects.

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

Example

  • List all pending disputes

List all closed disputes

- GET https://api.omise.co/disputes/closed

Returns a list of closed (won or lost) dispute objects.

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

Example

  • List all closed disputes

Retrieve a dispute

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

Returns a dispute object.

Example

  • Retrieve a dispute

Update a dispute

- PATCH https://api.omise.co/disputes/DISPUTE_ID

Returns the updated dispute object.

Request Parameter

Name Type Description
message string

The new dispute message

Example

  • Update a dispute