Archive one version of an evidence library document
Archive one version of an evidence library document that no dispute uses, so that Payrails never attaches it to new disputes.
currentVersion becomes its newest version that is not archived.
When you archive the only version that is not archived, Payrails archives the whole
document too. The next version you add still gets a new number.
- Returns 409 when a dispute uses the version, in any workspace, or when the document is archived.
- Archiving a version that is already archived returns the document unchanged.
- Returns 404 when the document or the version does not exist, or when the
evidenceLibraryEnabledfeature flag is off.
Authorizations
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.
Headers
Path Parameters
Response
The document with the archived version.
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.
10.4, 13.1, 13.2, 13.3, 13.6, 13.7, 4837, 4853, 4855 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.
ai, user, client, null 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.
100