Skip to main content
Create a wallet whenever you need a stable receiving identity for your business or one of your customers. Store the returned wallet id; it stays the same across all of the wallet’s chain-specific destinations.

Create the wallet

Send a POST to /v1/wallets. Do not choose a chain. Yara provisions every supported deposit chain automatically.
Both fields are optional. Use label to identify the wallet in your own workflow. Add customer_id when deposits to the wallet should be attributed to one of your Yara customers.

Response

The example shows a subset of the destinations for readability. The response contains one destination for every supported deposit chain.

Provisioning statuses

A wallet can be PROVISIONING, ACTIVE, PARTIALLY_ACTIVE, FAILED, FROZEN, or DISABLED. Each destination also has its own status. You can begin using an ACTIVE destination immediately. If one destination cannot be provisioned immediately, it may be FAILED while the wallet is PARTIALLY_ACTIVE. Yara retries failed provisioning, so fetch the wallet again before presenting that destination to a sender.

Which chains can I use?

Fetch the live list from GET /v1/chains. Each entry tells you the supported assets and whether deposit_enabled is true.

List and fetch wallets

List wallets, optionally filtering by customer, destination chain, status, label, address, or wallet ID:
Or fetch one wallet and all of its destinations:
Reuse the same idempotency key when retrying a failed create request so you don’t create another wallet.

Next

Receive funds

Select a destination and get notified when deposits arrive.

Whitelist a recipient

Approve a destination before paying out.