v5

latestOpenAPI 3.1.02026-07-262421791.5 MB

balance

Retrieve Deposit Limits

Returns the deposit limit for a profile based on regulatory requirements.

Useful for personal profiles located in countries that have hold limits. We advise calling this API before depositing money into an account if the profile is located in Singapore or Malaysia.

get/v1/profiles/{profileId}/balance-capacity

Path parameters

profileIdinteger required

The profile ID.

Query parameters

currencystring required

Currency code (ISO 4217 Alphabetic Code). The deposit limit will be returned in this currency.

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

OK - Successfully retrieved deposit limits.

hasLimitboolean

True if there is a regulatory hold limit for the profile's country.

Example response

{
  "hasLimit": true,
  "depositLimit": {
    "amount": 2000,
    "currency": "SGD"
  }
}