Return a single dispute

GET

/admin/api/{api_version}/shopify_payments/disputes/{dispute_id}.json

Retrieves a single dispute by ID.

请求参数

Path 参数

api_version

string

必需

dispute_id

string

必需

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200Return a single dispute

application/json

Body

dispute

object (Dispute)

可选

string

可选

The ID of the dispute.

order_id

string

可选

The ID of the order that the dispute belongs to.

type

string

可选

Whether the dispute is still in the inquiry phase or has turned into a chargeback.
Valid values:

inquiry: The dispute is in the inquiry phase.
chargeback: The dispute has turned into a chargeback.

currency

string

可选

The ISO 4217 currency code of the dispute amount.

amount

string

可选

The total amount disputed by the cardholder.

reason

string

可选

The reason of the dispute provided by the cardholder's bank. Valid values:

bank_not_process: The customer's bank cannot process the charge.
credit_not_processed: The customer claims that the purchased product was returned
or the transaction was otherwise canceled, but the merchant have not yet provided a refund or credit.
customer_initiated: The customer initiated the dispute, so the merchant should contact
the customer for additional details to find out why the payment was disputed.
debit_not_authorized: The customer's bank cannot proceed with the debit
since it has not been authorized.
duplicate: The customer claims they were charged multiple times
for the same product or service.

fraudulent: The cardholder claims that they didn't authorize the payment.

general: The dispute is uncategorized, so the merchant should contact the customer for
additional details to find out why the payment was disputed.
incorrect_account_details: The customer account associated with the
purchase is incorrect.

insufficient_funds: The customer's bank account has insufficient funds.

product_not_received: The customer claims they did not receive the products
or services purchased.
product_unacceptable: The product or service was received but was defective,
damaged, or not as described.
subscription_canceled: The customer claims that the merchant continued to charge them
after a subscription was canceled.
unrecognized: The customer doesn't recognize the payment appearing on
their card statement.

network_reason_code

string

可选

The reason for the dispute provided by the cardholder's bank.

status

string

可选

The current state of the dispute. Valid values:

needs_response: The dispute has been open and needs an evidence submission.
under_review: The evidence has been submitted and is being reviewed by the
cardholder's bank.

charge_refunded: The merchant refunded the inquiry amount.

accepted: The merchant has accepted the dispute as being valid.

won: The cardholder's bank reached a final decision in the merchant's favor.

lost: The cardholder's bank reached a final decision in the buyer's favor.

evidence_due_by

string

可选

The deadline for evidence submission.

evidence_sent_on

string

可选

"The date and time (ISO 8601 format) when
evidence was sent. Returns null if evidence has not yet been sent.

finalized_on

string

可选

The date and time (ISO 8601 format) when
this dispute was resolved. Returns null if the dispute is not yet resolved.

示例

{
    "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": "2022-10-15T20:00:00-04:00",
        "evidence_sent_on": null,
        "finalized_on": null,
        "initiated_at": "2013-05-03T20:00:00-04:00"
    }
}

修改于 2023-01-29 12:00:35

Return a list of all disputes

Return a list of all payouts