Reference Guide
Purpose
The Reference Guide is the single-source technical handbook for every public Bead API. It gathers reusable facts—endpoint lists, enums, schemas, and operational rules—so you don’t have to hunt through individual feature pages.
Scope
Core Concepts – environments, authentication, error codes
Enumerations & Schemas – tender types, settlement currencies, common field formats
Endpoint index – searchable table of every path plus downloadable OpenAPI files (Postman collection coming soon)
Operational playbooks – payment scenarios, webhook events, wallet compatibility, rate-limit tips, support contacts
Unless a note says otherwise, everything here applies across merchants, locations, and terminals.
Navigation map
Environments & Base URLs / Authentication / Error Codes
Tender Types, Settlement Currencies, Common Field Types
Table View / Download OpenAPI
Webhook Event Reference / Payment Scenarios / Compatible Crypto Wallets
Integration Support / Escalation Contacts
Conventions
See the Conventions table below for date-time format, ID layout, pagination params, and error object shape.
Date-time values
ISO-8601 UTC, e.g. 2025-06-04T16:08:03Z
Money fields
Integer minor units (cents, satoshis, wei)
Resource IDs
24-char lowercase hex strings like 667d49883f41b399d78a15ac
Pagination
Request params: pageId, page, pageSize (default 50)
Response fields: "total": <int>, "page": <int>, "items": […]
Error object
{ "code": 400, "message": "Invalid …" }
Rate limits
429 + X-RateLimit-* headers (see Rate Limits & Throttling)
Feedback & support
If something is missing or unclear, open a ticket via [email protected] (see Integration Support) or email [email protected]. Improvements land here first—check the Reference Guide › Changelog when you upgrade your integration.
Last updated