Get Dispute

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

Retrieves a Dispute object.

Request

Path Parameters

id stringrequired

Dispute order ID

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

Request: Get dispute order

dispute object

dispute orders

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

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "dispute": {
      "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"
    }
  }
}