Skip to content
/
Update a managed account

Update a managed account

Request

Update the details for the managed account identified by the id in the path.

Security
auth_token and api-key
Path
idstring^[0-9]+$required

The unique identifier of the managed account.

Bodyapplication/jsonrequired
tagstring, <= 50 characters(Tag)^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

friendlyNamestring, [ 1 .. 50 ] characters

Updates the friendly name of the managed account. Leave blank if no change is needed.

lowBalanceThresholdinteger, (int64)(AccountLowBalanceThreshold)

Sends a low balance notification webhook when the available balance drops below this amount. Currency is inherited from the managed account.

clearLowBalanceThresholdboolean

When true, clears the configured low balance threshold on the account. Ignored if lowBalanceThreshold is also provided.

curl -i -X PATCH \
  'https://sandbox.weavr.io/multi/managed_accounts/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "tag": "string",
    "friendlyName": "string",
    "lowBalanceThreshold": 0,
    "clearLowBalanceThreshold": true
  }'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
idstring^[0-9]+$required

The unique identifier of a Managed Account.

profileIdstring(ProfileId)^[0-9]+$required

The profile Id which a specific identity, instrument or transaction type is linked to.

Profiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.

You can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

tagstring, <= 50 characters(Tag)^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

friendlyNamestring, [ 1 .. 50 ] charactersrequired

The friendly name given to the managed account.

currencystring, = 3 characters(Currency)^[A-Z]*$required

The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.

balancesobject(ManagedInstrumentBalance)required

Instruments with funds have 2 balances, the availableBalance indicating the funds that are available for transactions such as purchases, and the actualBalance indicating the funds that are actually on the instrument.

stateobject(ManagedInstrumentState)required
creationTimestampinteger, (int64)required

The time when the managed account was created, expressed in Epoch timestamp using millisecond precision.

lowBalanceThresholdinteger, (int64)(AccountLowBalanceThreshold)

Sends a low balance notification webhook when the available balance drops below this amount. Currency is inherited from the managed account.

Response
{
  "id": "string",
  "profileId": "string",
  "tag": "string",
  "friendlyName": "string",
  "currency": "str",
  "balances": {
    "availableBalance": 0,
    "actualBalance": 0
  },
  "state": {
    "state": "ACTIVE",
    "blockedReason": "USER",
    "destroyedReason": "SYSTEM"
  },
  "creationTimestamp": 0,
  "lowBalanceThreshold": 0
}