Update a wallet
curl --request PATCH \
--url https://api.globalstack.io/v1/wallets/{walletId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"metadata": {}
}
'import requests
url = "https://api.globalstack.io/v1/wallets/{walletId}"
payload = {
"label": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({label: '<string>', metadata: {}})
};
fetch('https://api.globalstack.io/v1/wallets/{walletId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.globalstack.io/v1/wallets/{walletId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'label' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.globalstack.io/v1/wallets/{walletId}"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.globalstack.io/v1/wallets/{walletId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.globalstack.io/v1/wallets/{walletId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Wallet updated successfully",
"code": "ok",
"data": {
"id": "wal_01HXYZABC1234567890ABCDEFG",
"customer_id": "cust_01HXYZABC1234567890ABCDEFG",
"customer": {
"id": "cust_01HXYZABC1234567890ABCDEFG",
"type": "individual",
"name": "Alice Johnson",
"email": "alice@example.com",
"tier": "tier_2",
"created_at": "2026-04-16T16:14:08.000Z",
"updated_at": "2026-04-16T16:14:08.000Z"
},
"currency": "USDC",
"type": "custodial",
"available_balance": "1234.567890",
"pending_balance": "0.000000",
"total_balance": "1234.567890",
"metadata": {},
"provisioned": false,
"created_at": "2026-05-20T12:00:00.000Z",
"updated_at": "2026-05-20T12:00:00.000Z",
"country_code": "NG",
"label": "USDC Operating Wallet",
"destination_address": null,
"destination_chain": null
},
"meta": {
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}{
"status": false,
"message": "Resource not found",
"code": "not_found",
"data": null,
"meta": {
"next_steps": {
"action": "Verify the resource identifier and retry.",
"docs_url": "https://docs.globalstack.io/errors#not_found"
},
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}{
"status": false,
"message": "Resource not found",
"code": "not_found",
"data": null,
"meta": {
"next_steps": {
"action": "Verify the resource identifier and retry.",
"docs_url": "https://docs.globalstack.io/errors#not_found"
},
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}{
"status": false,
"message": "Resource not found",
"code": "not_found",
"data": null,
"meta": {
"next_steps": {
"action": "Verify the resource identifier and retry.",
"docs_url": "https://docs.globalstack.io/errors#not_found"
},
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}Wallets
Update a wallet
Partially updates an existing wallet. Returns the wallet in the same shape as
POST /v1/wallets.
The path id is the GlobalStack external identifier (wal_…).
Mutable fields
label— non-empty string, max 255 chars.metadata— free-formRecord<string, string>.
Immutable fields
currency and customer_id cannot be changed. Including either (or any unknown
field) in the request body fails validation with 400 bad_request. To move a
wallet to a different currency, create a new wallet.
Semantics
labelis replace-only. Omitting it leaves the stored label unchanged. Passingnull(or an empty string) to clear it is rejected as400 bad_request.metadatais replaced whole-cloth when present. No deep merge — the new map fully replaces the stored map.{}clears it. Explicitnullis rejected as400 bad_request.- A body with neither
labelnormetadatais rejected as400 invalid_input(nothing to update).
Owner
data.customer is the customer that owns the wallet, returned on every wallet payload:
| Field | Description |
|---|---|
id | Customer external id (cust_…), identical to customer_id. |
type | individual or business. |
name | Customer full or business name. |
email | Customer email address. |
tier | KYC tier — tier_0, tier_1 or tier_2. |
created_at / updated_at | ISO-8601 timestamps. |
customer_id is unchanged and still present. For KYC status, metadata or the customer profile,
call GET /v1/customers/{customerId}.
Errors
400 bad_request— class-validator failures: an immutable or unknown field (currency,customer_id, …) rejected;labelset to null/empty;metadataset tonullor a non-object.400 invalid_input— malformed path id (wal_…prefix required); empty patch body with neitherlabelnormetadata.401 authentication_failed— invalid or missing API key.404 not_found— wallet does not exist.
Example
PATCH /v1/wallets/wal_01HXYZABC1234567890ABCDEFG
{
"label": "Treasury Wallet"
}
PATCH
/
v1
/
wallets
/
{walletId}
Update a wallet
curl --request PATCH \
--url https://api.globalstack.io/v1/wallets/{walletId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"metadata": {}
}
'import requests
url = "https://api.globalstack.io/v1/wallets/{walletId}"
payload = {
"label": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({label: '<string>', metadata: {}})
};
fetch('https://api.globalstack.io/v1/wallets/{walletId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.globalstack.io/v1/wallets/{walletId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'label' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.globalstack.io/v1/wallets/{walletId}"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.globalstack.io/v1/wallets/{walletId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.globalstack.io/v1/wallets/{walletId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Wallet updated successfully",
"code": "ok",
"data": {
"id": "wal_01HXYZABC1234567890ABCDEFG",
"customer_id": "cust_01HXYZABC1234567890ABCDEFG",
"customer": {
"id": "cust_01HXYZABC1234567890ABCDEFG",
"type": "individual",
"name": "Alice Johnson",
"email": "alice@example.com",
"tier": "tier_2",
"created_at": "2026-04-16T16:14:08.000Z",
"updated_at": "2026-04-16T16:14:08.000Z"
},
"currency": "USDC",
"type": "custodial",
"available_balance": "1234.567890",
"pending_balance": "0.000000",
"total_balance": "1234.567890",
"metadata": {},
"provisioned": false,
"created_at": "2026-05-20T12:00:00.000Z",
"updated_at": "2026-05-20T12:00:00.000Z",
"country_code": "NG",
"label": "USDC Operating Wallet",
"destination_address": null,
"destination_chain": null
},
"meta": {
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}{
"status": false,
"message": "Resource not found",
"code": "not_found",
"data": null,
"meta": {
"next_steps": {
"action": "Verify the resource identifier and retry.",
"docs_url": "https://docs.globalstack.io/errors#not_found"
},
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}{
"status": false,
"message": "Resource not found",
"code": "not_found",
"data": null,
"meta": {
"next_steps": {
"action": "Verify the resource identifier and retry.",
"docs_url": "https://docs.globalstack.io/errors#not_found"
},
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}{
"status": false,
"message": "Resource not found",
"code": "not_found",
"data": null,
"meta": {
"next_steps": {
"action": "Verify the resource identifier and retry.",
"docs_url": "https://docs.globalstack.io/errors#not_found"
},
"request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
"timestamp": "2026-05-14T15:43:55.732Z",
"version": "1"
}
}Authorizations
API key issued during merchant onboarding.
Path Parameters
Pattern:
[^\/#\?]+?Response
Wallet updated successfully