> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetDispute # Package: disputes # Namespace: DisputeService # Method link: https://dev.wix.com/docs/api-reference/business-management/payments/disputes/disputes/get-dispute.md ## Permission Scopes: Read Disputes: SCOPE.DC-PAYMENTS.READ-DISPUTES ## Introduction Retrieves a dispute. --- ## REST API ### Schema ``` Method: getDispute Description: Retrieves a dispute. URL: https://www.wixapis.com/payments/disputes/v1/disputes/{disputeId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: disputeId Method parameters: param name: disputeId | type: none | required: true Return type: GetDisputeResponse - name: dispute | type: Dispute | description: The retrieved dispute. - name: id | type: string | description: Dispute GUID. - name: chargeId | type: string | description: GUID of the charge that is being disputed. - name: providerDisputeId | type: string | description: Unique identifier assigned by the payment service provider for this dispute. - name: stage | type: DisputeStage | description: Stage of the dispute process. - enum: - CHARGEBACK: Formal dispute filed through the card network or issuing bank. - INQUIRY: Initial inquiry from the customer requesting information about the charge. - name: reason | type: DisputeReason | description: Reason why the customer initiated the dispute. - enum: - FRAUD_CARD_PRESENT: Fraudulent use of a physical card. - FRAUD_CARD_ABSENT: Fraudulent use without the physical card present. - DUPLICATE_PROCESSING: Duplicate charge processing. - SERVICES_NOT_PROVIDED: Services or goods were not provided as promised. - CANCELED_RECURRING: Recurring payment that should have been canceled. - NOT_AS_DESCRIBED: Item received was not as described. - COUNTERFEIT: Item received was counterfeit. - MISREPRESENTATION: Merchant misrepresented the transaction. - CANCELED: Transaction was canceled but still charged. - OTHER: Other dispute reason not covered by specific categories. - name: currencyCode | type: string | description: Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. Matches the currency of the disputed charge. - name: amount | type: string | description: Disputed amount in the currency's main units. For example, `"12.95"` for $12.95. - name: status | type: DisputeStatus | description: Current status of the dispute. This indicates what action is required and who needs to take it. - enum: - WAITING_MERCHANT: Merchant action required to proceed with the dispute. - UNDER_REVIEW: Dispute is being reviewed by the payment service provider or bank. - WAITING_BUYER: Customer action required to proceed with the dispute. - WON: Dispute resolved in favor of the merchant. - LOST: Dispute resolved in favor of the customer. When a dispute is lost, the refund is processed automatically. - name: sellerProtection | type: SellerProtection | description: Level of seller protection coverage for this dispute. Seller protection is set by the payment provider. For example, PayPal offers a [seller protection program](https://www.paypal.com/ua/legalhub/paypal/seller-protection). - enum: - NOT_ELIGIBLE: Transaction is not eligible for seller protection. - ELIGIBLE: Transaction is eligible for basic seller protection. - EXTENDED: Transaction is eligible for extended seller protection coverage. - name: channel | type: DisputeChannel | description: Channel through which the dispute is being processed. - enum: - INTERNAL: Dispute is processed by the payment service provider. - EXTERNAL: Dispute is processed through the card network or issuing bank. - name: dueDate | type: string | description: The latest date and time until which the dispute can remain in its current status. If this date passes, the dispute will be resolved against the party that is required to take action. For example, if the status is `WAITING_MERCHANT`, and the due date passes, the dispute will be `LOST` and a refund will be processed automatically. - name: networkReasonCode | type: string | description: Network reason code provided by the card network or issuing bank that initiated the dispute. - name: defendable | type: boolean | description: Whether the dispute can be defended with evidence. - name: autoDefended | type: boolean | description: Whether the dispute was automatically defended by the payment processor. - name: defendedDate | type: string | description: Date and time at which the dispute was defended. - name: acceptedDate | type: string | description: Date and time at which the dispute was accepted. - name: actions | type: array | description: List of actions that can be performed on the dispute. Each action has a specific due date by which it must be completed. Available actions depend on the dispute's current status and stage. - name: type | type: DisputeActionType | description: Type of action that can be performed. - enum: - ACCEPT: Dispute can be accepted. - DEFEND: Dispute can be defended. - name: dueDate | type: string | description: Latest date and time by which this action must be performed. - name: createdDate | type: string | description: Date and time the dispute was created. - name: updatedDate | type: string | description: Date and time the dispute was updated. - name: revision | type: string | description: Revision number, which increments by 1 each time the dispute is updated. To prevent conflicting changes, the current revision must be passed when updating the dispute. Ignored when creating a dispute. - name: extendedFields | type: ExtendedFields | description: Custom field data for the dispute object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags assigned to the dispute for organization and filtering purposes. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs. - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. ``` ### Examples ### Get dispute details Retrieves complete information about a specific dispute including status and available actions ```curl curl -X GET \ 'https://www.wixapis.com/payments/disputes/v1/disputes/12345678-1234-1234-1234-123456789012' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.disputes.DisputeService.getDispute(disputeId) Description: Retrieves a dispute. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: disputeId Method parameters: param name: disputeId | type: string | description: GUID of the dispute to retrieve. | required: true Return type: PROMISE - name: _id | type: string | description: Dispute GUID. - name: chargeId | type: string | description: GUID of the charge that is being disputed. - name: providerDisputeId | type: string | description: Unique identifier assigned by the payment service provider for this dispute. - name: stage | type: DisputeStage | description: Stage of the dispute process. - enum: - CHARGEBACK: Formal dispute filed through the card network or issuing bank. - INQUIRY: Initial inquiry from the customer requesting information about the charge. - name: reason | type: DisputeReason | description: Reason why the customer initiated the dispute. - enum: - FRAUD_CARD_PRESENT: Fraudulent use of a physical card. - FRAUD_CARD_ABSENT: Fraudulent use without the physical card present. - DUPLICATE_PROCESSING: Duplicate charge processing. - SERVICES_NOT_PROVIDED: Services or goods were not provided as promised. - CANCELED_RECURRING: Recurring payment that should have been canceled. - NOT_AS_DESCRIBED: Item received was not as described. - COUNTERFEIT: Item received was counterfeit. - MISREPRESENTATION: Merchant misrepresented the transaction. - CANCELED: Transaction was canceled but still charged. - OTHER: Other dispute reason not covered by specific categories. - name: currencyCode | type: string | description: Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. Matches the currency of the disputed charge. - name: amount | type: string | description: Disputed amount in the currency's main units. For example, `"12.95"` for $12.95. - name: status | type: DisputeStatus | description: Current status of the dispute. This indicates what action is required and who needs to take it. - enum: - WAITING_MERCHANT: Merchant action required to proceed with the dispute. - UNDER_REVIEW: Dispute is being reviewed by the payment service provider or bank. - WAITING_BUYER: Customer action required to proceed with the dispute. - WON: Dispute resolved in favor of the merchant. - LOST: Dispute resolved in favor of the customer. When a dispute is lost, the refund is processed automatically. - name: sellerProtection | type: SellerProtection | description: Level of seller protection coverage for this dispute. Seller protection is set by the payment provider. For example, PayPal offers a [seller protection program](https://www.paypal.com/ua/legalhub/paypal/seller-protection). - enum: - NOT_ELIGIBLE: Transaction is not eligible for seller protection. - ELIGIBLE: Transaction is eligible for basic seller protection. - EXTENDED: Transaction is eligible for extended seller protection coverage. - name: channel | type: DisputeChannel | description: Channel through which the dispute is being processed. - enum: - INTERNAL: Dispute is processed by the payment service provider. - EXTERNAL: Dispute is processed through the card network or issuing bank. - name: dueDate | type: Date | description: The latest date and time until which the dispute can remain in its current status. If this date passes, the dispute will be resolved against the party that is required to take action. For example, if the status is `WAITING_MERCHANT`, and the due date passes, the dispute will be `LOST` and a refund will be processed automatically. - name: networkReasonCode | type: string | description: Network reason code provided by the card network or issuing bank that initiated the dispute. - name: defendable | type: boolean | description: Whether the dispute can be defended with evidence. - name: autoDefended | type: boolean | description: Whether the dispute was automatically defended by the payment processor. - name: defendedDate | type: Date | description: Date and time at which the dispute was defended. - name: acceptedDate | type: Date | description: Date and time at which the dispute was accepted. - name: actions | type: array | description: List of actions that can be performed on the dispute. Each action has a specific due date by which it must be completed. Available actions depend on the dispute's current status and stage. - name: type | type: DisputeActionType | description: Type of action that can be performed. - enum: - ACCEPT: Dispute can be accepted. - DEFEND: Dispute can be defended. - name: dueDate | type: Date | description: Latest date and time by which this action must be performed. - name: _createdDate | type: Date | description: Date and time the dispute was created. - name: _updatedDate | type: Date | description: Date and time the dispute was updated. - name: revision | type: string | description: Revision number, which increments by 1 each time the dispute is updated. To prevent conflicting changes, the current revision must be passed when updating the dispute. Ignored when creating a dispute. - name: extendedFields | type: ExtendedFields | description: Custom field data for the dispute object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags assigned to the dispute for organization and filtering purposes. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs. - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. ``` ### Examples ### getDispute ```javascript import { disputes } from '@wix/payments'; async function getDispute(disputeId) { const response = await disputes.getDispute(disputeId); }; ``` ### getDispute (with elevated permissions) ```javascript import { disputes } from '@wix/payments'; import { auth } from '@wix/essentials'; async function myGetDisputeMethod(disputeId) { const elevatedGetDispute = auth.elevate(disputes.getDispute); const response = await elevatedGetDispute(disputeId); } ``` ### getDispute (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { disputes } from '@wix/payments'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { disputes }, // Include the auth strategy and host as relevant }); async function getDispute(disputeId) { const response = await myWixClient.disputes.getDispute(disputeId); }; ``` ---