Skip to main content
Version: 202506

List disputes

GET 

/openapi/2025-06/shoplazza-payment/disputes

Returns a paginated list of disputes, optionally filtered by status and creation time range.

Request

Query Parameters

    cursor string

    Cursor for pagination

    page_size int32

    Page size (1-100, default 10)

    status string

    Filter disputes by status:

    • lost: dispute resolved against the merchant; funds were not recovered
    • won: dispute resolved in favor of the merchant; funds were retained or recovered
    • warning_closed: warning-type dispute case closed; no further action required
    • needs_response: dispute requires a response or evidence from the merchant to proceed
    • under_review: dispute is being reviewed by the payment processor or financial institution
    • warning_under_review: warning-type dispute is under review; further action may be needed
    • warning_needs_response: warning-type dispute awaiting merchant response to avoid escalation
    created_at_min string

    Filter disputes created at or after this Unix timestamp (e.g., 1730548810)

    created_at_max string

    Filter disputes created at or before this Unix timestamp (e.g., 1730548810)

Responses

OK

Schema
    codestring

    error code

    messagestring

    error message

    data object
    list object[]

    List of dispute records

  • Array [
  • idstring

    Dispute ID

    transaction_order_idstring

    Transaction order ID related to the dispute

    original_order_idstring

    Original order ID related to the transaction

    store_idstring

    Store ID

    currencystring

    Currency code of the dispute amount

    created_atstring

    Creation time of the dispute in ISO 8601 format

    updated_atstring

    Last updated time of the dispute in ISO 8601 format

    expiration_timestring

    Expiration time for responding to the dispute

    dispute_reasonstring

    Reason provided for the dispute

    original_order_amountstring

    Total amount of the original order

    dispute_amountstring

    Amount of the dispute

    statusstring

    Current status of the dispute. Possible values: won, lost, under_review, etc

    feestring

    Fees associated with the dispute

    fee_currencystring

    Currency of the associated fee

  • ]
  • cursorstring

    Cursor for pagination

    has_moreboolean

    Whether there are more records