HoldLimitBreach
A breach of a balance hold limit.
Operations
Every route this entity exposes. Each route links to its own reference on this page.
| Method | Route | SDK operation | Returns |
|---|---|---|---|
GET |
/profiles/{profileId}/balances/hold-limit-breach |
list |
Successfully returned list of hold limit breaches |
Examples
One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.
Golang
Construct client as shown in the Golang setup, then call the operations:
hold_limit_breachs, err := client.HoldLimitBreach(nil).List(map[string]any{"profile_id": 1}, nil)
if err != nil {
panic(err)
}
fmt.Println(hold_limit_breachs)
Lua
Construct client as shown in the Lua setup, then call the operations:
local hold_limit_breachs, err = client:HoldLimitBreach():list({ profile_id = 1 })
PHP
Construct client as shown in the PHP setup, then call the operations:
$hold_limit_breachs = $client->HoldLimitBreach()->list(["profile_id" => 1]);
Python
Construct client as shown in the Python setup, then call the operations:
hold_limit_breachs = client.HoldLimitBreach().list({"profile_id": 1})
Ruby
Construct client as shown in the Ruby setup, then call the operations:
hold_limit_breachs = client.HoldLimitBreach.list({ "profile_id" => 1 })
TypeScript
Construct client as shown in the TypeScript setup, then call the operations:
const hold_limit_breachs = await client.HoldLimitBreach().list({ profile_id: 1 })
Fields
| Field | Type | Required | Description |
|---|---|---|---|
amount |
number |
No | Amount value. |
closingReason |
string |
No | Reason the breach was closed, null if state is OPEN. |
createdAt |
string |
No | Date when the hold limit breach was created. |
currency |
string |
No | Currency code (ISO 4217 Alphabetic Code). |
id |
integer |
No | Hold limit breach ID. |
profileId |
integer |
No | ID of the profile that owns the hold limit breach |
state |
string |
No | Current state of the hold limit breach. |
updatedAt |
string |
No | Date when the hold limit breach was last modified. |
list
GET /profiles/{profileId}/balances/hold-limit-breach
Operation ID: holdLimitBreachList.
Authentication: bearer token (UserToken) or bearer token (PersonalToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
profileId |
path |
integer (int64) |
Yes | The profile ID. |
state |
query |
string (string) |
No | Filter by breach state. One of OPEN, CLOSED |
closingReason |
query |
string (string) |
No | Filter by closing reason. One of AUTOMATICALLY_RESOLVED, MANUALLY_RESOLVED |
X-External-Correlation-Id |
header |
string (uuid) |
No | Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more. |
Responses
200: Successfully returned list of hold limit breaches
application/json
| Property | Type | Required | Description |
|---|---|---|---|
[].amount |
number |
No | Amount value. |
[].closingReason |
enum: AUTOMATICALLY_RESOLVED, MANUALLY_RESOLVED |
No | Reason the breach was closed, null if state is OPEN. |
[].createdAt |
string (date-time) |
No | Date when the hold limit breach was created. |
[].currency |
string |
No | Currency code (ISO 4217 Alphabetic Code). |
[].id |
integer (int64) |
No | Hold limit breach ID. |
[].profileId |
integer (int64) |
No | ID of the profile that owns the hold limit breach |
[].state |
enum: OPEN, CLOSED |
No | Current state of the hold limit breach. |
[].updatedAt |
string (date-time) |
No | Date when the hold limit breach was last modified. |
400: Invalid closing reason or state used
application/json
| Property | Type | Required | Description |
|---|---|---|---|
errors |
array of object |
No | A list of specific validation failures. |
errors[].code |
string |
No | A specific code for the validation failure type. |
errors[].detail |
string |
No | A detailed description of the validation failure. |
errors[].ref |
string |
No | A reference to the field that failed validation. |
instance |
string |
No | The uri that triggered the error |
status |
string |
No | Bad request error |
title |
string |
No | Request parameter type mismatch |
type |
string (uri-reference) |
No | Must be /errors/types/validation for this error type |
403: Caller does not have access to the profile
application/json
| Property | Type | Required | Description |
|---|---|---|---|
code |
string |
No | Error code of the request |
detail |
string |
No | Detail of the error |
instance |
string |
No | The uri that triggered the error |
status |
string |
No | Forbidden error |
title |
string |
No | Forbidden |
type |
string (uri-reference) |
No | Must be /errors/types/access for this error type |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.