The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.

Anchor to section titled 'undefined'

Dispute

Requires ANY of the following access scopes: shopify_payments_payouts, shopify_payments.

Disputes occur when a buyer questions the legitimacy of a charge with their financial institution.
Was this section helpful?
Anchor to section titled 'The Dispute resource'

The Dispute resource

Properties
id
->id
The ID of the dispute.
order_id
->id
The ID of the order that the dispute belongs to.
type
->type
Whether the dispute is still in the inquiry phase or has turned into a chargeback. Valid values:
currency
->currencyCode
The ISO 4217 currency code of the dispute amount.
amount
->amount
The total amount disputed by the cardholder.
reason
->reason
The reason of the dispute provided by the cardholder's bank. Valid values:
network_reason_code
string
->networkReasonCode
The reason for the dispute provided by the cardholder's bank.
status
->status
The current state of the dispute. Valid values:
evidence_due_by
->evidenceDueBy
The deadline for evidence submission.
evidence_sent_on
->evidenceSentOn
"The date and time (ISO 8601 format) when evidence was sent. Returns null if evidence has not yet been sent.
finalized_on
->finalizedOn
The date and time (ISO 8601 format) when this dispute was resolved. Returns null if the dispute is not yet resolved.
Was this section helpful?
{}The Dispute resource
{
  "id": 54534554564,
  "order_id": 450789469,
  "type": "inquiry",
  "currency": "USD",
  "amount": "102.53",
  "reason": "fraudulent",
  "network_reason_code": "4840",
  "status": "under_review",
  "evidence_due_by": "2018-01-10T11:00:00-05:00",
  "evidence_sent_on": "2018-01-09T11:00:00-05:00",
  "finalized_on": "2018-03-10T11:00:00-05:00"
}
Anchor to section titled 'GET request, Return a list of all disputes'

get
Return a list of all disputes

shopifyPaymentsAccount
Retrieve all disputes ordered by initiated_at date and time (ISO 8601 format), with the most recent being first. Note: This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to Make paginated requests to the REST Admin API.
Anchor to section titled 'Parameters of Return a list of all disputes'

Parameters

api_version
string
required
initiated_at
Return only disputes with the specified initiated_at date (ISO 8601 format).
last_id
Return only disputes before the specified ID.
since_id
Return only disputes after the specified ID.
status
Return only disputes with the specified status.
Was this section helpful?
Anchor to section titled 'Examples of Return a list of all disputes'

Examples

Query parameters
initiatedat=2013-05-03
Return only disputes with the specified initiated_at date (ISO 8601 format).
Was this section helpful?
get
/admin/api/2024-10/shopify_payments/disputes.json?initiatedat=2013-05-03
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/shopify_payments/disputes.json?initiated_at=2013-05-03" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "disputes": []
}
Anchor to section titled 'GET request, Return a single dispute'

get
Return a single dispute

dispute
Retrieves a single dispute by ID.
Anchor to section titled 'Parameters of Return a single dispute'

Parameters

api_version
string
required
dispute_id
string
required
Was this section helpful?
Anchor to section titled 'Examples of Return a single dispute'

Examples

Path parameters
disputeid=598735659
string
required
Was this section helpful?
get
/admin/api/2024-10/shopify_payments/disputes/598735659.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/shopify_payments/disputes/598735659.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "dispute": {
    "id": 598735659,
    "order_id": 625362839,
    "type": "chargeback",
    "amount": "11.50",
    "currency": "USD",
    "reason": "fraudulent",
    "network_reason_code": "4827",
    "status": "needs_response",
    "evidence_due_by": "2024-10-07T20:00:00-04:00",
    "evidence_sent_on": null,
    "finalized_on": null,
    "initiated_at": "2013-05-03T20:00:00-04:00"
  }
}