Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
balance

List hold limit breaches

Returns a list of hold limit breaches for a profile. A hold limit breach occurs when a balance exceeds the regulatory hold limit for that profile's country (e.g. Singapore, Malaysia).

You can optionally filter by state and closing_reason.

post/v1/profiles/{profileId}/balances/hold-limit-breach

Path parameters

profileIdinteger required

The profile ID.

Query parameters

statestring string

Filter by breach state. One of OPEN, CLOSED

closingReasonstring string

Filter by closing reason. One of AUTOMATICALLY_RESOLVED, MANUALLY_RESOLVED

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Response

Successfully returned list of hold limit breaches.

idinteger

Hold limit breach ID.

profileIdinteger

ID of the profile that owns the hold limit breach

amountnumber

Amount value.

currencystring

Currency code (ISO 4217 Alphabetic Code).

state'OPEN' | 'CLOSED'

Current state of the hold limit breach.

closingReason'AUTOMATICALLY_RESOLVED' | 'MANUALLY_RESOLVED'

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

createdAtstring date-time

Date when the hold limit breach was created.

updatedAtstring date-time

Date when the hold limit breach was last modified.

Example response

[
  {
    "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"
  }
]