Enumerations & Schemas

Purpose

Enumerations & Schemas is the canonical reference for every reusable value set and shared object used across Bead APIs. Use this section to validate request bodies, parse responses, and keep client libraries in sync with the platform.

What you’ll find here

Page
Contents

Lists every crypto and alternative-payment tender string, with network notes and decimals.

Shows each enabled fiat, crypto, or wallet-app currency returned by /currencies, including code, network, and status.

Defines shared patterns such as 24-char IDs, ISO-8601 timestamps, money amounts, and the Address object.

How to use these pages

  1. Validate input: reject values not present in the corresponding enum list.

  2. Display names and symbols: map the code or tender string to the human-readable name provided here.

  3. Plan for change: new rows will appear when Bead adds a rail or asset; unknown values should raise a clear error in your integration.

Versioning

Enumerations can grow but never break existing values. Schemas may add optional fields; required fields change only in a new API version. Check the changelog before each release cycle.

Last updated