ShopifyPaymentsDispute

Version 2019-04

A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution.

Required access

read_orders access scope

Show definition
"""
A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution.
"""
type ShopifyPaymentsDispute implements LegacyInteroperability & Node {
  """
  The total amount disputed by the cardholder.
  """
  amount: MoneyV2!
  """
  The deadline for evidence submission.
  """
  evidenceDueBy: Date
  """
  The date when evidence was sent. Returns null if evidence has not yet been sent.
  """
  evidenceSentOn: Date
  """
  The date when this dispute was resolved. Returns null if the dispute is not yet resolved.
  """
  finalizedOn: Date
  """
  Globally unique identifier.
  """
  id: ID!
  """
  The date when this dispute was initiated.
  """
  initiatedAt: DateTime!
  """
  The ID of the corresponding resource in the REST Admin API.
  """
  legacyResourceId: UnsignedInt64!
  """
  The order that contains the charge that is under dispute.
  """
  order: Order
  """
  The reason of the dispute.
  """
  reasonDetails: ShopifyPaymentsDisputeReasonDetails!
  """
  The current state of the dispute.
  """
  status: DisputeStatus!
  """
  Indicates if this dispute is still in the inquiry phase or has turned into a chargeback.
  """
  type: DisputeType!
}

Implements

Fields

amount (MoneyV2!)

The total amount disputed by the cardholder.

evidenceDueBy (Date)

The deadline for evidence submission.

evidenceSentOn (Date)

The date when evidence was sent. Returns null if evidence has not yet been sent.

finalizedOn (Date)

The date when this dispute was resolved. Returns null if the dispute is not yet resolved.

id (ID!)

Globally unique identifier.

initiatedAt (DateTime!)

The date when this dispute was initiated.

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

order (Order)

The order that contains the charge that is under dispute.

reasonDetails (ShopifyPaymentsDisputeReasonDetails!)

The reason of the dispute.

status (DisputeStatus!)

The current state of the dispute.

type (DisputeType!)

Indicates if this dispute is still in the inquiry phase or has turned into a chargeback.

Version 2019-07 (Latest)

A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution.

Required access

read_orders access scope

Show definition
"""
A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution.
"""
type ShopifyPaymentsDispute implements LegacyInteroperability & Node {
  """
  The total amount disputed by the cardholder.
  """
  amount: MoneyV2!
  """
  The deadline for evidence submission.
  """
  evidenceDueBy: Date
  """
  The date when evidence was sent. Returns null if evidence has not yet been sent.
  """
  evidenceSentOn: Date
  """
  The date when this dispute was resolved. Returns null if the dispute is not yet resolved.
  """
  finalizedOn: Date
  """
  Globally unique identifier.
  """
  id: ID!
  """
  The date when this dispute was initiated.
  """
  initiatedAt: DateTime!
  """
  The ID of the corresponding resource in the REST Admin API.
  """
  legacyResourceId: UnsignedInt64!
  """
  The order that contains the charge that is under dispute.
  """
  order: Order
  """
  The reason of the dispute.
  """
  reasonDetails: ShopifyPaymentsDisputeReasonDetails!
  """
  The current state of the dispute.
  """
  status: DisputeStatus!
  """
  Indicates if this dispute is still in the inquiry phase or has turned into a chargeback.
  """
  type: DisputeType!
}

Implements

Fields

amount (MoneyV2!)

The total amount disputed by the cardholder.

evidenceDueBy (Date)

The deadline for evidence submission.

evidenceSentOn (Date)

The date when evidence was sent. Returns null if evidence has not yet been sent.

finalizedOn (Date)

The date when this dispute was resolved. Returns null if the dispute is not yet resolved.

id (ID!)

Globally unique identifier.

initiatedAt (DateTime!)

The date when this dispute was initiated.

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

order (Order)

The order that contains the charge that is under dispute.

reasonDetails (ShopifyPaymentsDisputeReasonDetails!)

The reason of the dispute.

status (DisputeStatus!)

The current state of the dispute.

type (DisputeType!)

Indicates if this dispute is still in the inquiry phase or has turned into a chargeback.

Version 2019-10 (Release candidate)

A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution.

Required access

read_orders access scope

Show definition
"""
A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution.
"""
type ShopifyPaymentsDispute implements LegacyInteroperability & Node {
  """
  The total amount disputed by the cardholder.
  """
  amount: MoneyV2!
  """
  The deadline for evidence submission.
  """
  evidenceDueBy: Date
  """
  The date when evidence was sent. Returns null if evidence has not yet been sent.
  """
  evidenceSentOn: Date
  """
  The date when this dispute was resolved. Returns null if the dispute is not yet resolved.
  """
  finalizedOn: Date
  """
  Globally unique identifier.
  """
  id: ID!
  """
  The date when this dispute was initiated.
  """
  initiatedAt: DateTime!
  """
  The ID of the corresponding resource in the REST Admin API.
  """
  legacyResourceId: UnsignedInt64!
  """
  The order that contains the charge that is under dispute.
  """
  order: Order
  """
  The reason of the dispute.
  """
  reasonDetails: ShopifyPaymentsDisputeReasonDetails!
  """
  The current state of the dispute.
  """
  status: DisputeStatus!
  """
  Indicates if this dispute is still in the inquiry phase or has turned into a chargeback.
  """
  type: DisputeType!
}

Implements

Fields

amount (MoneyV2!)

The total amount disputed by the cardholder.

evidenceDueBy (Date)

The deadline for evidence submission.

evidenceSentOn (Date)

The date when evidence was sent. Returns null if evidence has not yet been sent.

finalizedOn (Date)

The date when this dispute was resolved. Returns null if the dispute is not yet resolved.

id (ID!)

Globally unique identifier.

initiatedAt (DateTime!)

The date when this dispute was initiated.

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

order (Order)

The order that contains the charge that is under dispute.

reasonDetails (ShopifyPaymentsDisputeReasonDetails!)

The reason of the dispute.

status (DisputeStatus!)

The current state of the dispute.

type (DisputeType!)

Indicates if this dispute is still in the inquiry phase or has turned into a chargeback.

Sign up for a Partner account to get started.

Sign up