v5

latestOpenAPI 3.1.02026-07-262421791.5 MB

balance

Close a hold limit breach

Closes an open hold limit breach by performing a one-time refund to a specified recipient. The recipient will receive the excess amount that caused the breach.

Only breaches with state: OPEN can be closed via this endpoint.

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

Path parameters

profileIdinteger required

The profile ID.

holdLimitBreachIdinteger required

The hold limit breach ID.

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.

Request body

targetRecipientIdinteger required

ID of the recipient to receive the refund of the excess funds.

statestring required

Must be CLOSED. This is the only supported value.

Example request

{
  "targetRecipientId": 148393305,
  "state": "CLOSED"
}

Response

Returns 204 No Content on success.