> 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 # GetDisputeEvidenceDocument # Package: disputes # Namespace: DisputeEvidenceDocumentService # Method link: https://dev.wix.com/docs/api-reference/business-management/payments/disputes/dispute-evidence-documents/get-dispute-evidence-document.md ## Permission Scopes: Read Disputes: SCOPE.DC-PAYMENTS.READ-DISPUTES ## Introduction Retrieves a dispute evidence document. --- ## REST API ### Schema ``` Method: getDisputeEvidenceDocument Description: Retrieves a dispute evidence document. URL: https://www.wixapis.com/payments/dispute-evidence-documents/v1/dispute-evidence-documents/{disputeEvidenceDocumentId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: disputeEvidenceDocumentId Method parameters: param name: disputeEvidenceDocumentId | type: none | required: true Return type: GetDisputeEvidenceDocumentResponse - name: disputeEvidenceDocument | type: DisputeEvidenceDocument | description: Retrieved dispute evidence document. Retrieved dispute evidence document. - name: id | type: string | description: Dispute evidence document GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the dispute evidence document is updated. To prevent conflicting changes, the existing revision must be specified when updating a dispute evidence document. Ignored when creating a dispute evidence document. - name: createdDate | type: string | description: Date and time the dispute evidence document was created. - name: updatedDate | type: string | description: Date and time the dispute evidence document was updated. - name: disputeId | type: string | description: GUID of the dispute this evidence document supports. - name: file | type: DocumentFile | description: File details for the uploaded evidence document. If a file hasn't been uploaded yet, this field is `null`. - name: filename | type: string | description: Name of the uploaded evidence file. - name: size | type: string | description: Size of the uploaded evidence file in bytes. - name: checksum | type: string | description: Hexadecimal checksum of the uploaded file. - name: extendedFields | type: ExtendedFields | description: Custom field data for the dispute evidence document 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 evidence document 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 evidence document Retrieves a specific evidence document by its ID ```curl curl -X GET \ 'https://www.wixapis.com/dispute-evidence-documents/v1/dispute-evidence-documents/87654321-4321-4321-4321-210987654321' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.disputes.DisputeEvidenceDocumentService.getDisputeEvidenceDocument(disputeEvidenceDocumentId) Description: Retrieves a dispute evidence document. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: disputeEvidenceDocumentId Method parameters: param name: disputeEvidenceDocumentId | type: string | description: GUID of the dispute evidence document to retrieve. | required: true Return type: PROMISE - name: _id | type: string | description: Dispute evidence document GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the dispute evidence document is updated. To prevent conflicting changes, the existing revision must be specified when updating a dispute evidence document. Ignored when creating a dispute evidence document. - name: _createdDate | type: Date | description: Date and time the dispute evidence document was created. - name: _updatedDate | type: Date | description: Date and time the dispute evidence document was updated. - name: disputeId | type: string | description: GUID of the dispute this evidence document supports. - name: file | type: DocumentFile | description: File details for the uploaded evidence document. If a file hasn't been uploaded yet, this field is `null`. - name: filename | type: string | description: Name of the uploaded evidence file. - name: size | type: string | description: Size of the uploaded evidence file in bytes. - name: checksum | type: string | description: Hexadecimal checksum of the uploaded file. - name: extendedFields | type: ExtendedFields | description: Custom field data for the dispute evidence document 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 evidence document 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 ### getDisputeEvidenceDocument ```javascript import { disputeEvidenceDocuments } from '@wix/payments'; async function getDisputeEvidenceDocument(disputeEvidenceDocumentId) { const response = await disputeEvidenceDocuments.getDisputeEvidenceDocument(disputeEvidenceDocumentId); }; ``` ### getDisputeEvidenceDocument (with elevated permissions) ```javascript import { disputeEvidenceDocuments } from '@wix/payments'; import { auth } from '@wix/essentials'; async function myGetDisputeEvidenceDocumentMethod(disputeEvidenceDocumentId) { const elevatedGetDisputeEvidenceDocument = auth.elevate(disputeEvidenceDocuments.getDisputeEvidenceDocument); const response = await elevatedGetDisputeEvidenceDocument(disputeEvidenceDocumentId); } ``` ### getDisputeEvidenceDocument (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 { disputeEvidenceDocuments } from '@wix/payments'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { disputeEvidenceDocuments }, // Include the auth strategy and host as relevant }); async function getDisputeEvidenceDocument(disputeEvidenceDocumentId) { const response = await myWixClient.disputeEvidenceDocuments.getDisputeEvidenceDocument(disputeEvidenceDocumentId); }; ``` ---