Returns the active documents that your credentials can access, ordered by title. With
archived=true, it returns only the archived documents. archivedCount is the number of
archived documents that match the kind and title filters. If your credentials can access
only some workspaces, usedInCount and lastUsedAt count only disputes in those workspaces.
Returns 404 when the evidenceLibraryEnabled feature flag is off.
You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>.
These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.
Only documents of this kind.
Kind of library document. terms and policy documents are attached to every dispute; productDescription documents to not-as-described disputes.
Always matchingReasonCodes. Payrails attaches a document to a new dispute when the dispute's card network reason code is one of the document's reasonCodes. allDisputes is no longer returned.
The card network reason codes this document helps defend. Payrails AI suggests them when you add the document or a new version, and you can change them. null until Payrails AI or a person sets them. An empty list means that no reason code applies.
A card network reason code. Visa: 10.4 other fraud, card-absent; 13.1 merchandise or services not received; 13.2 cancelled recurring transaction; 13.3 not as described or defective; 13.6 credit not processed; 13.7 cancelled merchandise or services. Mastercard: 4837 no cardholder authorization; 4853 cardholder dispute; 4855 goods or services not provided.
Who set reasonCodes. ai: Payrails AI. user: a person on your team in the Payrails portal. client: your system through the API. null until the reason codes are set. Payrails AI never replaces reason codes that a person or your system set.
When a dispute last started to use a version of the document. If your credentials can access only some workspaces, only disputes in those workspaces count.
All versions of the document, oldest first. Returned by Add document (version 1 only), Get document, Add version, Archive document and Archive version. List documents does not return it.
The 100 disputes that most recently started to use the document, newest first, with the version each one uses. A dispute that uses two versions appears twice. usedInCount is the total number of disputes. Returned by Get document, Add version, Archive document and Archive version. To see every dispute, use List the disputes that use an evidence library document.
The changes to the document, newest first, with who made each change and when. Returned by Get document only. For documents changed before this history existed, it shows only what their stored dates show. An archive and restore that happened before then does not appear.
What changed. created: the document was added with version 1. versionAdded: a new version was added. archived: the document was archived. versionArchived: one version was archived. When it was the last version that was not archived, the document was archived with it. restored: the document, or one archived version, was restored. renamed: the title changed; note holds the previous title. reasonCodesChanged: the reason codes changed; previousReasonCodes and reasonCodes hold the codes before and after.
user: a person on your team made the change in the Payrails portal. client: your software made the change through the API with your API credentials. system: Payrails made the change, or Payrails could not tell who made it. ai: Payrails AI made the change.
On reasonCodesChanged, the reason codes before the change. Absent when the document had no reason codes yet.
A card network reason code. Visa: 10.4 other fraud, card-absent; 13.1 merchandise or services not received; 13.2 cancelled recurring transaction; 13.3 not as described or defective; 13.6 credit not processed; 13.7 cancelled merchandise or services. Mastercard: 4837 no cardholder authorization; 4853 cardholder dispute; 4855 goods or services not provided.
On reasonCodesChanged, the reason codes after the change. An empty list means that no reason code applies.
A card network reason code. Visa: 10.4 other fraud, card-absent; 13.1 merchandise or services not received; 13.2 cancelled recurring transaction; 13.3 not as described or defective; 13.6 credit not processed; 13.7 cancelled merchandise or services. Mastercard: 4837 no cardholder authorization; 4853 cardholder dispute; 4855 goods or services not provided.
Number of archived documents that match the kind and title filters.
Required range: x >= 0
Example:
2
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Payrails Docs","description":"Developer and operator documentation for Payrails, the payment operating system for global enterprises: payment orchestration across providers, PCI-compliant tokenization, analytics and reporting, Chargebacks, and the Payrails REST API.","colors":{"primary":"#D63D00","light":"#E4853A"},"logo":{"light":"https://mintcdn.com/payrails-42074109/knNnlxc2J__TB9tW/logo/light.svg?fit=max\u0026auto=format\u0026n=knNnlxc2J__TB9tW\u0026q=85\u0026s=2692c29175ef45b637b4e2df6e2da330","dark":"https://mintcdn.com/payrails-42074109/knNnlxc2J__TB9tW/logo/dark.svg?fit=max\u0026auto=format\u0026n=knNnlxc2J__TB9tW\u0026q=85\u0026s=651119b7fb40dda938e2f9a7a276ee1c"},"favicon":"https://mintcdn.com/payrails-42074109/zqk7oWHZbW3YniA1/favicon.png?fit=max\u0026auto=format\u0026n=zqk7oWHZbW3YniA1\u0026q=85\u0026s=70b0991c3a7ad3c2faa4530e27040cf8","api":{"params":{"expanded":"all","post":["nullable","x-internal"]},"playground":{"display":"simple"},"examples":{"defaults":"required","prefill":true,"autogenerate":true},"url":"full"},"appearance":{"default":"light"},"navbar":{"links":[{"href":"https://www.payrails.com","label":"Go to payrails.com"}],"primary":{"type":"button","label":"Book a demo","href":"https://www.payrails.com/contact"}},"footer":{"socials":{"x":"https://x.com/Payrails_com","github":"https://github.com/payrails","linkedin":"https://www.linkedin.com/company/payrails"},"links":[{"header":"Company","items":[{"label":"payrails.com","href":"https://www.payrails.com"}]}]},"seo":{"metatags":{"og:locale":"en_US","twitter:site":"@Payrails_com","msvalidate.01":"7723ABF900EAD08F0500790E9BFC62E7"},"organization":{"id":"https://www.payrails.com#organization","name":"Payrails","legalName":"Payrails GmbH","url":"https://www.payrails.com/","logo":"https://www.payrails.com/payrails-logo.svg","sameAs":["https://www.linkedin.com/company/payrails/","https://www.crunchbase.com/organization/payrails","https://www.wikidata.org/wiki/Q137211152","https://x.com/Payrails_com"]}},"styling":{"eyebrows":"breadcrumbs","latex":false},"integrations":{"cookies":{"key":"mintlify_telemetry_enabled","value":"true"}},"contextual":{"options":["copy","view","download-spec","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/payrails-42074109/_AaiU-jGVknFpls9/images/common/og-thumbnail-bg-v5.png?fit=max\u0026auto=format\u0026n=_AaiU-jGVknFpls9\u0026q=85\u0026s=b08b137c9aa7638918675c41a07b33c6"},"interaction":{"drilldown":true},"metadata":{"timestamp":true},"markdown":{"instructions":["Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code.","Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it.","Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code.","Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation.","Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent.","Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format.","Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code."]},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"payrails-42074109","hasAudioNarration":false,"actualSubdomain":"payrails-42074109","customDomains":["docs.payrails.com"],"gitSource":{"type":"github","owner":"payrails","repo":"docs-payrails-com","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af5a25f9b695fda38d39860","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Connections","count":232},{"language":"default","tag":"Payment Orchestration","count":226},{"language":"default","tag":"API Reference","count":192},{"language":"default","tag":"Payment methods","count":146},{"language":"default","tag":"Guides","count":129},{"language":"default","tag":"Payment providers","count":59},{"language":"default","tag":"Dispute","count":57},{"language":"default","tag":"Disputes","count":57},{"language":"default","tag":"SDKs","count":38},{"language":"default","tag":"Payment","count":28}],"searchSettings":{"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"type":"link","url":"https://www.payrails.com/contact"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":false},"customCss":[{"filePath":"css/styles.css","content":"*,:before,:after{box-sizing:border-box}:before,:after{--tw-content: \"\"}html,:host{-webkit-text-size-adjust:100%;tab-size:4;font-feature-settings:normal;font-variation-settings:normal;-webkit-tap-highlight-color:transparent;font-family:ui-sans-serif,\n system-ui,\n sans-serif,\n Apple Color Emoji,\n Segoe UI Emoji,\n Segoe UI Symbol,\n Noto Color Emoji;line-height:1.5}body{line-height:inherit;margin:0}hr{height:0;color:inherit;border-top-width:1px}abbr:where([title]){-webkit-text-decoration:underline dotted;text-decoration:underline dotted}a{color:inherit}b,strong{font-weight:bolder}code,kbd,samp,pre{font-feature-settings:normal;font-variation-settings:normal;font-family:ui-monospace,\n SFMono-Regular,\n Menlo,\n Monaco,\n Consolas,\n Liberation Mono,\n Courier New,\n monospace;font-size:1em}small{font-size:80%}sub,sup{vertical-align:baseline;font-size:75%;line-height:0;position:relative}sub{bottom:-0.25em}sup{top:-0.5em}table{text-indent:0;border-color:inherit;border-collapse:collapse}button,select{text-transform:none}:-moz-focusring{outline:auto}:-moz-ui-invalid{box-shadow:none}#page-context-menu-button{border-radius:var(--border-radius-sm) 0 0 var(--border-radius-sm)}#page-context-menu-button+button,#page-context-menu-button+*+button{border-left:none;border-radius:0 var(--border-radius-sm) var(--border-radius-sm) 0}.peer:not(.is-custom) [data-docs-theme] header+div,header#navbar>div.mx-auto{margin:0 auto;max-width:100rem}[data-active-nav-item=\"true\"]>button,[data-active-nav-item=\"true\"]>a{color:var(--accent)}#navbar>div.mx-auto div.h-16{height:calc(var(--spacing) * 13)}#navbar>div.mx-auto div.h-12{height:calc(var(--spacing) * 8)}@media (min-width: 1024px){#sidebar-content{margin-top:calc(var(--mintlify-slot-header-height, 7rem) - var(--spacing) * 21)}}#navbar>div.mx-auto button.h-9{height:calc(var(--spacing) * 8)}#topbar-cta-button a>div{height:calc(var(--spacing) * 8);padding:0 calc(var(--spacing) * 3.5);border:1px solid rgb(var(--gray-400) / 0.3);border-radius:8px;background:rgb(var(--background-light));color:rgb(var(--gray-500))}#topbar-cta-button a svg{display:none}#topbar-cta-button a:hover>div{color:rgb(var(--gray-800))}html.dark #topbar-cta-button a>div{border-color:rgb(var(--gray-600) / 0.3);background:rgb(var(--background-dark));color:rgb(var(--gray-300))}html.dark #topbar-cta-button a:hover>div{color:rgb(var(--gray-100))}#navbar.peer.is-not-custom.is-not-wide.is-not-center+div,#navbar+div .page-content{max-width:100rem;margin:0 auto}#content-container>div.max-w-5xl{max-width:70rem}.mdx-content a{color:var(--accent);text-decoration:none;\u0026:hover,\u0026:focus{color:var(--link-hover)}\u0026:active,\u0026:active:hover{color:var(--link-active)}}.mdx-content a.link:not(:has(div,img,picture)):not(.not-prose *){border-bottom:0;text-decoration-line:underline;text-decoration-thickness:max(1px, 0.0625rem);text-underline-offset:0.2em;text-decoration-skip-ink:auto;text-decoration-color:color-mix(in srgb, currentColor 70%, transparent);\u0026:hover,\u0026:focus,\u0026:has(>code){text-decoration-color:currentColor}}.callout .prose :where(h1,h2,h3,h4):not(:where([class~=\"not-prose\"],[class~=\"not-prose\"] *)){margin-top:0}#content-area>#content{margin-bottom:calc(var(--spacing) * 8)}#content-area>:is(#content,[id^=\"api-playground\"])+div:not([id]){padding-bottom:calc(var(--spacing) * 6)}#footer.advanced-footer>div{padding-bottom:calc(var(--spacing) * 8);padding-top:calc(var(--spacing) * 8);gap:calc(var(--spacing) * 4)}#footer [data-testid=\"mode-switch-light\"],#footer [data-testid=\"mode-switch-dark\"],#footer [data-testid=\"mode-switch-system\"]{display:none}@media (min-width: 1024px){[role=\"group\"]:has(>[data-theme-preference-value]){width:fit-content;gap:2px;padding:1px}[role=\"group\"]>[data-theme-preference-value]{width:1.5rem;height:1.5rem}}html:not(.dark) #sidebar-content a.text-gray-700{color:rgb(var(--gray-700))}html:not(.dark) #sidebar-content a.text-gray-700:hover{color:rgb(var(--gray-950))}#navigation-items li>button[aria-expanded]{width:100%}#navigation-items li>button[aria-expanded]>div:first-child:has(>svg){order:1}#navigation-items li>button[aria-expanded]>div:first-child>svg{width:0.75rem}#navigation-items li>button[aria-expanded]>div:first-child>svg:not(.text-primary){color:rgb(var(--gray-500) / 0.8)}html.dark #navigation-items li>button[aria-expanded]>div:first-child>svg:not(.text-primary){color:rgb(var(--gray-400))}@media (hover: hover){#navigation-items li>button[aria-expanded]:hover>div:first-child>svg,html.dark #navigation-items li>button[aria-expanded]:hover>div:first-child>svg{color:inherit}}#navigation-items ul ul{margin-left:-0.5rem}html.dark :is(#content,#header>.prose,#table-of-contents),html.dark :is(#navbar,#sidebar-content,#content-area) .dark\\:text-gray-400,html.dark #footer a.dark\\:text-white\\/50{color:rgb(var(--gray-300))}html.dark :is(#navbar,#sidebar-content,#content-area) .dark\\:text-gray-400:hover,html.dark #footer a.dark\\:text-white\\/50:hover,html.dark #table-of-contents .toc-item:not([data-active])>a:hover{color:rgb(var(--gray-100))}html.dark #search-bar-entry{color:rgb(var(--gray-400))}html.dark #footer .dark\\:bg-gray-600{background-color:rgb(var(--gray-400))}html.dark #footer .dark\\:bg-gray-600:hover{background-color:rgb(var(--gray-200))}html.dark .sidebar-group-icon[src*=\"/images/icons/nav/\"]{filter:invert(0.9)}html:not(.dark) .nav-tag-pill-text{color:var(--button-primary-bg-active)}html:not(.dark) .text-green-700.bg-green-400\\/20{color:#166534}html:not(.dark) .text-yellow-700.bg-yellow-400\\/20{color:#854d0e}html:not(.dark) .text-orange-700.bg-orange-400\\/20{color:#9a3412}.text-\\[\\#FFFFFF\\].bg-\\[\\#2AB673\\]{background-color:#15803d}.text-\\[\\#FFFFFF\\].bg-\\[\\#C28C30\\]{background-color:#a16207}.text-\\[\\#FFFFFF\\].bg-\\[\\#DA622B\\]{background-color:#c2410c}html:not(.dark) [data-component-part=\"field-required-pill\"]{color:#b91c1c}html:not(.dark) [data-component-part=\"code-group-tab-bar\"] .text-gray-500:not(:hover){color:rgb(var(--gray-600))}html:not(.dark) [data-component-part=\"code-group-tab-bar\"] .text-primary{color:var(--button-primary-bg-hover)}html:not(.dark) [data-component-part=\"field-info-pill\"] .text-stone-400{color:rgb(var(--gray-600))}html.dark [data-component-part=\"field-info-pill\"] .dark\\:text-stone-500{color:rgb(var(--gray-400))}html.dark :is(#navbar a.dark\\:text-gray-200,#content-area a.dark\\:text-gray-50){color:rgb(var(--gray-50))}html.dark #content-area a.dark\\:text-gray-50:hover{color:var(--accent)}html.dark #content-area a.dark\\:text-gray-50>svg{color:rgb(var(--gray-400))}#table-of-contents .toc-item[data-active]>a{color:var(--accent)}@layer theme{.peer.is-custom~#footer.advanced-footer{display:flex!important;margin-top:auto!important}div:has(>.peer.is-custom~#footer.advanced-footer){display:flex!important;flex-direction:column;min-height:100vh}}#sidebar-content img[src^=\"https://assets.payrails.io/img/logos/\"],#sidebar-content img[src*=\"/images/icons/letters/\"],#sidebar-content img[src*=\"/images/icons/nav/\"]:not(.sidebar-group-icon){width:1.5rem;height:1.5rem;--tile-radius: 0.375rem;border-radius:var(--tile-radius)}#sidebar-content img[src*=\"/images/icons/nav/\"]:not(.sidebar-group-icon){padding:3px;background:var(--tag-neutral-bg)}#sidebar-content img[src^=\"https://assets.payrails.io/img/logos/\"],#sidebar-content img[src*=\"/images/icons/letters/\"],.prose img.page-logo,.provider-card-logo,.payment-method-logo{--tile: var(--tag-neutral-bg);--r: calc(var(--tile-radius) - 1px);background:radial-gradient(circle at 100% 100%, var(--tile) calc(var(--r) - 0.5px), transparent var(--r)) 1px 1px / var(--r) var(--r) no-repeat,\n radial-gradient(circle at 0 100%, var(--tile) calc(var(--r) - 0.5px), transparent var(--r)) calc(100% - 1px) 1px / var(--r) var(--r) no-repeat,\n radial-gradient(circle at 100% 0, var(--tile) calc(var(--r) - 0.5px), transparent var(--r)) 1px calc(100% - 1px) / var(--r) var(--r) no-repeat,\n radial-gradient(circle at 0 0, var(--tile) calc(var(--r) - 0.5px), transparent var(--r)) calc(100% - 1px) calc(100% - 1px) / var(--r) var(--r) no-repeat,\n linear-gradient(var(--tile), var(--tile)) center / calc(100% - 2px) calc(100% - 2 * var(--r)) no-repeat,\n linear-gradient(var(--tile), var(--tile)) center / calc(100% - 2 * var(--r)) calc(100% - 2px) no-repeat}@media (max-width: 767px){.expandable-content{margin:0!important;padding-left:6px!important;padding-right:0!important}.expandable-content .expandable{border-right:0;border-top-right-radius:0;border-bottom-right-radius:0}.expandable-content .expandable-content{min-width:16rem}.expandable-content:not(.expandable-content *){overflow-x:auto}.expandable-content .prose{padding-right:12px}.param-head div{min-width:0}[data-component-part=\"field-info-pill\"]{display:inline-block!important;max-width:100%;vertical-align:bottom}[data-component-part=\"field-info-pill\"]>span{display:-webkit-box;-webkit-box-orient:vertical;-webkit-line-clamp:2;line-clamp:2;overflow:hidden}}.page-logos{display:flex;gap:0.75rem;margin:-1rem 0 1.75rem}.prose .page-logos picture{margin:0}.prose img.page-logo{display:block;width:3.5rem;height:3.5rem;margin:0;--tile-radius: 0.75rem;border-radius:var(--tile-radius);object-fit:contain}@media (prefers-reduced-motion: no-preference){html{scroll-behavior:smooth}}"},{"filePath":"css/vars.css","content":":root{--pr-orange: #d63d00;--pr-black: #000;--pr-white: #fff;--pr-heritage: #0a6cff;--pr-antalya-sea: #597991;--pr-dublin-ale: #e4853a;--pr-baku-brass: #8a725c;--pr-cairo-sand: #d6cbc1;--accent: rgb(var(--primary));--link-active: var(--button-primary-bg-active);--link-hover: var(--button-primary-bg-hover);--main-color: var(--pr-orange);--background: var(--pr-white);--badge-new-bg: #ffedd5;--badge-new-text: #ad3100;--bento-media-gradient-end: #100;--bento-media-gradient-start: #f34f12;--border-radius-sm: 4px;--border-hover: #d1d1d1;--border-subtle: #e5e5e5;--button-focus-outline: #09090b;--button-ghost-bg-active: #e4e4e7;--button-ghost-bg-hover: #f4f4f5;--button-ghost-text: #18181b;--button-primary-bg: var(--main-color);--button-primary-bg-active: #a32e00;--button-primary-bg-hover: #be3600;--button-primary-text: #fff;--button-quaternary-bg: #fff;--button-quaternary-bg-active: #e4e4e7;--button-quaternary-bg-hover: #f4f4f5;--button-quaternary-text: #18181b;--button-secondary-bg: transparent;--button-secondary-bg-active: #fadcc0;--button-secondary-bg-hover: #ffedd5;--button-secondary-border: #ad3100;--button-secondary-text: #ad3100;--button-tertiary-bg: #fff2e1;--button-tertiary-bg-active: #fed7aa;--button-tertiary-bg-hover: #ffedd5;--button-tertiary-text: #ad3100;--capability-chip-bg: #f0f6ff;--capability-chip-border: #d8e6ff;--capability-chip-text: #002e99;--container-gutter-default: 16px;--container-gutter-lg: 32px;--container-max-2xl: 1360px;--foreground: #000;--logo-fallback-0-bg: #eff6ff;--logo-fallback-0-text: #1d4ed8;--logo-fallback-1-bg: #f0fdf4;--logo-fallback-1-text: #15803d;--logo-fallback-2-bg: #fffbeb;--logo-fallback-2-text: #b45309;--logo-fallback-3-bg: #faf5ff;--logo-fallback-3-text: #7e22ce;--logo-fallback-4-bg: #fff1f2;--logo-fallback-4-text: #be123c;--logo-fallback-5-bg: #ecfeff;--logo-fallback-5-text: #0e7490;--status-in-progress: #f0b400;--status-in-progress-bg: #fff4d1;--status-in-progress-text: #7e6612;--status-live: #2ba027;--status-live-bg: #dbf6da;--status-live-text: #207c40;--surface-1: #fff;--surface-2: #f5f5f5;--surface-warm: #f1f0ec;--tag-neutral-bg: #f6f7fa;--tag-neutral-border: #f0f2f6;--tag-neutral-text: #3f4d67;--text-muted: #404040;--text-soft: #666c79;--text-strong: #171717;--text-subtle: #9ca3af}html.dark{--accent: rgb(var(--primary-light));--link-active: #c96f28;--link-hover: #f0a266}"},{"filePath":"snippets/general/card.css","content":".pr-card-group{container-type:inline-size;display:grid;gap:var(--space-4, 16px);margin:var(--space-4, 16px) 0}.pr-card-group--cols-1{grid-template-columns:1fr}.pr-card-group--cols-2{grid-template-columns:repeat(2, minmax(0, 1fr))}.pr-card-group--cols-3{grid-template-columns:repeat(3, minmax(0, 1fr))}.pr-card-group--cols-4{grid-template-columns:repeat(4, minmax(0, 1fr))}@container (max-width: 620px){.pr-card-group--cols-3,.pr-card-group--cols-4{grid-template-columns:repeat(2, minmax(0, 1fr))}}@container (max-width: 340px){.pr-card-group{grid-template-columns:1fr}}.pr-card{display:flex;flex-direction:column;height:100%;overflow:hidden;border:1px solid #e5e5e5;border-radius:1rem;background-color:#fff;box-shadow:0 1px 2px 0 rgb(0 0 0 / 0.05);text-decoration:none;transition:transform 0.2s ease,\n background 0.2s ease,\n box-shadow 0.2s ease}.pr-card:hover{background-color:#f5f5f5;box-shadow:0 10px 15px -3px rgb(0 0 0 / 0.1),\n 0 4px 6px -4px rgb(0 0 0 / 0.1)}.pr-card__image{display:block;background-size:cover;width:100%;height:auto;aspect-ratio:16 / 9;margin:0;object-fit:cover;background-color:#f3f4f6}.pr-card__body{display:flex;flex-direction:column;gap:0.5rem;height:100%;padding:1.5rem}.pr-card__header{display:flex;align-items:center;gap:0.5rem}.pr-card__icon{display:flex;flex-shrink:0;align-items:center;justify-content:center;width:2.5rem;height:2.5rem;border-radius:1rem;background-color:rgb(var(--primary) / 0.1);color:var(--accent)}.pr-card__body:not(:first-child){border-top:1px solid #e5e5e5}.pr-card__title{margin:0;font-size:1.25rem;font-weight:600;line-height:1.25rem;color:var(--foreground)}.pr-card__text{margin:0;font-size:0.875rem;font-weight:400;line-height:1.5rem;color:var(--text-muted)}.dark .pr-card{border-color:#262626;background-color:#171717}.dark .pr-card:hover,.dark .pr-card__image{background-color:#262626}.dark .pr-card__body:not(:first-child){border-top-color:#404040}.dark .pr-card__icon{background-color:#262626}.dark .pr-card__title{color:#fff}.dark .pr-card__text{color:#f5f5f5}.pr-card.hover-zoom{transform:scale(1);\u0026:hover,\u0026:focus{transform:scale(1.05) translateY(-2%)}}@media (prefers-reduced-motion: reduce){.pr-card.hover-zoom{transform:none;\u0026:hover,\u0026:focus{transform:none}}}.provider-card{display:flex;align-items:center;gap:0.75rem;text-align:left}.provider-card-logo{display:block;width:2.5rem;height:2.5rem;flex-shrink:0;overflow:hidden;--tile-radius: 0.5rem;border-radius:var(--tile-radius)}.provider-card-logo img{width:100%;height:100%;margin:0;object-fit:contain}.provider-card-logo-fallback{display:flex;align-items:center;justify-content:center;width:100%;height:100%;background:var(--tag-neutral-bg);color:var(--tag-neutral-text);font-size:1.25rem;font-weight:600;line-height:1}.provider-card-name,.provider-card-type{margin:0}.provider-card-name{font-weight:600}.provider-card-type{font-size:0.875rem;line-height:1.25rem;color:rgb(var(--gray-500))}.dark .provider-card-type{color:rgb(var(--gray-400))}"},{"filePath":"snippets/payment-methods/explorer.css","content":".payment-methods-explorer:empty{min-height:3000px}.payment-method-logo{display:inline-flex;width:28px;height:28px;flex-shrink:0;overflow:hidden;--tile-radius: 0.375rem;border-radius:var(--tile-radius)}.payment-method-logo img{width:100%;height:100%;margin:0;object-fit:contain}"},{"filePath":"snippets/integrations/filterable-list.css","content":".integrations-filter{container-type:inline-size}.integrations-filter:empty::before{content:\"\";display:block;height:184px}@container (min-width: 310px){.integrations-filter:empty::before{height:140px}}@container (min-width: 364px){.integrations-filter:empty::before{height:96px}}@container (min-width: 665px){.integrations-filter:empty::before{height:52px}}.integration-card{display:flex;flex-direction:column}.integration-card>.card{flex:1}.integration-card[hidden]{display:none!important}"}],"page":{"pagePath":"reference/listevidencedocuments","slug":"/reference/listevidencedocuments","pageMetadata":{"title":"List evidence library documents","description":"List evidence library documents by title, each with its current version, the number of disputes that use it, and when it was last used.","deprecated":null,"version":null,"sidebarTitle":"List evidence library documents","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/evidence-documents","href":"/reference/listevidencedocuments","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"List evidence library documents by title, each with its current version, the number of disputes that use it, and when it was last used.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`Returns the active documents that your credentials can access, ordered by title. With\n`,_jsx(_components.code,{children:`archived=true`}),`, it returns only the archived documents. `,_jsx(_components.code,{children:`archivedCount`}),` is the number of\narchived documents that match the `,_jsx(_components.code,{children:`kind`}),` and `,_jsx(_components.code,{children:`title`}),` filters. If your credentials can access\nonly some workspaces, `,_jsx(_components.code,{children:`usedInCount`}),` and `,_jsx(_components.code,{children:`lastUsedAt`}),` count only disputes in those workspaces.\nReturns 404 when the `,_jsx(_components.code,{children:`evidenceLibraryEnabled`}),` feature flag is off.`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List evidence library documents","description":"List evidence library documents by title, each with its current version, the number of disputes that use it, and when it was last used.","deprecated":null,"version":null,"sidebarTitle":"List evidence library documents","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/evidence-documents","href":"/reference/listevidencedocuments","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/payrails-42074109/138fc948c6832630/consent.js","/_mintlify/custom/payrails-42074109/6a6f8c8ba4227cb9/same-tab-links.js","/_mintlify/custom/payrails-42074109/6e438b650fe2798f/noindex-other-hosts.js"],"openApiReferenceData":{"operation":{"summary":"List evidence library documents","operationId":"listEvidenceDocuments","description":"List evidence library documents by title, each with its current version, the number of disputes that use it, and when it was last used.","x-mint":{"content":"Returns the active documents that your credentials can access, ordered by title. With\n`archived=true`, it returns only the archived documents. `archivedCount` is the number of\narchived documents that match the `kind` and `title` filters. If your credentials can access\nonly some workspaces, `usedInCount` and `lastUsedAt` count only disputes in those workspaces.\nReturns 404 when the `evidenceLibraryEnabled` feature flag is off.\n","href":"/reference/listevidencedocuments","metadata":{"sidebarTitle":"List evidence library documents"}},"tags":["Disputes"],"security":["d422ef0c-3d07-4e49-a160-20626e0b7475"],"parameters":["2bf85118-bb43-4093-b6d8-a610e2db0354","fccf03f2-6631-4517-96dd-30bb9792b6ba","dc0d85d1-805a-4d3a-a79d-5d57f9fdf3f1"],"responses":{"200":"e28b065b-ea99-44e2-a5c7-71a8813fe2a5","400":"01cdb7c4-ebb9-4008-a517-b8fba15ce6f8","401":"33930801-7f92-472a-99d1-2a686401a33a","403":"d0d2ffad-a78d-4316-9b43-df4a7f0feeb5","404":"883892fc-085a-472e-a31d-70a4f0224a37","422":"34acb666-bcbd-40ec-ba81-5be946d2a5c6","429":"45ca1ed7-4103-471b-aefa-dc5821aa2195","500":"42f44b0e-044c-4960-bf86-36afc28614c8"},"method":"get","type":"path","servers":["9dfea23c-cc1c-41a6-884a-31ad4a771d46"],"path":"/dispute/disputes/evidence-documents","baseUrlOptions":["https://api.eu.staging.payrails.io"],"title":"List evidence library documents","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"urlDisplay":"full"},"dependencies":{"parameters":{"2bf85118-bb43-4093-b6d8-a610e2db0354":{"name":"kind","in":"query","required":false,"description":"Only documents of this kind.","schema":{"type":"string","description":"Only documents of this kind.\nKind of library document. `terms` and `policy` documents are attached to every dispute; `productDescription` documents to not-as-described disputes.\n","enum":["terms","policy","productDescription"],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"fccf03f2-6631-4517-96dd-30bb9792b6ba":{"name":"title","in":"query","required":false,"description":"Case-insensitive substring of the title.","schema":{"type":"string","maxLength":200,"isRequired":false,"description":"Case-insensitive substring of the title.","uniqueKey":"","typeLabel":"string"}},"dc0d85d1-805a-4d3a-a79d-5d57f9fdf3f1":{"name":"archived","in":"query","required":false,"description":"Set to `true` to list only archived documents. Leave it out, or set it to `false`, to list only active documents.","schema":{"type":"boolean","default":false,"isRequired":false,"description":"Set to `true` to list only archived documents. Leave it out, or set it to `false`, to list only active documents.","uniqueKey":"","typeLabel":"boolean"}}},"responses":{"e28b065b-ea99-44e2-a5c7-71a8813fe2a5":{"description":"Evidence library documents.","content":{"application/json":{"schema":{"type":"object","required":["results","archivedCount"],"properties":{"results":{"type":"array","items":{"type":"object","required":["id","kind","title","attachedTo","createdAt","updatedAt","usedInCount"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"results.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"kind":{"type":"string","description":"Kind of library document. `terms` and `policy` documents are attached to every dispute; `productDescription` documents to not-as-described disputes.\n","enum":["terms","policy","productDescription"],"isRequired":true,"uniqueKey":"results.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"title":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].title","typeLabel":"string"},"attachedTo":{"type":"string","deprecated":true,"description":"Always `matchingReasonCodes`. Payrails attaches a document to a new dispute when the dispute's card network reason code is one of the document's `reasonCodes`. `allDisputes` is no longer returned.","enum":["matchingReasonCodes","allDisputes"],"isRequired":true,"uniqueKey":"results.items.[INDEX].attachedTo","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"results.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"results.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"usedInCount":{"type":"integer","description":"Number of disputes that use any version of the document. If your credentials can access only some workspaces, only disputes in those workspaces count.","isRequired":true,"uniqueKey":"results.items.[INDEX].usedInCount","typeLabel":"integer"},"workspaceId":{"type":"string","format":"uuid","description":"Absent when the document applies to every workspace.","uniqueKey":"results.items.[INDEX].workspaceId","typeLabel":"string\u003cuuid>"},"reasonCodes":{"oneOf":[{"type":"array","description":"The card network reason codes this document helps defend. Payrails AI suggests them when you add the document or a new version, and you can change them. `null` until Payrails AI or a person sets them. An empty list means that no reason code applies.","items":{"type":"string","description":"A card network reason code. Visa: `10.4` other fraud, card-absent; `13.1` merchandise or services not received; `13.2` cancelled recurring transaction; `13.3` not as described or defective; `13.6` credit not processed; `13.7` cancelled merchandise or services. Mastercard: `4837` no cardholder authorization; `4853` cardholder dispute; `4855` goods or services not provided.","enum":["10.4","13.1","13.2","13.3","13.6","13.7","4837","4853","4855"],"uniqueKey":"results.items.[INDEX].reasonCodes.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"results.items.[INDEX].reasonCodes.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","description":"The card network reason codes this document helps defend. Payrails AI suggests them when you add the document or a new version, and you can change them. `null` until Payrails AI or a person sets them. An empty list means that no reason code applies.","items":{"type":"string","description":"A card network reason code. Visa: `10.4` other fraud, card-absent; `13.1` merchandise or services not received; `13.2` cancelled recurring transaction; `13.3` not as described or defective; `13.6` credit not processed; `13.7` cancelled merchandise or services. Mastercard: `4837` no cardholder authorization; `4853` cardholder dispute; `4855` goods or services not provided.","enum":["10.4","13.1","13.2","13.3","13.6","13.7","4837","4853","4855"]},"uniqueKey":"results.items.[INDEX].reasonCodes.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].reasonCodes","typeLabel":"enum\u003cstring>[] | null"},"reasonCodesSetBy":{"oneOf":[{"type":"string","description":"Who set `reasonCodes`. `ai`: Payrails AI. `user`: a person on your team in the Payrails portal. `client`: your system through the API. `null` until the reason codes are set. Payrails AI never replaces reason codes that a person or your system set.","enum":["ai","user","client",null],"uniqueKey":"results.items.[INDEX].reasonCodesSetBy.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Who set `reasonCodes`. `ai`: Payrails AI. `user`: a person on your team in the Payrails portal. `client`: your system through the API. `null` until the reason codes are set. Payrails AI never replaces reason codes that a person or your system set.","enum":["ai","user","client",null],"uniqueKey":"results.items.[INDEX].reasonCodesSetBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].reasonCodesSetBy","typeLabel":"enum\u003cstring> | null"},"archivedAt":{"type":"string","format":"date-time","uniqueKey":"results.items.[INDEX].archivedAt","typeLabel":"string\u003cdate-time>"},"currentVersion":{"description":"The latest version that is not archived. New disputes get this version. Absent when every version is archived.","type":"object","required":["evidenceId","version","validFrom","contentType","contentLength","createdAt"],"properties":{"evidenceId":{"type":"string","format":"uuid","description":"ID of the stored file of this version.","isRequired":true,"uniqueKey":"results.items.[INDEX].currentVersion.evidenceId","typeLabel":"string\u003cuuid>"},"version":{"type":"integer","format":"int64","minimum":1,"isRequired":true,"uniqueKey":"results.items.[INDEX].currentVersion.version","typeLabel":"integer\u003cint64>"},"validFrom":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Payrails ignores it.","isRequired":true,"uniqueKey":"results.items.[INDEX].currentVersion.validFrom","typeLabel":"string\u003cdate-time>"},"contentType":{"type":"string","example":"application/pdf","isRequired":true,"uniqueKey":"results.items.[INDEX].currentVersion.contentType","typeLabel":"string"},"contentLength":{"type":"integer","isRequired":true,"uniqueKey":"results.items.[INDEX].currentVersion.contentLength","typeLabel":"integer"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"results.items.[INDEX].currentVersion.createdAt","typeLabel":"string\u003cdate-time>"},"changeNote":{"type":"string","uniqueKey":"results.items.[INDEX].currentVersion.changeNote","typeLabel":"string"},"summary":{"oneOf":[{"type":"string","description":"A short summary of this version, written by Payrails AI. `null` until Payrails AI writes it, or when Payrails AI is off for your account.","uniqueKey":"results.items.[INDEX].currentVersion.summary.oneOf.0","typeLabel":"string"},{"type":"null","description":"A short summary of this version, written by Payrails AI. `null` until Payrails AI writes it, or when Payrails AI is off for your account.","uniqueKey":"results.items.[INDEX].currentVersion.summary.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].currentVersion.summary","typeLabel":"string | null"},"archivedAt":{"type":"string","format":"date-time","description":"Set when the version is archived. Payrails never attaches an archived version.","uniqueKey":"results.items.[INDEX].currentVersion.archivedAt","typeLabel":"string\u003cdate-time>"},"links":{"type":"object","description":"Returned only by Get document (on each item of `versions`) and Get version.","properties":{"download":{"oneOf":[{"type":"string","description":"Temporary link to the version's file. When it expires, get the document or the version again for a new link.","uniqueKey":"results.items.[INDEX].currentVersion.links.download.oneOf.0","typeLabel":"string"},{"type":"object","description":"Temporary link to the version's file. When it expires, get the document or the version again for a new link.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].currentVersion.links.download.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"results.items.[INDEX].currentVersion.links.download.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"uniqueKey":"results.items.[INDEX].currentVersion.links.download.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].currentVersion.links.download","typeLabel":"string | object"}},"uniqueKey":"results.items.[INDEX].currentVersion.links","typeLabel":"object"}},"uniqueKey":"results.items.[INDEX].currentVersion","typeLabel":"object"},"lastUsedAt":{"type":"string","format":"date-time","description":"When a dispute last started to use a version of the document. If your credentials can access only some workspaces, only disputes in those workspaces count.","uniqueKey":"results.items.[INDEX].lastUsedAt","typeLabel":"string\u003cdate-time>"},"versions":{"type":"array","description":"All versions of the document, oldest first. Returned by Add document (version 1 only), Get document, Add version, Archive document and Archive version. List documents does not return it.","items":{"type":"object","required":["evidenceId","version","validFrom","contentType","contentLength","createdAt"],"properties":{"evidenceId":{"type":"string","format":"uuid","description":"ID of the stored file of this version.","isRequired":true,"uniqueKey":"results.items.[INDEX].versions.items.[INDEX].evidenceId","typeLabel":"string\u003cuuid>"},"version":{"type":"integer","format":"int64","minimum":1,"isRequired":true,"uniqueKey":"results.items.[INDEX].versions.items.[INDEX].version","typeLabel":"integer\u003cint64>"},"validFrom":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Payrails ignores it.","isRequired":true,"uniqueKey":"results.items.[INDEX].versions.items.[INDEX].validFrom","typeLabel":"string\u003cdate-time>"},"contentType":{"type":"string","example":"application/pdf","isRequired":true,"uniqueKey":"results.items.[INDEX].versions.items.[INDEX].contentType","typeLabel":"string"},"contentLength":{"type":"integer","isRequired":true,"uniqueKey":"results.items.[INDEX].versions.items.[INDEX].contentLength","typeLabel":"integer"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"results.items.[INDEX].versions.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"changeNote":{"type":"string","uniqueKey":"results.items.[INDEX].versions.items.[INDEX].changeNote","typeLabel":"string"},"summary":{"oneOf":[{"type":"string","description":"A short summary of this version, written by Payrails AI. `null` until Payrails AI writes it, or when Payrails AI is off for your account.","uniqueKey":"results.items.[INDEX].versions.items.[INDEX].summary.oneOf.0","typeLabel":"string"},{"type":"null","description":"A short summary of this version, written by Payrails AI. `null` until Payrails AI writes it, or when Payrails AI is off for your account.","uniqueKey":"results.items.[INDEX].versions.items.[INDEX].summary.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].versions.items.[INDEX].summary","typeLabel":"string | null"},"archivedAt":{"type":"string","format":"date-time","description":"Set when the version is archived. Payrails never attaches an archived version.","uniqueKey":"results.items.[INDEX].versions.items.[INDEX].archivedAt","typeLabel":"string\u003cdate-time>"},"links":{"type":"object","description":"Returned only by Get document (on each item of `versions`) and Get version.","properties":{"download":{"oneOf":[{"type":"string","description":"Temporary link to the version's file. When it expires, get the document or the version again for a new link.","uniqueKey":"results.items.[INDEX].versions.items.[INDEX].links.download.oneOf.0","typeLabel":"string"},{"type":"object","description":"Temporary link to the version's file. When it expires, get the document or the version again for a new link.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].versions.items.[INDEX].links.download.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"results.items.[INDEX].versions.items.[INDEX].links.download.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"uniqueKey":"results.items.[INDEX].versions.items.[INDEX].links.download.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].versions.items.[INDEX].links.download","typeLabel":"string | object"}},"uniqueKey":"results.items.[INDEX].versions.items.[INDEX].links","typeLabel":"object"}},"uniqueKey":"results.items.[INDEX].versions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].versions","typeLabel":"object[]"},"usages":{"type":"array","description":"The 100 disputes that most recently started to use the document, newest first, with the version each one uses. A dispute that uses two versions appears twice. `usedInCount` is the total number of disputes. Returned by Get document, Add version, Archive document and Archive version. To see every dispute, use List the disputes that use an evidence library document.","maxItems":100,"items":{"type":"object","required":["disputeId","evidenceId","version","linkedAt"],"properties":{"disputeId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"results.items.[INDEX].usages.items.[INDEX].disputeId","typeLabel":"string\u003cuuid>"},"evidenceId":{"type":"string","format":"uuid","description":"ID of the stored file of the version that the dispute uses.","isRequired":true,"uniqueKey":"results.items.[INDEX].usages.items.[INDEX].evidenceId","typeLabel":"string\u003cuuid>"},"version":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"results.items.[INDEX].usages.items.[INDEX].version","typeLabel":"integer\u003cint64>"},"linkedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"results.items.[INDEX].usages.items.[INDEX].linkedAt","typeLabel":"string\u003cdate-time>"},"providerReference":{"type":"string","description":"The payment provider's reference of the dispute.","uniqueKey":"results.items.[INDEX].usages.items.[INDEX].providerReference","typeLabel":"string"},"merchantReference":{"type":"string","uniqueKey":"results.items.[INDEX].usages.items.[INDEX].merchantReference","typeLabel":"string"},"reasonCode":{"type":"string","uniqueKey":"results.items.[INDEX].usages.items.[INDEX].reasonCode","typeLabel":"string"},"schemeReasonCode":{"type":"string","uniqueKey":"results.items.[INDEX].usages.items.[INDEX].schemeReasonCode","typeLabel":"string"},"stage":{"type":"string","enum":["Created","FraudReport","Retrieval","Chargeback","PreArbitration","Arbitration","Unknown"],"description":"Stage of the dispute.","uniqueKey":"results.items.[INDEX].usages.items.[INDEX].stage","typeLabel":"enum\u003cstring>"},"chargebackStatus":{"type":"string","enum":["Incoming","Executed","Reversed","SecondChargeback","IssuerReponseTimeframeExpired","ArbitrationReversed"],"description":"Status of the chargeback.","uniqueKey":"results.items.[INDEX].usages.items.[INDEX].chargebackStatus","typeLabel":"enum\u003cstring>"},"defenseStatus":{"type":"string","enum":["NotDefendable","Undefended","ReadyToSubmit","Submitted","Failed","UnderReview","Won","Lost","Accepted","Resolved","Unknown"],"description":"Status of the defense.","uniqueKey":"results.items.[INDEX].usages.items.[INDEX].defenseStatus","typeLabel":"enum\u003cstring>"}},"uniqueKey":"results.items.[INDEX].usages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].usages","typeLabel":"object[]"},"history":{"type":"array","description":"The changes to the document, newest first, with who made each change and when. Returned by Get document only. For documents changed before this history existed, it shows only what their stored dates show. An archive and restore that happened before then does not appear.","items":{"type":"object","required":["event","actor","at"],"properties":{"event":{"type":"string","description":"What changed. `created`: the document was added with version 1. `versionAdded`: a new version was added. `archived`: the document was archived. `versionArchived`: one version was archived. When it was the last version that was not archived, the document was archived with it. `restored`: the document, or one archived version, was restored. `renamed`: the title changed; `note` holds the previous title. `reasonCodesChanged`: the reason codes changed; `previousReasonCodes` and `reasonCodes` hold the codes before and after.","enum":["created","versionAdded","archived","versionArchived","restored","renamed","reasonCodesChanged"],"isRequired":true,"uniqueKey":"results.items.[INDEX].history.items.[INDEX].event","typeLabel":"enum\u003cstring>"},"actor":{"oneOf":[{"type":"object","description":"Who made the change. It is `null` for a change made before Payrails recorded who made each change.","required":["type"],"properties":{"type":{"type":"string","description":"`user`: a person on your team made the change in the Payrails portal. `client`: your software made the change through the API with your API credentials. `system`: Payrails made the change, or Payrails could not tell who made it. `ai`: Payrails AI made the change.","enum":["user","client","system","ai"],"isRequired":true,"uniqueKey":"results.items.[INDEX].history.items.[INDEX].actor.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"The ID of the user. Only for a `user`.","uniqueKey":"results.items.[INDEX].history.items.[INDEX].actor.oneOf.0.id","typeLabel":"string\u003cuuid>"},"email":{"type":"string","format":"email","description":"The email of the user. Only for a `user`. It is absent when Payrails cannot find the user.","uniqueKey":"results.items.[INDEX].history.items.[INDEX].actor.oneOf.0.email","typeLabel":"string\u003cemail>"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].history.items.[INDEX].actor.oneOf.0","typeLabel":"object"},{"type":"null","description":"Who made the change. It is `null` for a change made before Payrails recorded who made each change.","isRequired":true,"uniqueKey":"results.items.[INDEX].history.items.[INDEX].actor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].history.items.[INDEX].actor","typeLabel":"object | null"},"at":{"type":"string","format":"date-time","description":"When the change was made.","isRequired":true,"uniqueKey":"results.items.[INDEX].history.items.[INDEX].at","typeLabel":"string\u003cdate-time>"},"version":{"type":"integer","format":"int64","minimum":1,"description":"The version that was added, archived or restored. A restore has a version only when it restored that version.","uniqueKey":"results.items.[INDEX].history.items.[INDEX].version","typeLabel":"integer\u003cint64>"},"note":{"type":"string","description":"On `versionAdded`, what changed in the new version. On `renamed`, the previous title.","uniqueKey":"results.items.[INDEX].history.items.[INDEX].note","typeLabel":"string"},"previousReasonCodes":{"type":"array","description":"On `reasonCodesChanged`, the reason codes before the change. Absent when the document had no reason codes yet.","items":{"type":"string","description":"A card network reason code. Visa: `10.4` other fraud, card-absent; `13.1` merchandise or services not received; `13.2` cancelled recurring transaction; `13.3` not as described or defective; `13.6` credit not processed; `13.7` cancelled merchandise or services. Mastercard: `4837` no cardholder authorization; `4853` cardholder dispute; `4855` goods or services not provided.","enum":["10.4","13.1","13.2","13.3","13.6","13.7","4837","4853","4855"],"uniqueKey":"results.items.[INDEX].history.items.[INDEX].previousReasonCodes.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"results.items.[INDEX].history.items.[INDEX].previousReasonCodes","typeLabel":"enum\u003cstring>[]"},"reasonCodes":{"type":"array","description":"On `reasonCodesChanged`, the reason codes after the change. An empty list means that no reason code applies.","items":{"type":"string","description":"A card network reason code. Visa: `10.4` other fraud, card-absent; `13.1` merchandise or services not received; `13.2` cancelled recurring transaction; `13.3` not as described or defective; `13.6` credit not processed; `13.7` cancelled merchandise or services. Mastercard: `4837` no cardholder authorization; `4853` cardholder dispute; `4855` goods or services not provided.","enum":["10.4","13.1","13.2","13.3","13.6","13.7","4837","4853","4855"],"uniqueKey":"results.items.[INDEX].history.items.[INDEX].reasonCodes.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"results.items.[INDEX].history.items.[INDEX].reasonCodes","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"results.items.[INDEX].history.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].history","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results","typeLabel":"object[]"},"archivedCount":{"type":"integer","minimum":0,"description":"Number of archived documents that match the `kind` and `title` filters.","example":2,"isRequired":true,"uniqueKey":"archivedCount","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"results":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","kind":"terms","title":"\u003cstring>","attachedTo":"matchingReasonCodes","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","usedInCount":123,"workspaceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","reasonCodes":["10.4"],"reasonCodesSetBy":"ai","archivedAt":"2023-11-07T05:31:56Z","currentVersion":{"evidenceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","version":2,"validFrom":"2023-11-07T05:31:56Z","contentType":"application/pdf","contentLength":123,"createdAt":"2023-11-07T05:31:56Z","changeNote":"\u003cstring>","summary":"\u003cstring>","archivedAt":"2023-11-07T05:31:56Z","links":{"download":"\u003cstring>"}},"lastUsedAt":"2023-11-07T05:31:56Z","versions":[{"evidenceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","version":2,"validFrom":"2023-11-07T05:31:56Z","contentType":"application/pdf","contentLength":123,"createdAt":"2023-11-07T05:31:56Z","changeNote":"\u003cstring>","summary":"\u003cstring>","archivedAt":"2023-11-07T05:31:56Z","links":{"download":"\u003cstring>"}}],"usages":[{"disputeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","evidenceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","version":123,"linkedAt":"2023-11-07T05:31:56Z","providerReference":"\u003cstring>","merchantReference":"\u003cstring>","reasonCode":"\u003cstring>","schemeReasonCode":"\u003cstring>","stage":"Created","chargebackStatus":"Incoming","defenseStatus":"NotDefendable"}],"history":[{"event":"created","actor":{"type":"user","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","email":"jsmith@example.com"},"at":"2023-11-07T05:31:56Z","version":2,"note":"\u003cstring>","previousReasonCodes":["10.4"],"reasonCodes":["10.4"]}]}],"archivedCount":2}}},"exampleType":"generated"}},"exampleType":"generated"},"01cdb7c4-ebb9-4008-a517-b8fba15ce6f8":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.malformed","detail":"The request has malformed syntax","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestmalformed"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.malformed","detail":"The request has malformed syntax","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestmalformed"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"33930801-7f92-472a-99d1-2a686401a33a":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.unauthorized","detail":"The request lacks necessary credentials to perform the specified action","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestunauthorized"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.unauthorized","detail":"The request lacks necessary credentials to perform the specified action","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestunauthorized"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"d0d2ffad-a78d-4316-9b43-df4a7f0feeb5":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"e7db22b3-914e-4975-928e-9edfb0885bea","code":"request.forbidden","detail":"The request credentials lack the required permissions to perform the specified action","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestforbidden"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"e7db22b3-914e-4975-928e-9edfb0885bea","code":"request.forbidden","detail":"The request credentials lack the required permissions to perform the specified action","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestforbidden"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"883892fc-085a-472e-a31d-70a4f0224a37":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.not-found","detail":"The requested resource was not found","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestnot-found"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.not-found","detail":"The requested resource was not found","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestnot-found"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"34acb666-bcbd-40ec-ba81-5be946d2a5c6":{"description":"Unprocessable Entity.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"07a1d642-dbf5-47d3-8563-700514b38e46","code":"request.header.missing","detail":"The request is missing a required header","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestheadermissing"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"07a1d642-dbf5-47d3-8563-700514b38e46","code":"request.header.missing","detail":"The request is missing a required header","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestheadermissing"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"45ca1ed7-4103-471b-aefa-dc5821aa2195":{"description":"Too Many Requests.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.rate-limit","detail":"Too many requests","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestrate-limit"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.rate-limit","detail":"Too many requests","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestrate-limit"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"42f44b0e-044c-4960-bf86-36afc28614c8":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"internal","detail":"An internal error occurred","docUrl":"https://docs.payrails.com/docs/resources/error-codes#internal"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"internal","detail":"An internal error occurred","docUrl":"https://docs.payrails.com/docs/resources/error-codes#internal"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"d422ef0c-3d07-4e49-a160-20626e0b7475":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"You can use an OAuth2 JWT bearer token in the `Authorization` header of your API requests for supported endpoints: `Authorization: Bearer \u003cYOUR_JWT_HERE>`.\nThese tokens are valid for 10 minutes and can be requested via the [access token endpoint](#operation/getOAuthToken) endpoint.\n","scopes":["disputeevidences:list"],"schemeName":"BearerToken"}}},"servers":{"9dfea23c-cc1c-41a6-884a-31ad4a771d46":{"url":"https://api.eu.staging.payrails.io","description":"Payrails environment."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"You can use an OAuth2 JWT bearer token in the `Authorization` header of your API requests for supported endpoints: `Authorization: Bearer \u003cYOUR_JWT_HERE>`.\nThese tokens are valid for 10 minutes and can be requested via the [access token endpoint](#operation/getOAuthToken) endpoint.\n","scopes":["disputeevidences:list"],"schemeName":"BearerToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"You can use an OAuth2 JWT bearer token in the `Authorization` header of your API requests for supported endpoints: `Authorization: Bearer \u003cYOUR_JWT_HERE>`.\nThese tokens are valid for 10 minutes and can be requested via the [access token endpoint](#operation/getOAuthToken) endpoint.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerToken","name":"Authorization"}],"title":"BearerToken"}]},"originalFileLocation":"https://cdn.payrails.io/docs/api/openapi.min.json"},"subdomain":"payrails-42074109","siteName":"Payrails Docs","title":"List evidence library documents - Payrails Docs","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"reference/listevidencedocuments.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"List evidence library documents by title, each with its current version, the number of disputes that use it, and when it was last used.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Payrails Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List evidence library documents - Payrails Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"List evidence library documents by title, each with its current version, the number of disputes that use it, and when it was last used.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Payrails Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.payrails.com/reference/listevidencedocuments\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://payrails-42074109.mintlify.site/_mintlify/api/og/v2?division=Disputes\u0026amp;title=List+evidence+library+documents\u0026amp;description=List+evidence+library+documents+by+title%2C+each+with+its+current+version%2C+the+number+of+disputes+that+use+it%2C+and+when+it+was+last+used.\u0026amp;theme=fc36d2d43704e46c9451c8d9\u0026amp;signature=1ae26ac654bc3d3504b95b7a473100228c90165058289a8ddc9edc0fbe977daa\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List evidence library documents - Payrails Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List evidence library documents by title, each with its current version, the number of disputes that use it, and when it was last used.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://payrails-42074109.mintlify.site/_mintlify/api/og/v2?division=Disputes\u0026amp;title=List+evidence+library+documents\u0026amp;description=List+evidence+library+documents+by+title%2C+each+with+its+current+version%2C+the+number+of+disputes+that+use+it%2C+and+when+it+was+last+used.\u0026amp;theme=fc36d2d43704e46c9451c8d9\u0026amp;signature=1ae26ac654bc3d3504b95b7a473100228c90165058289a8ddc9edc0fbe977daa\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Payrails Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#D63D00\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"msvalidate.01\" content=\"7723ABF900EAD08F0500790E9BFC62E7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.payrails.com/reference/listevidencedocuments\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/listevidencedocuments.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.payrails.com#organization\",\"name\":\"Payrails\",\"legalName\":\"Payrails GmbH\",\"url\":\"https://www.payrails.com/\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://www.payrails.com/payrails-logo.svg\"},\"sameAs\":[\"https://www.linkedin.com/company/payrails/\",\"https://www.crunchbase.com/organization/payrails\",\"https://www.wikidata.org/wiki/Q137211152\",\"https://x.com/Payrails_com\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.payrails.com#website\",\"name\":\"Payrails Docs\",\"url\":\"https://docs.payrails.com\",\"publisher\":{\"@id\":\"https://www.payrails.com#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.payrails.com/reference/listevidencedocuments#webpage\",\"url\":\"https://docs.payrails.com/reference/listevidencedocuments\",\"name\":\"List evidence library documents\",\"description\":\"List evidence library documents by title, each with its current version, the number of disputes that use it, and when it was last used.\",\"isPartOf\":{\"@id\":\"https://docs.payrails.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.payrails.com/reference/listevidencedocuments#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.payrails.com/reference/listevidencedocuments#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Dispute\",\"item\":\"https://docs.payrails.com/reference/listdisputes\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Disputes\",\"item\":\"https://docs.payrails.com/reference/listdisputes\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List evidence library documents\",\"item\":\"https://docs.payrails.com/reference/listevidencedocuments\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.payrails.com/reference/listevidencedocuments#apireference\",\"headline\":\"List evidence library documents\",\"name\":\"List evidence library documents\",\"description\":\"List evidence library documents by title, each with its current version, the number of disputes that use it, and when it was last used.\",\"url\":\"https://docs.payrails.com/reference/listevidencedocuments\",\"mainEntityOfPage\":{\"@id\":\"https://docs.payrails.com/reference/listevidencedocuments#webpage\"},\"publisher\":{\"@id\":\"https://www.payrails.com#organization\"},\"isPartOf\":{\"@id\":\"https://docs.payrails.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Payrails Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Payrails\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/reference/listevidencedocuments.md","siteName":"Payrails Docs","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/explore-payrails"}]},{"tab":"Connections","pages":[{"title":"Connections","href":"/docs/connections"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/docs/sdks"}]},{"tab":"API Reference","groups":[{"group":"Payrails API Reference","pages":[{"title":"Getting started","href":"/reference"},{"group":"Schemas","pages":[{"title":"Meta","href":"/reference/meta"},{"title":"Funds Transfer","href":"/reference/fundstransfer"},{"group":"Workflow Schemas","expanded":false,"pages":[{"title":"Create Execution Response","href":"/reference/createexecutionresponse"},{"title":"Enrollment Payment Composition","href":"/reference/enrollmentpaymentcomposition"},{"title":"Payment Composition","href":"/reference/paymentcomposition"},{"title":"Payout Composition","href":"/reference/payoutcomposition"},{"title":"Pending Payment Composition","href":"/reference/pendingpaymentcomposition"},{"title":"Resolved Rulesets","href":"/reference/resolvedrulesets"},{"title":"Rule Evaluation","href":"/reference/ruleevaluation"},{"title":"Step Next Actions","href":"/reference/workflowstepnextactions"}]}]},{"group":"SDK Reference","expanded":false,"pages":[{"group":"Web SDK","pages":[{"title":"Web SDK Event API Reference","sidebarTitle":"Events","href":"/docs/orchestration/checkout-sdks/web/references/event-api-reference"},{"title":"Web SDK Appearance API Reference","sidebarTitle":"Appearance","href":"/docs/orchestration/checkout-sdks/web/references/appearance-api-reference"},{"title":"Web SDK Payrails Class Reference","sidebarTitle":"Payrails class","href":"/docs/orchestration/checkout-sdks/web/references/payrails-api-reference"}]},{"title":"iOS SDK API Reference","sidebarTitle":"iOS SDK","href":"/docs/orchestration/checkout-sdks/ios/sdk-api-reference"},{"title":"Android SDK API Reference","sidebarTitle":"Android SDK","href":"/docs/orchestration/checkout-sdks/android/api-reference"},{"title":"React Native SDK API Reference","sidebarTitle":"React Native SDK","href":"/docs/orchestration/checkout-sdks/react-native/api-references"}]}]},{"group":"Get started","pages":[{"group":"Authentication","pages":[{"title":"Request an access token","deprecated":null,"version":null,"sidebarTitle":"Request an access token","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /auth/token/{clientId}","href":"/reference/getoauthtoken"},{"title":"Request a Vault access token","deprecated":null,"version":null,"sidebarTitle":"Request a Vault access token","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /token/auth","href":"/reference/getvaultaccesstoken"}]},{"group":"Client","pages":[{"title":"Initialize a client SDK","deprecated":null,"version":null,"sidebarTitle":"Initialize a client SDK","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/client/init","href":"/reference/clientinit"}]},{"group":"SSO Connections","pages":[{"title":"List SSO connections","deprecated":null,"version":null,"sidebarTitle":"List SSO connections","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /auth/sso/connections","href":"/reference/listssoconnections"},{"title":"Create SSO connection","deprecated":null,"version":null,"sidebarTitle":"Create SSO connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /auth/sso/connections","href":"/reference/createssoconnection"},{"title":"Get SSO connection","deprecated":null,"version":null,"sidebarTitle":"Get SSO connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /auth/sso/connections/{connectionId}","href":"/reference/getssoconnectionbyid"},{"title":"Update SSO connection","deprecated":null,"version":null,"sidebarTitle":"Update SSO connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /auth/sso/connections/{connectionId}","href":"/reference/patchssoconnection"},{"title":"Get SAML IdP configuration values","deprecated":null,"version":null,"sidebarTitle":"Get SAML IdP configuration values","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /auth/sso/connections/saml-configs","href":"/reference/listsamlconnectionconfigs"}]}]},{"group":"Workflow","pages":[{"group":"Workflows","pages":[{"title":"Search \u0026 list workflow configurations","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list workflow configurations","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}","href":"/reference/listworkflowconfigurations"},{"title":"Create a workflow configuration","deprecated":null,"version":null,"sidebarTitle":"Create a workflow configuration","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}","href":"/reference/createworkflowconfiguration"},{"title":"Get a workflow configuration","deprecated":null,"version":null,"sidebarTitle":"Get a workflow configuration","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/versions/{workflowVersion}","href":"/reference/getworkflowconfigurationversion"},{"title":"Updates a workflow configuration version","deprecated":null,"version":null,"sidebarTitle":"Updates a workflow configuration version","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /merchant/workflows/{workflowCode}/versions/{workflowVersion}","href":"/reference/patchworkflowconfigurationversion"},{"title":"Get the default workflow configuration","deprecated":null,"version":null,"sidebarTitle":"Get the default workflow configuration","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/versions/default","href":"/reference/getdefaultworkflowconfigurationversion"},{"title":"Update the default workflow configuration","deprecated":null,"version":null,"sidebarTitle":"Update the default workflow configuration","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /merchant/workflows/{workflowCode}/versions/default","href":"/reference/setdefaultworkflowconfigurationversion"}]},{"group":"Executions","pages":[{"title":"Search \u0026 list executions","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list executions","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/executions","href":"/reference/listexecutions"},{"title":"Create an execution","deprecated":null,"version":null,"sidebarTitle":"Create an execution","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions","href":"/reference/createexecution"},{"title":"Get an execution by ID","deprecated":null,"version":null,"sidebarTitle":"Get an execution by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/executions/{executionId}","href":"/reference/getexecution"}]},{"group":"Actions","pages":[{"title":"Lookup payment options","deprecated":null,"version":null,"sidebarTitle":"Lookup payment options","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/lookup","href":"/reference/lookupaction"},{"title":"Start a payment session","deprecated":null,"version":null,"sidebarTitle":"Start a payment session","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/startPaymentSession","href":"/reference/startpaymentsessionaction"},{"title":"Authorize a payment","deprecated":null,"version":null,"sidebarTitle":"Authorize a payment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/authorize","href":"/reference/authorizeaction"},{"title":"Confirm a payment","deprecated":null,"version":null,"sidebarTitle":"Confirm a payment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/confirm","href":"/reference/confirmaction"},{"title":"Cancel a payment","deprecated":null,"version":null,"sidebarTitle":"Cancel a payment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/cancel","href":"/reference/cancelaction"},{"title":"Capture a payment","deprecated":null,"version":null,"sidebarTitle":"Capture a payment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/capture","href":"/reference/captureaction"},{"title":"Refund a payment","deprecated":null,"version":null,"sidebarTitle":"Refund a payment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/refund","href":"/reference/refundaction"},{"title":"Create a payout","deprecated":null,"version":null,"sidebarTitle":"Create a payout","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/payout","href":"/reference/payoutaction"},{"title":"Search \u0026 list events","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list events","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/executions/{executionId}/history","href":"/reference/getworkflowhistory"},{"title":"List actions of an execution","deprecated":null,"version":null,"sidebarTitle":"List actions of an execution","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/executions/{executionId}/actions","href":"/reference/getworkflowactions"},{"title":"Update fraud order status","deprecated":null,"version":null,"sidebarTitle":"Update fraud order status","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/orderUpdate","href":"/reference/fraudupdateaction"},{"title":"Search \u0026 list actions","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list actions","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/actions","href":"/reference/listactions"},{"title":"Get an action by ID","deprecated":null,"version":null,"sidebarTitle":"Get an action by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/actions/{actionId}","href":"/reference/getaction"}]}]},{"group":"Payment","pages":[{"group":"Payments","pages":[{"title":"Search \u0026 list payments","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list payments","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/payments","href":"/reference/listpayments"},{"title":"Get payment by ID","deprecated":null,"version":null,"sidebarTitle":"Get payment by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/payments/{paymentId}","href":"/reference/getpayment"},{"title":"Get Payment Operations by Payment ID","deprecated":null,"version":null,"sidebarTitle":"Get Payment Operations by Payment ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/payments/{paymentId}/operations","href":"/reference/getpaymentoperations"},{"title":"Get Payment Operation Logs by Payment Operation ID","deprecated":null,"version":null,"sidebarTitle":"Get Payment Operation Logs by Payment Operation ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/payments/{paymentId}/operations/{paymentOperationId}/logs","href":"/reference/getpaymentoperationlogs"}]},{"group":"Instruments","pages":[{"title":"Search \u0026 list instruments","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list instruments","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/instruments","href":"/reference/listinstruments"},{"title":"Create an instrument","deprecated":null,"version":null,"sidebarTitle":"Create an instrument","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/instruments","href":"/reference/createinstrument"},{"title":"Get an instrument by ID","deprecated":null,"version":null,"sidebarTitle":"Get an instrument by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/instruments/{instrumentId}","href":"/reference/getinstrument"},{"title":"Delete an instrument","deprecated":null,"version":null,"sidebarTitle":"Delete an instrument","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /payment/instruments/{instrumentId}","href":"/reference/deleteinstrument"},{"title":"Update an instrument","deprecated":null,"version":null,"sidebarTitle":"Update an instrument","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /payment/instruments/{instrumentId}","href":"/reference/updateinstrument"},{"title":"Provision a Network Token","deprecated":null,"version":null,"sidebarTitle":"Provision a Network Token","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/instruments/{instrumentId}/provisionNetworkToken","href":"/reference/provisionnetworktokenpublic"},{"title":"Generate cryptogram for a Network Token","deprecated":null,"version":null,"sidebarTitle":"Generate cryptogram for a Network Token","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/instruments/{instrumentId}/generateCryptogram","href":"/reference/generatecryptogram"}]},{"group":"Instrument Tokens","pages":[{"title":"Search \u0026 list tokens","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list tokens","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/instruments/{instrumentId}/tokens","href":"/reference/listtokens"},{"title":"Create a token","deprecated":null,"version":null,"sidebarTitle":"Create a token","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/instruments/{instrumentId}/tokens","href":"/reference/createtoken"},{"title":"Get a token by ID","deprecated":null,"version":null,"sidebarTitle":"Get a token by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/instruments/{instrumentId}/tokens/{tokenId}","href":"/reference/gettoken"},{"title":"Delete a token by ID","deprecated":null,"version":null,"sidebarTitle":"Delete a token by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /payment/instruments/{instrumentId}/tokens/{tokenId}","href":"/reference/deletetoken"},{"title":"Get a token by reference","deprecated":null,"version":null,"sidebarTitle":"Get a token by reference","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers/{providerId}/tokens/{tokenReference}","href":"/reference/gettokenfromprovider"},{"title":"Delete a token by reference","deprecated":null,"version":null,"sidebarTitle":"Delete a token by reference","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /payment/providers/{providerId}/tokens/{tokenReference}","href":"/reference/deletetokenfromprovider"}]},{"group":"BIN Lookup","pages":[{"title":"Get issuer info by BIN","deprecated":null,"version":null,"sidebarTitle":"Get issuer info by BIN","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/binLookup/{bin}","href":"/reference/getbinlookup"}]},{"group":"API Logs","pages":[{"title":"Search \u0026 list API Logs","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list API Logs","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/api/logs","href":"/reference/apilogs"},{"title":"Get an API Log event by ID","deprecated":null,"version":null,"sidebarTitle":"Get an API Log event by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/api/logs/{apiLogEventId}","href":"/reference/getapilogevent"}]},{"group":"Fraud Checks","pages":[{"title":"Search \u0026 list Fraud checks","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list Fraud checks","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/frauds","href":"/reference/listfraudchecks"},{"title":"Get Fraud check by ID","deprecated":null,"version":null,"sidebarTitle":"Get Fraud check by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/frauds/{fraudId}","href":"/reference/getfraud"},{"title":"Get Fraud Operations by Fraud ID","deprecated":null,"version":null,"sidebarTitle":"Get Fraud Operations by Fraud ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/frauds/{fraudId}/operations","href":"/reference/getfraudoperations"},{"title":"Get Fraud Operation Logs by Fraud Operation ID","deprecated":null,"version":null,"sidebarTitle":"Get Fraud Operation Logs by Fraud Operation ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/frauds/{fraudId}/operations/{fraudOperationId}/logs","href":"/reference/getfraudoperationlogs"}]},{"group":"3D Secure","pages":[{"title":"Search \u0026 list ThreeDS entities","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list ThreeDS entities","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/threeds","href":"/reference/listthreeds"},{"title":"Get ThreeDS authentication by ID","deprecated":null,"version":null,"sidebarTitle":"Get ThreeDS authentication by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/threeds/{threeDSId}","href":"/reference/getthreeds"},{"title":"Get ThreeDS Operations by ThreeDS ID","deprecated":null,"version":null,"sidebarTitle":"Get ThreeDS Operations by ThreeDS ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/threeds/{threeDSId}/operations","href":"/reference/getthreedsoperations"},{"title":"Get ThreeDS Operation Logs by ThreeDS Operation ID","deprecated":null,"version":null,"sidebarTitle":"Get ThreeDS Operation Logs by ThreeDS Operation ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/threeds/{threeDSId}/operation/{threeDSOperationId}/logs","href":"/reference/getthreedsoperationlogs"}]}]},{"group":"Provider","pages":[{"group":"Providers","pages":[{"title":"Search \u0026 list providers","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list providers","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers","href":"/reference/listproviders"},{"title":"Get provider by ID","deprecated":null,"version":null,"sidebarTitle":"Get provider by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers/{providerId}","href":"/reference/getprovider"}]},{"group":"Provider Configs","pages":[{"title":"List active provider configs","deprecated":null,"version":null,"sidebarTitle":"List active provider configs","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers/configs","href":"/reference/listactiveproviderconfigs"},{"title":"List Provider Configs by Provider","deprecated":null,"version":null,"sidebarTitle":"List Provider Configs by Provider","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers/{providerId}/configs","href":"/reference/listproviderconfigs"},{"title":"Create a provider config","deprecated":null,"version":null,"sidebarTitle":"Create a provider config","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/providers/{providerId}/configs","href":"/reference/createproviderconfig"},{"title":"Create a provider config with authenticated onboarding","deprecated":null,"version":null,"sidebarTitle":"Create a provider config with authenticated onboarding","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/providers/{providerId}/configs/authenticated","href":"/reference/createauthenticatedproviderconfig"},{"title":"Provider config by ID","deprecated":null,"version":null,"sidebarTitle":"Provider config by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers/{providerId}/configs/{providerConfigId}","href":"/reference/providerconfiggetbyid"},{"title":"Update a provider config","deprecated":null,"version":null,"sidebarTitle":"Update a provider config","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /payment/providers/{providerId}/configs/{providerConfigId}","href":"/reference/updateproviderconfig"},{"title":"Update a provider config status","deprecated":null,"version":null,"sidebarTitle":"Update a provider config status","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /payment/providers/{providerId}/configs/{providerConfigId}","href":"/reference/patchproviderconfig"},{"title":"Update a provider config with authenticated onboarding","deprecated":null,"version":null,"sidebarTitle":"Update a provider config with authenticated onboarding","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /payment/providers/{providerId}/configs/{providerConfigId}/authenticated","href":"/reference/updateauthenticatedproviderconfig"},{"title":"Create a provider config onboarding URL","deprecated":null,"version":null,"sidebarTitle":"Create a provider config onboarding URL","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/providers/{providerId}/configs/{providerConfigId}/onboarding-url","href":"/reference/createproviderconfigonboardingurl"}]}]},{"group":"Merchant","pages":[{"group":"Rulesets","pages":[{"title":"List Rulesets","deprecated":null,"version":null,"sidebarTitle":"List Rulesets","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/rulesets","href":"/reference/listrulesets"},{"title":"Create a new Ruleset","deprecated":null,"version":null,"sidebarTitle":"Create a new Ruleset","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/rulesets","href":"/reference/createruleset"},{"title":"Update a Ruleset","deprecated":null,"version":null,"sidebarTitle":"Update a Ruleset","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /merchant/rulesets/{rulesetId}","href":"/reference/updateruleset"},{"title":"Get a Ruleset","deprecated":null,"version":null,"sidebarTitle":"Get a Ruleset","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/rulesets/{rulesetId}/versions/{version}","href":"/reference/getruleset"}]},{"group":"Holders","pages":[{"title":"Search \u0026 list holders","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list holders","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/holders","href":"/reference/listholders"},{"title":"Create a holder","deprecated":null,"version":null,"sidebarTitle":"Create a holder","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/holders","href":"/reference/createholder"},{"title":"Get a holder by ID","deprecated":null,"version":null,"sidebarTitle":"Get a holder by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/holders/{holderId}","href":"/reference/getholder"}]},{"group":"Workspaces","pages":[{"title":"Fetch a list of workspaces","deprecated":null,"version":null,"sidebarTitle":"Fetch a list of workspaces","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workspaces","href":"/reference/getallworkspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"sidebarTitle":"Create a workspace","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workspaces","href":"/reference/createworkspace"},{"title":"Create workspaces","deprecated":null,"version":null,"sidebarTitle":"Create workspaces","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workspaces/bulk-create","href":"/reference/createworkspaces"},{"title":"Get a workspace by ID","deprecated":null,"version":null,"sidebarTitle":"Get a workspace by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workspaces/{workspaceId}","href":"/reference/getworkspace"}]},{"group":"Drop-in Links","pages":[{"title":"List drop-in links","deprecated":null,"version":null,"sidebarTitle":"List drop-in links","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/dropInLinks","href":"/reference/listdropinlinks"},{"title":"Create a drop-in link","deprecated":null,"version":null,"sidebarTitle":"Create a drop-in link","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/dropInLinks","href":"/reference/createdropinlink"},{"title":"Get a drop-in link","deprecated":null,"version":null,"sidebarTitle":"Get a drop-in link","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/dropInLinks/{dropInLinkId}","href":"/reference/getdropinlink"},{"title":"Delete a drop-in link","deprecated":null,"version":null,"sidebarTitle":"Delete a drop-in link","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /merchant/dropInLinks/{dropInLinkId}","href":"/reference/deletedropinlink"}]},{"group":"Apple Pay","pages":[{"title":"List Apple Pay web domains","deprecated":null,"version":null,"sidebarTitle":"List Apple Pay web domains","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/applepay/web/domains","href":"/reference/listapplepaywebdomains"},{"title":"Register an Apple Pay web domain","deprecated":null,"version":null,"sidebarTitle":"Register an Apple Pay web domain","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/applepay/web/domains","href":"/reference/registerapplepaywebdomain"}]}]},{"group":"Vault","pages":[{"group":"Vault Instant Proxy","pages":[{"title":"Execute an instant proxy request","deprecated":null,"version":null,"sidebarTitle":"Execute an instant proxy request","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/providers/{providerId}/proxy","href":"/reference/vaultproxy"}]},{"group":"Vault Proxy Connections","pages":[{"title":"Filter \u0026 list connections","deprecated":null,"version":null,"sidebarTitle":"Filter \u0026 list connections","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/connections","href":"/reference/listconnections"},{"title":"Create a connection","deprecated":null,"version":null,"sidebarTitle":"Create a connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /token/connections","href":"/reference/createvaultconnections"},{"title":"Invoke an outbound proxy connection","deprecated":null,"version":null,"sidebarTitle":"Invoke an outbound proxy connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /token/connections/{connectionId}/proxy","href":"/reference/outboundconnectioninvocation"},{"title":"Get connection details","deprecated":null,"version":null,"sidebarTitle":"Get connection details","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/connections/{connectionId}","href":"/reference/getconnection"},{"title":"Delete a connection","deprecated":null,"version":null,"sidebarTitle":"Delete a connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /token/connections/{connectionId}","href":"/reference/deleteconnection"},{"title":"Update connection details","deprecated":null,"version":null,"sidebarTitle":"Update connection details","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /token/connections/{connectionId}","href":"/reference/updateconnection"},{"title":"List connection versions for connection","deprecated":null,"version":null,"sidebarTitle":"List connection versions for connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/connections/{connectionId}/versions","href":"/reference/listconnectionversions"},{"title":"Create a new version of a connection","deprecated":null,"version":null,"sidebarTitle":"Create a new version of a connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /token/connections/{connectionId}/versions","href":"/reference/createvaultconnectionversions"},{"title":"Get connection version details","deprecated":null,"version":null,"sidebarTitle":"Get connection version details","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/connections/{connectionId}/versions/{connectionVersionId}","href":"/reference/connectionversiondetail"},{"title":"Set live version of a connection","deprecated":null,"version":null,"sidebarTitle":"Set live version of a connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /token/connections/{connectionId}/versions/live","href":"/reference/setliveversion"}]},{"group":"Vault Records and Aliases","pages":[{"title":"Tokenize records","deprecated":null,"version":null,"sidebarTitle":"Tokenize records","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /records/tokenize","href":"/reference/tokenizerecords"},{"title":"Detokenize records and aliases","deprecated":null,"version":null,"sidebarTitle":"Detokenize records and aliases","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /records/detokenize","href":"/reference/detokenizerecords"},{"title":"Get field details by alias","deprecated":null,"version":null,"sidebarTitle":"Get field details by alias","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/records/fields/{alias}","href":"/reference/fieldbyalias"},{"title":"Delete field by alias","deprecated":null,"version":null,"sidebarTitle":"Delete field by alias","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /token/records/fields/{alias}","href":"/reference/deletefieldbyalias"},{"title":"Get field details by alias list","deprecated":null,"version":null,"sidebarTitle":"Get field details by alias list","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/records/fields","href":"/reference/fieldsinfobyaliases"},{"title":"Get record and its fields by ID","deprecated":null,"version":null,"sidebarTitle":"Get record and its fields by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/records/{recordId}","href":"/reference/getrecord"},{"title":"Delete record by ID","deprecated":null,"version":null,"sidebarTitle":"Delete record by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /token/records/{recordId}","href":"/reference/deleterecord"},{"title":"Delete field by record ID and type","deprecated":null,"version":null,"sidebarTitle":"Delete field by record ID and type","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /token/records/{recordId}/fields/{fieldType}","href":"/reference/deletefieldbyrecordidandtype"},{"title":"Get record and its fields by alias","deprecated":null,"version":null,"sidebarTitle":"Get record and its fields by alias","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/records","href":"/reference/getrecordbyalias"},{"title":"Delete a record by the alias of one of its fields","deprecated":null,"version":null,"sidebarTitle":"Delete a record by the alias of one of its fields","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /token/records","href":"/reference/deleterecordbyalias"},{"title":"Get record and aliases for a given instrumentId.","deprecated":null,"version":null,"sidebarTitle":"Get record and aliases for a given instrumentId.","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/instruments/{instrumentId}/records","href":"/reference/recordsforinstrument"}]},{"group":"Vault Display SDK","pages":[{"title":"Initialize a Vault Client SDK","deprecated":null,"version":null,"sidebarTitle":"Initialize a Vault Client SDK","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /token/client/init","href":"/reference/vaultclientinit"}]},{"group":"Vault Public Encryption","pages":[{"title":"Get a public encryption key for tokenization","deprecated":null,"version":null,"sidebarTitle":"Get a public encryption key for tokenization","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/vault/info","href":"/reference/vaultpublicinfo"}]}]},{"group":"Analytics","pages":[{"group":"Files","pages":[{"title":"Get file by ID.","deprecated":null,"version":null,"sidebarTitle":"Get file by ID.","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /analytics/files/{fileId}","href":"/reference/getfilebyid"},{"title":"Get a URL for file upload.","deprecated":null,"version":null,"sidebarTitle":"Get a URL for file upload.","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /analytics/files/upload","href":"/reference/fileupload"}]}]},{"group":"Reporting","pages":[{"group":"Reports","pages":[{"title":"Search \u0026 list reports","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list reports","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /analytics/reports","href":"/reference/getreports"},{"title":"Get a report by ID","deprecated":null,"version":null,"sidebarTitle":"Get a report by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /analytics/reports/{reportId}","href":"/reference/getreport"}]},{"group":"Report Runs","pages":[{"title":"Search \u0026 list report runs","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list report runs","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /analytics/reportRuns","href":"/reference/listreportruns"},{"title":"Create a report run","deprecated":null,"version":null,"sidebarTitle":"Create a report run","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /analytics/reportRuns","href":"/reference/createreportrun"},{"title":"Get a report run by ID","deprecated":null,"version":null,"sidebarTitle":"Get a report run by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /analytics/reportRuns/{reportRunId}","href":"/reference/getreportrun"}]}]},{"group":"Reconciliation","pages":[{"group":"Reconciliation Records","pages":[{"title":"Bulk manually reconcile records","deprecated":null,"version":null,"sidebarTitle":"Bulk manually reconcile records","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /reconciliation/records/reconcile","href":"/reference/bulkmanualreconcilerecords"}]}]},{"group":"Dispute","pages":[{"group":"Disputes","pages":[{"title":"Search \u0026 list Disputes","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list Disputes","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes","href":"/reference/listdisputes"},{"title":"Bulk Replace Dispute Tags by Type","deprecated":null,"version":null,"sidebarTitle":"Bulk Replace Dispute Tags by Type","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /dispute/disputes/tags-bulk","href":"/reference/bulkreplacedisputetagsbytype"},{"title":"Bulk Attach Tags to Disputes","deprecated":null,"version":null,"sidebarTitle":"Bulk Attach Tags to Disputes","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/tags-bulk","href":"/reference/bulkattachdisputetags"},{"title":"List dispute service runs","deprecated":null,"version":null,"sidebarTitle":"List dispute service runs","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/runs","href":"/reference/listdisputeruns"},{"title":"Get a dispute service run by ID","deprecated":null,"version":null,"sidebarTitle":"Get a dispute service run by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/runs/{runId}","href":"/reference/getdisputerun"},{"title":"List Dispute Alert Enrollments","deprecated":null,"version":null,"sidebarTitle":"List Dispute Alert Enrollments","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alert-enrollments","href":"/reference/listdisputealertenrollments"},{"title":"Enroll Descriptors for Dispute Alerts","deprecated":null,"version":null,"sidebarTitle":"Enroll Descriptors for Dispute Alerts","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alert-enrollments","href":"/reference/enrolldisputealert"},{"title":"List Enrollment Descriptors","deprecated":null,"version":null,"sidebarTitle":"List Enrollment Descriptors","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alert-enrollments/{enrollmentId}/descriptors","href":"/reference/listenrollmentdescriptors"},{"title":"Add Descriptors to Enrollment","deprecated":null,"version":null,"sidebarTitle":"Add Descriptors to Enrollment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alert-enrollments/{enrollmentId}/descriptors","href":"/reference/adddescriptorstoenrollment"},{"title":"Unenroll a Descriptor","deprecated":null,"version":null,"sidebarTitle":"Unenroll a Descriptor","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alert-enrollments/{enrollmentId}/descriptors/{descriptorId}/unenroll","href":"/reference/unenrollenrollmentdescriptor"},{"title":"List Enrollment Events","deprecated":null,"version":null,"sidebarTitle":"List Enrollment Events","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alert-enrollments/{enrollmentId}/events","href":"/reference/listenrollmentevents"},{"title":"Search \u0026 list Dispute Alerts","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list Dispute Alerts","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alerts","href":"/reference/listdisputealerts"},{"title":"Get Dispute Alert by ID","deprecated":null,"version":null,"sidebarTitle":"Get Dispute Alert by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alerts/{alertId}","href":"/reference/getdisputealert"},{"title":"Action a Dispute Alert","deprecated":null,"version":null,"sidebarTitle":"Action a Dispute Alert","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alerts/{alertId}/action","href":"/reference/actiondisputealert"},{"title":"Manually Match a Payment to a Dispute Alert","deprecated":null,"version":null,"sidebarTitle":"Manually Match a Payment to a Dispute Alert","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alerts/{alertId}/match","href":"/reference/matchdisputealertpayment"},{"title":"Refund a Dispute Alert","deprecated":null,"version":null,"sidebarTitle":"Refund a Dispute Alert","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alerts/{alertId}/refund","href":"/reference/refunddisputealert"},{"title":"List Dispute Alert Events","description":"List the audit timeline of a pre-chargeback dispute alert, newest first, covering provider events, user actions, and system events with their actors.","deprecated":null,"version":null,"sidebarTitle":"List Dispute Alert Events","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alerts/{alertId}/events","href":"/reference/listdisputealertevents"},{"title":"List evidence library documents","deprecated":null,"version":null,"sidebarTitle":"List evidence library documents","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/evidence-documents","href":"/reference/listevidencedocuments"},{"title":"Add an evidence library document","description":"Add a terms, policy or product description document to the evidence library as version 1, and Payrails AI suggests its reason codes.","deprecated":null,"version":null,"sidebarTitle":"Add an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/evidence-documents","href":"/reference/createevidencedocument"},{"title":"Get an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Get an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/evidence-documents/{documentId}","href":"/reference/getevidencedocument"},{"title":"Update an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Update an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /dispute/disputes/evidence-documents/{documentId}","href":"/reference/renameevidencedocument"},{"title":"Add a version to an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Add a version to an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/evidence-documents/{documentId}/versions","href":"/reference/addevidencedocumentversion"},{"title":"Get a version of an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Get a version of an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/evidence-documents/{documentId}/versions/{version}","href":"/reference/getevidencedocumentversion"},{"title":"List the disputes that use an evidence library document","deprecated":null,"version":null,"sidebarTitle":"List the disputes that use an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/evidence-documents/{documentId}/usages","href":"/reference/listevidencedocumentusages"},{"title":"Archive an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Archive an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/evidence-documents/{documentId}/archive","href":"/reference/archiveevidencedocument"},{"title":"Restore an archived evidence library document","deprecated":null,"version":null,"sidebarTitle":"Restore an archived evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/evidence-documents/{documentId}/restore","href":"/reference/restoreevidencedocument"},{"title":"Archive one version of an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Archive one version of an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/evidence-documents/{documentId}/versions/{version}/archive","href":"/reference/archiveevidencedocumentversion"},{"title":"Restore one archived version of an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Restore one archived version of an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/evidence-documents/{documentId}/versions/{version}/restore","href":"/reference/restoreevidencedocumentversion"},{"title":"List evidence templates","deprecated":null,"version":null,"sidebarTitle":"List evidence templates","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/evidence-templates","href":"/reference/listevidencetemplates"},{"title":"Get Dispute by ID","deprecated":null,"version":null,"sidebarTitle":"Get Dispute by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}","href":"/reference/getdispute"},{"title":"Defend a Dispute","deprecated":null,"version":null,"sidebarTitle":"Defend a Dispute","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/defend","href":"/reference/defenddispute"},{"title":"Accept a Dispute","deprecated":null,"version":null,"sidebarTitle":"Accept a Dispute","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/accept","href":"/reference/acceptdispute"},{"title":"Get Dispute Activities by Dispute ID","deprecated":null,"version":null,"sidebarTitle":"Get Dispute Activities by Dispute ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}/activities","href":"/reference/getdisputeactivities"},{"title":"Get Dispute Documents by Dispute ID","deprecated":null,"version":null,"sidebarTitle":"Get Dispute Documents by Dispute ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}/documents","href":"/reference/getdisputedocuments"},{"title":"Search \u0026 list Evidences","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list Evidences","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}/evidences","href":"/reference/listdisputeevidences"},{"title":"Upload evidence files","deprecated":null,"version":null,"sidebarTitle":"Upload evidence files","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences","href":"/reference/uploaddisputeevidence"},{"title":"Classify an evidence file","deprecated":null,"version":null,"sidebarTitle":"Classify an evidence file","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/{evidenceId}/classify","href":"/reference/classifydisputeevidence"},{"title":"Attach an evidence library document to a dispute","deprecated":null,"version":null,"sidebarTitle":"Attach an evidence library document to a dispute","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/library","href":"/reference/attachevidencedocumenttodispute"},{"title":"Submit evidence files","deprecated":null,"version":null,"sidebarTitle":"Submit evidence files","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/submit","href":"/reference/submitdisputeevidence"},{"title":"Submit representment plan evidences","deprecated":null,"version":null,"sidebarTitle":"Submit representment plan evidences","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/submit-plan","href":"/reference/submitdisputerepresentmentplanevidences"},{"title":"Generate representment plan","deprecated":null,"version":null,"sidebarTitle":"Generate representment plan","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/generate-plan","href":"/reference/generatedisputerepresentmentplan"},{"title":"Regenerate representment plan","deprecated":null,"version":null,"sidebarTitle":"Regenerate representment plan","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/regenerate-plan","href":"/reference/regeneratedisputerepresentmentplan"},{"title":"Edit representment sections","deprecated":null,"version":null,"sidebarTitle":"Edit representment sections","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /dispute/disputes/{disputeId}/evidences/representment-sections","href":"/reference/editdisputerepresentmentsections"},{"title":"Rewrite representment text","deprecated":null,"version":null,"sidebarTitle":"Rewrite representment text","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/representment-sections/rewrite","href":"/reference/rewritedisputerepresentmenttext"},{"title":"Suggest representment section text","deprecated":null,"version":null,"sidebarTitle":"Suggest representment section text","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/representment-sections/{sectionId}/suggestion","href":"/reference/suggestdisputerepresentmentsection"},{"title":"Generate representment PDF","deprecated":null,"version":null,"sidebarTitle":"Generate representment PDF","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/generate-representment","href":"/reference/generatedisputerepresentmentpdf"},{"title":"Download the representment evidence bundle","deprecated":null,"version":null,"sidebarTitle":"Download the representment evidence bundle","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}/evidences/download","href":"/reference/downloadrepresentmentbundle"},{"title":"Download an evidence file by ID","deprecated":null,"version":null,"sidebarTitle":"Download an evidence file by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}/evidences/{evidenceId}","href":"/reference/downloaddisputeevidence"},{"title":"Remove an evidence file","deprecated":null,"version":null,"sidebarTitle":"Remove an evidence file","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /dispute/disputes/{disputeId}/evidences/{evidenceId}","href":"/reference/removedisputeevidence"},{"title":"Edit what a dispute's evidence shows","deprecated":null,"version":null,"sidebarTitle":"Edit what a dispute's evidence shows","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /dispute/disputes/{disputeId}/evidences/{evidenceId}/reading","href":"/reference/editdisputeevidencereading"},{"title":"Replace Dispute Tags by Type","deprecated":null,"version":null,"sidebarTitle":"Replace Dispute Tags by Type","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /dispute/disputes/{disputeId}/tags","href":"/reference/replacedisputetagsbytype"},{"title":"Attach Tags to a Dispute","deprecated":null,"version":null,"sidebarTitle":"Attach Tags to a Dispute","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/tags","href":"/reference/attachdisputetags"},{"title":"Detach a Tag from a Dispute","deprecated":null,"version":null,"sidebarTitle":"Detach a Tag from a Dispute","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /dispute/disputes/{disputeId}/tags/{tagId}","href":"/reference/detachdisputetag"},{"title":"List Tags","deprecated":null,"version":null,"sidebarTitle":"List Tags","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/tags","href":"/reference/listtags"},{"title":"Create Tag","deprecated":null,"version":null,"sidebarTitle":"Create Tag","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/tags","href":"/reference/createtag"},{"title":"Delete Tag","deprecated":null,"version":null,"sidebarTitle":"Delete Tag","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /dispute/tags/{tagId}","href":"/reference/deletetag"},{"title":"Update Tag","deprecated":null,"version":null,"sidebarTitle":"Update Tag","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /dispute/tags/{tagId}","href":"/reference/updatetag"}]}]}]}]},"basePath":"","title":"List evidence library documents - Payrails Docs","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}