Archive Multiple Transactions

Archives multiple transactions identified by their transaction IDs. Archiving removes each transaction from funding and hides it from default transaction lists without deleting it. Each transaction keeps all of its details, records when it was archived, who archived it, and why, and can be unarchived at any time.

Only settled transactions that have not been submitted for funding can be archived. These are transactions with a status of In Queue, On Hold, or Rejected. If any listed transaction cannot be archived, the request fails and no transactions are archived. Transactions that are already archived are skipped, and duplicate IDs are ignored. Providing a reason for archiving the transactions is required. The reason is applied to every transaction in the request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The tenant identifier.

Body Params
transactionIds
array of int32s

The identification numbers of the transactions to archive or unarchive. Required when archiving or unarchiving multiple transactions. Ignored when archiving or unarchiving a single transaction, which is identified in the path. Duplicate IDs are ignored.

transactionIds
string
length ≤ 1024

The reason for archiving, up to 1,024 characters. Required when archiving and ignored when unarchiving. The reason is returned as archiveReason on each archived transaction.

Headers
string
required

The API key id used to authenticate and authorize your request to Infinicept. API keys are managed within your Backoffice tenant.

string
required

The API key value used to authenticate and authorize your request to Infinicept. API keys are managed within your Backoffice tenant.

string

Identifies the user or system initiating this archive action. Recorded as archivedBy on each archived transaction and as initiatedBy on the Event Center work item. Defaults to "API User" when omitted.

string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

400

The request was rejected and no transactions were archived. This occurs when the request body or reason is missing, the reason is longer than 1,024 characters, no transaction IDs are provided, a transaction ID does not exist, or a transaction has been submitted for funding or is not settled. The response body describes the problem and lists the transaction IDs that caused it.

404

The specified tenant was not found.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json