Skip to main content
The Wallets as a Service API is organized around a few resources. Every endpoint in the left nav has full request and response schemas and a Try it console.

​
Base URL

All merchant endpoints are under the /v1 prefix.

​
Authentication

Send your secret key in the x-yara-api-key header (or Authorization: ApiKey <key>). See Authentication.

​
Resources

Use the left navigation to open any endpoint. Each resource also has a guide:

Addresses

Create and list deposit addresses.

Balance & deposits

Read your USD balance and track deposits.

Transfers

Quote and initiate payouts.

Webhooks

Outbound events and delivery history.
The reference also covers Transactions (a unified feed of deposits and transfers) and Reference data (chains, rates, fees) — open them from the left nav.

​
Conventions

  • Auth via the x-yara-api-key header on every merchant request.
  • Idempotency via the X-Idempotency-Key header on all POST requests.
  • Responses wrap a single object in data, and lists in data plus a meta block for pagination (page, limit, total, total_pages).
  • Amounts are decimal strings (e.g. "100.000000").
  • Errors return an error object with a code and message.

​
Pagination

List endpoints accept page and limit (default 50, max 200) query parameters.