Update a wallet

Updates info for a single user-controlled wallet using it’s unique identifier.

PUT /v1/w3s/wallets/{id}

Update a wallet

cURL

curl --request PUT \
  --url https://api.circle.com/v1/w3s/wallets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-User-Token: <x-user-token>' \
  --data '
{
  "name": "my wallet",
  "refId": "customer_12345"
}
'

import requests

url = "https://api.circle.com/v1/w3s/wallets/{id}"

payload = {
    "name": "my wallet",
    "refId": "customer_12345"
}
headers = {
    "X-User-Token": "<x-user-token>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'X-User-Token': '<x-user-token>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: 'my wallet', refId: 'customer_12345'})
};

fetch('https://api.circle.com/v1/w3s/wallets/{id}', 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.circle.com/v1/w3s/wallets/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'my wallet',
    'refId' => 'customer_12345'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-User-Token: <x-user-token>"
  ],
]);

$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.circle.com/v1/w3s/wallets/{id}"

	payload := strings.NewReader("{\n  \"name\": \"my wallet\",\n  \"refId\": \"customer_12345\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-User-Token", "<x-user-token>")
	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.put("https://api.circle.com/v1/w3s/wallets/{id}")
  .header("X-User-Token", "<x-user-token>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"my wallet\",\n  \"refId\": \"customer_12345\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.circle.com/v1/w3s/wallets/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-User-Token"] = '<x-user-token>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"my wallet\",\n  \"refId\": \"customer_12345\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "wallet": {
      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "address": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
      "blockchain": "MATIC-AMOY",
      "createDate": "2023-01-01T12:04:05Z",
      "updateDate": "2023-01-01T12:04:05Z",
      "state": "LIVE",
      "walletSetId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "accountType": "EOA",
      "name": "<string>",
      "refId": "customer_12345",
      "userId": "ext_user_id_1",
      "initialPublicKey": "3eQoJ3ex6uWX3R8F1THF6Y6oBQwPYpF1X9HBM1gjqw7w"
    }
  }
}

{
  "code": 400,
  "message": "Bad request."
}

{
  "code": 401,
  "message": "Malformed authorization."
}

{
  "code": 404,
  "message": "Not found."
}

Authorizations

Authorization · string · header · required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are required to make a successful request.

Headers

X-User-Token · string · required

Unique system generated JWT session token for specific user.

Path Parameters

id · string<uuid> · required

The universally unique identifier of the resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Body

application/json

Schema for the request payload to update an existing wallet.

name · string

Name or description associated with the wallet or walletSet.

Example:

"my wallet"

refId · string

Optional user-defined reference identifier for the wallet. Not used by Circle for wallet functionality. Used for internal tracking or associating wallets with entities in your own systems (for example, a customer or account ID).

Example:

"customer_12345"

Response

200

application/json

Successfully updated wallet metadata.

data · object · required

Show child attributes