Skip to content

HoldLimitBreach

Represents a hold limit breach.

idinteger, (int64)

Hold limit breach ID.

Example:200001
profileIdinteger, (int64)

ID of the profile that owns the hold limit breach

Example:123456
amountnumber

Amount value.

Example:310.86
currencystring

Currency code (ISO 4217 Alphabetic Code).

Example:"EUR"
statestring

Current state of the hold limit breach.

Enum ValueDescription
OPEN

Hold limit breach is open and needs to be resolved.

CLOSED

Hold limit breach is closed and resolved.

Example:"OPEN"
closingReasonstring

Reason the breach was closed, null if state is OPEN.

Enum ValueDescription
AUTOMATICALLY_RESOLVED

The breach was resolved automatically after the customer withdrew funds and the balance dropped below the hold limit.

MANUALLY_RESOLVED

The breach was closed by calling the Close Hold Limit Breach endpoint with a specified recipient.

Example:"AUTOMATICALLY_RESOLVED"
createdAtstring, (date-time)

Date when the hold limit breach was created.

Example:"2020-05-20T14:43:16.658Z"
updatedAtstring, (date-time)

Date when the hold limit breach was last modified.

Example:"2020-05-20T14:43:16.658Z"
{ "id": 200001, "profileId": 123456, "amount": 310.86, "currency": "EUR", "state": "OPEN", "closingReason": "AUTOMATICALLY_RESOLVED", "createdAt": "2020-05-20T14:43:16.658Z", "updatedAt": "2020-05-20T14:43:16.658Z" }