Hold a Submerchant

put

https://api.infinicept.com/api/{tenantId}/merchant/{submerchantId}/hold

Places a hold on a submerchant, preventing funding until the hold is released. 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. The action is recorded in the submerchant's Hold/Release Activity log.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

submerchantId

int32

required

The submerchant's identification number.

tenantId

string

required

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

Body Params

Optional. The reason and notes describing why the submerchant is being held.

reasonText

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).

notes

string

Optional free-text notes providing additional context.

initiatedByUserId

int32

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

Headers

x-AuthenticationKeyId

string

required

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

x-AuthenticationKeyValue

string

required

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

X-Initiated-By

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.

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

400

Bad Request

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success