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

• Common Field Types – Reusable objects such as addresses and contacts that appear in multiple APIs.

• Merchant Onboarding Schema – Complete schema for POST /merchant-onboarding/application, including business identity, contacts, owners, banking, and fee configuration.

• Settlement Currencies – Supported currencies for settlement.

• Tender Types – Enumerations for supported payment methods. Subpages cover:

  • Crypto – Supported digital assets for crypto payments.

  • Alternative Payments – Supported peer-to-peer and wallet-based payment methods.

How to use these pages

• Validate input: Reject values not present in the corresponding enum list.

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

• 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. Always check the changelog before each release cycle.