Unarchive Multiple Transactions with Filtering

Unarchives all archived transactions that match the supplied filter and automatically changes each one's fundingStatus to Held. Transactions with a fundingStatus of Rejected at the time of archiving retain that status when unarchived. In both cases, onHold returns as true. For held transactions, release the holds when the transactions are ready to be eligible for funding.

Only archived transactions are considered, so the filter does not need to include archived. Unarchiving removes each transaction's archive details (archivedDate, archivedBy, and archiveReason). Providing a reason for unarchiving the transactions is not required.

To review the matching transactions before unarchiving them, send the same filter values, plus Archived=true, as query parameters to Review Paginated Transactions (GET /transactions/paginated), which accepts the same TransactionFilter properties.

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

The tenant identifier.

Body Params
filter
object
required
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 unarchive action. Recorded 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 unarchived. This occurs when the request body or filter is missing, or no archived transactions match the filter. The response body describes the problem.

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