Skip to main content
PATCH
/
v1
/
platform
/
wallets
/
{wallet_id}
Rename or Promote a Wallet
curl --request PATCH \
  --url https://api-sandbox.finogates.com/v1/platform/wallets/{wallet_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "is_primary": true
}
'
{
  "status_code": 123,
  "data": "<unknown>",
  "query_generated_time": 123
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
wallet_id
string<uuid>
required

The wallet UUID.

Body

application/json

Rename and/or promote-to-primary in a single PATCH.

Both fields are optional; at least one must be present.

​
name
string | null

New display name (unique per (tenant, user)).

Required string length: 1 - 60
​
is_primary
boolean | null

Set true to promote this wallet to primary for its (user, currency). Cannot be set to false directly — to change the primary, promote a different wallet instead.

Response

Successful Response

Standard response wrapper for single-object responses and errors.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

​
status_code
integer
required

HTTP status code for the response.

​
data
any
required

Payload or error details.

​
query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.