Skip to main content
GET
Get wallet
Returns a single wallet identified by its id or DNS-label name. Both forms work in the {wallet} path parameter. The response is the full wallet resource — see Wallet overview for the field reference. To retrieve the current balance, use Get wallet balance instead — it returns a balance snapshot, not the wallet object.

Authorizations

X-Access-Key
string
header
required

Opaque credential identifier provisioned during onboarding. See the Integration Guide for the request-signing protocol.

X-Access-Timestamp
string
header
required

Unix epoch timestamp in UTC milliseconds. See the Integration Guide for skew tolerance.

X-Access-Request-Id
string
header
required

Unique identifier per request (UUID v4 recommended). The (accessKey, requestId) tuple must be unique within the replay window defined by the Integration Guide.

X-Access-Signature
string
header
required

Base64-encoded ECDSA signature of the canonical request, computed with the private key paired to X-Access-Key. See the Integration Guide for canonicalization rules and reference implementations.

Path Parameters

wallet
string
required

Wallet name (RFC 1035 DNS label).

Required string length: 1 - 63
Pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

Response

The requested wallet.

A tenant-scoped balance container that isolates payment orders, balances, and ledger transactions.

id
string
required
read-only

Server-assigned, immutable identifier.

Pattern: ^wal_[A-Za-z0-9]+$
Example:

"wal_2NhVqRtYbHmRdZ4vG6qAeL"

kind
enum<string>
required
read-only

Fixed resource-type discriminator; always Tenant.Wallet.

Available options:
Tenant.Wallet
Example:

"Tenant.Wallet"

walVersion
integer
required
read-only

Snapshot version, incremented on every content mutation.

Required range: x >= 1
Example:

1

status
enum<string>
required

Lifecycle status of a wallet.

Available options:
ACTIVE,
DISABLED
name
string
required

RFC 1035 DNS label (1–63 lowercase characters; starts with a letter; ends with an alphanumeric). Globally unique and immutable after creation.

Required string length: 1 - 63
Pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$
Example:

"production-main"

createdAt
string<date-time>
required
read-only

Server-assigned creation timestamp (UTC ISO 8601).

Example:

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

updatedAt
string<date-time>
required
read-only

Timestamp of the last content mutation (UTC ISO 8601).

Example:

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

selfName
string
required
read-only

Canonical relative resource name.

Example:

"wallets/production-main"

etag
string
required
read-only

Hex-encoded content fingerprint of the resource. Reserved for optimistic concurrency control via the If-Match request header in a future release; currently exposed for informational and audit purposes only.

Pattern: ^[a-f0-9]{64,128}$
Example:

"9f3b2c1d8a7e6f5b4a3c2d1e0f9e8d7c6b5a493827160504e3d2c1b0a9f8e7d6"