API Reference

Place multiple transactions on hold with filtering

put
https://api.infinicept.com/api//transactions/holdmultiple/filter

Places a hold on all transactions matching the supplied filter. Optionally provide a reasonText and notes to document the action; a reason is required when the tenant's Require Hold/Release Reason option is enabled.

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

The unique identifier, or name, of the Backoffice tenant.

Query Params
string
enum

Filters transactions by the stages of the funding process: 0 = None (In Queue / Held), 10 = Rejected, 20 = Submitted, and 30 = Funded.

Allowed:
Body Params

The filter selecting transactions to hold, plus the reason and notes.

filter
object
string

The reason for the hold or release. Use a reasonText from your tenant's configured reasons. Required when the tenant's RequireHoldReleaseReason option is enabled (maximum 200 characters).

string

Optional free-text notes providing additional context.

int32

Optional. The Backoffice identification number of the user to attribute the action to.

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

Optional. Identifies the user or system initiating this hold action; recorded in the hold/release history for auditing. Defaults to "API User" when omitted.

string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

400

Bad Request

Updated about 1 month ago

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

Updated about 1 month ago

Did this page help you?