Skip to main content
POST
Rotate a wallet

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string
required

Caller-generated unique key that lets the server safely replay this request. The original response is returned for 30 days on any retry with the same key from the same organization. Required on every state-changing money-moving or resource-creating POST.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_.:-]{1,128}$
Example:

"01J7B3K2X9M8N5P6Q7R8S9T0V1"

Path Parameters

customerId
string
required
Example:

"cus_1A2b3C4d5E6f7G8h9I0jKl"

walletId
string
required
Example:

"wlt_1A2b3C4d5E6f7G8h9I0jKl"

Response

id
string
required

Unique wallet identifier

Pattern: ^wlt_[0-9A-Za-z]{22}$
Example:

"wlt_2xKjF9mQb7vN4hL1pR3w8t"

chain
enum<string>
required

Blockchain network of the wallet

Available options:
ethereum,
base,
solana,
polygon,
tron,
stellar
address
string | null
required

On-chain wallet address, null while provisioning

Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18"

status
enum<string>
required

Current wallet lifecycle status

Available options:
pending,
active,
disabled
balances
object[]
required

Wallet balances by asset

createdAt
string<date-time>
required

Timestamp when the wallet was created

Example:

"2026-01-15T09:30:00.000Z"

updatedAt
string<date-time>
required

Timestamp when the wallet was last updated

Example:

"2026-01-15T09:30:00.000Z"

custodyModel
enum<string>

non_custodial — the customer co-signs each payout via the verify URL (see requiresUserSignature on payouts). custodial is a return-only value for legacy/operational wallets. Omitted until the custody model is determined.

Available options:
non_custodial,
custodial
rotatedAt
string<date-time>

Timestamp of the last key rotation, omitted until rotated

Example:

"2026-01-15T09:30:00.000Z"

replacedByWalletId
string

ID of the wallet that replaced this one after rotation, omitted until rotated

Pattern: ^wlt_[0-9A-Za-z]{22}$
clientReferenceId
string

Client-supplied reference, unique per resource within your organization. 1-255 characters from A-Za-z, 0-9, underscore, hyphen, colon, and period — no spaces.

Pattern: ^[A-Za-z0-9_\-:.]{1,255}$