> 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 # GetDisputeHistoryRecord # Package: disputes # Namespace: DisputeHistoryRecordService # Method link: https://dev.wix.com/docs/api-reference/business-management/payments/disputes/dispute-history-records/get-dispute-history-record.md ## Permission Scopes: Read Disputes: SCOPE.DC-PAYMENTS.READ-DISPUTES ## Introduction Retrieves a dispute history record. --- ## REST API ### Schema ``` Method: getDisputeHistoryRecord Description: Retrieves a dispute history record. URL: https://www.wixapis.com/payments/dispute-history-records/v1/dispute-history-records/{disputeHistoryRecordId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: disputeHistoryRecordId Method parameters: param name: disputeHistoryRecordId | type: none | required: true Return type: GetDisputeHistoryRecordResponse - name: disputeHistoryRecord | type: DisputeHistoryRecord | description: The retrieved dispute history record. - name: id | type: string | description: Dispute history record GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the dispute history record is updated. To prevent conflicting changes, the existing revision must be specified when updating a dispute history record. - name: createdDate | type: string | description: Date and time the dispute history record was created. - name: updatedDate | type: string | description: Date and time the dispute history record was last updated. - name: disputeId | type: string | description: GUID of the dispute that this history record is a snapshot of. - 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: status | type: DisputeStatus | description: Status of the dispute at the time this record was created. Indicates what action was required and by whom at this point in the dispute lifecycle. - enum: - WAITING_MERCHANT: Waiting for merchant action, such as submitting evidence or accepting the dispute. - UNDER_REVIEW: Dispute is under review by the payment service provider (internal channel) or bank (external channel). - WAITING_BUYER: Waiting for buyer action or response. - WON: Dispute was resolved in favor of the merchant. - LOST: Dispute was resolved in favor of the cardholder. - 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: chargeId | type: string | description: GUID of the charge that is being disputed. - 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: extendedFields | type: ExtendedFields | description: Custom field data for the dispute history record 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 history record 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 a dispute history record Retrieves a specific dispute history record by ID ```curl curl -X GET \ 'https://www.wixapis.com/payments/dispute-history-records/v1/dispute-history-records/12345678-1234-1234-1234-123456789012' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.disputes.DisputeHistoryRecordService.getDisputeHistoryRecord(disputeHistoryRecordId) Description: Retrieves a dispute history record. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: disputeHistoryRecordId Method parameters: param name: disputeHistoryRecordId | type: string | description: GUID of the dispute history record to retrieve. | required: true Return type: PROMISE - name: _id | type: string | description: Dispute history record GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the dispute history record is updated. To prevent conflicting changes, the existing revision must be specified when updating a dispute history record. - name: _createdDate | type: Date | description: Date and time the dispute history record was created. - name: _updatedDate | type: Date | description: Date and time the dispute history record was last updated. - name: disputeId | type: string | description: GUID of the dispute that this history record is a snapshot of. - 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: status | type: DisputeStatus | description: Status of the dispute at the time this record was created. Indicates what action was required and by whom at this point in the dispute lifecycle. - enum: - WAITING_MERCHANT: Waiting for merchant action, such as submitting evidence or accepting the dispute. - UNDER_REVIEW: Dispute is under review by the payment service provider (internal channel) or bank (external channel). - WAITING_BUYER: Waiting for buyer action or response. - WON: Dispute was resolved in favor of the merchant. - LOST: Dispute was resolved in favor of the cardholder. - 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: chargeId | type: string | description: GUID of the charge that is being disputed. - 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: extendedFields | type: ExtendedFields | description: Custom field data for the dispute history record 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 history record 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 ### getDisputeHistoryRecord ```javascript import { disputeHistoryRecords } from '@wix/payments'; async function getDisputeHistoryRecord(disputeHistoryRecordId) { const response = await disputeHistoryRecords.getDisputeHistoryRecord(disputeHistoryRecordId); }; ``` ### getDisputeHistoryRecord (with elevated permissions) ```javascript import { disputeHistoryRecords } from '@wix/payments'; import { auth } from '@wix/essentials'; async function myGetDisputeHistoryRecordMethod(disputeHistoryRecordId) { const elevatedGetDisputeHistoryRecord = auth.elevate(disputeHistoryRecords.getDisputeHistoryRecord); const response = await elevatedGetDisputeHistoryRecord(disputeHistoryRecordId); } ``` ### getDisputeHistoryRecord (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 { disputeHistoryRecords } from '@wix/payments'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { disputeHistoryRecords }, // Include the auth strategy and host as relevant }); async function getDisputeHistoryRecord(disputeHistoryRecordId) { const response = await myWixClient.disputeHistoryRecords.getDisputeHistoryRecord(disputeHistoryRecordId); }; ``` ---