List Disputes

GET 
/openapi/2024-07/shoplazza-payment/disputes

Returns a list of Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Request

Query Parameters

cursor string

cursor for pagination, use the cursor from the response for pagination

limit int32

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

status string

Filter option: dispute status (e.g., "lost", "won", "warning_closed", "needs_response", "under_review", "warning_under_review", "warning_needs_response")

lost: The dispute was resolved against the merchant, and the funds were not recovered. won: The dispute was resolved in favor of the merchant, and the funds were retained or recovered. warning_closed: The dispute case was closed following a warning; no further action is required. needs_response: The dispute requires a response or evidence from the merchant to proceed. under_review: The dispute is currently under review by the payment processor or financial institution. warning_under_review: The dispute received a warning and is under review; further action may be needed. warning_needs_response: The dispute has a warning and requires a response from the merchant to avoid further escalation.

created_at_min string

Filter option: dispute creation start time (unix timestamp)

created_at_max string

Filter option: dispute creation end time (unix timestamp)

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

Response: Dispute order list

has_moreboolean

Whether there is more data

list object[]

List of dispute orders

Array [

idstring

Dispute order ID

transaction_order_idstring

Transaction order ID

original_order_idstring

Original order ID

store_idstring

Store ID

currencystring

Account currency

created_atstring

Creation time (unix timestamp)

updated_atstring

Last updated time (unix timestamp)

expiration_timestring

Expiration time (unix timestamp)

dispute_reasonstring

Dispute reason

original_order_amountstring

Original order amount

dispute_amountstring

Dispute amount

statusstring

Status (e.g., "lost", "won", "warning_closed", "needs_response", "under_review", "warning_under_review", "warning_needs_response") lost: The dispute was resolved against the merchant, and the funds were not recovered. won: The dispute was resolved in favor of the merchant, and the funds were retained or recovered. warning_closed: The dispute case was closed following a warning; no further action is required. needs_response: The dispute requires a response or evidence from the merchant to proceed. under_review: The dispute is currently under review by the payment processor or financial institution. warning_under_review: The dispute received a warning and is under review; further action may be needed. warning_needs_response: The dispute has a warning and requires a response from the merchant to avoid further escalation.

feestring

Dispute fee

fee_currencystring

Fee currency

]

cursorstring

cursor for pagination

Example

json

{
  "code": "string",
  "message": "string",
  "data": {
    "has_more": true,
    "list": [
      {
        "id": "string",
        "transaction_order_id": "string",
        "original_order_id": "string",
        "store_id": "string",
        "currency": "string",
        "created_at": "string",
        "updated_at": "string",
        "expiration_time": "string",
        "dispute_reason": "string",
        "original_order_amount": "string",
        "dispute_amount": "string",
        "status": "string",
        "fee": "string",
        "fee_currency": "string"
      }
    ],
    "cursor": "string"
  }
}