Build with BEXO
Connect your business to BEXO with a clear contract for identity, membership and the moment a card meets a reader.
Your first BEXO integration ↗
Set up an isolated BEXO development environment, select the correct credentials, check terminal connectivity and handle your first verification response.
Start hereAuthentication and API keys ↗
Understand BEXO owner sessions, member sessions, tenant integration keys, reader registration, scopes, sandbox access and live-key availability.
API referenceVendor API reference ↗
Detailed BEXO vendor API endpoints for business applications, compliance uploads, plans, storefront links, memberships, registered readers, logs and CSV reports.
API referenceTerminal verification API ↗
Integrate BEXO NFC and QR readers with registered-terminal authentication, access decisions, response fields, buffered synchronization and failure handling.
API referenceHosted checkout and purchase lifecycle ↗
Use BEXO vendor checkout links, buyer sessions, payment reconciliation, stable idempotency keys and the pending-purchase resume workflow.
API referenceMemberships, consent and data handling ↗
Understand BEXO member-owned consent APIs, disclosure fields, revocation, vendor isolation and the difference between purchase, access and public profiles.
Integration guidesReceive signed vendor events ↗
Verify BEXO vendor webhook signatures over raw request bytes, deduplicate event IDs, acknowledge safely and understand event delivery availability.
Integration guidesSandbox identity guide ↗
Use BEXO sandbox-only identity endpoints with isolated test tenants, scoped keys, registered terminals and the correct mounted route paths.
Integration guidesErrors, pagination and safe retries ↗
Handle BEXO problem-details and legacy errors, HTTP and business denials, request IDs, rate limiting, pagination and idempotent purchase retries.
Integration guidesIntegration checklist ↗
Prepare a BEXO vendor integration for release with tenant isolation, approved credentials, reader decisions, consent, payment reconciliation and operational recovery checks.
API referenceAPI data models ↗
BEXO vendor API schema reference covering plan amounts, membership states, verification decisions, terminals, checkout snapshots, consent and credential metadata.
Start hereDocumentation changelog ↗
BEXO developer reference editions, supported API scope, credential availability notes and links to the downloadable vendor OpenAPI specification.
Choose your integration path
| You want to… | Start here | Credential |
|---|---|---|
| Build a reader or ERP integration | Terminal verification | Scoped integration key + registered terminal |
| Manage a vendor workspace | Vendor API reference | Authenticated owner session |
| Send a customer to buy a plan | Hosted checkout | Public discovery; buyer session for purchase |
| Build against test contracts | Sandbox guide | Isolated sandbox key |
| Receive operational events | Webhook receiver guide | Configured endpoint signing secret |
A first request that checks the connection
Use a scoped integration key and the serial of a reader registered to the same vendor. A member login token, tenant ID or reader serial alone cannot substitute for the integration key.
curl --fail-with-body "$BEXO_API_BASE/pos/v1/ping" \
-H "Authorization: Bearer $BEXO_INTEGRATION_KEY" \
-H "X-Terminal-Serial: $BEXO_TERMINAL_SERIAL"Configure these values using the quickstart. Do not paste credentials into this documentation site; it never executes API requests on your behalf.
What this reference covers
The reference covers selected vendor-owner, buyer/member, terminal and sandbox endpoints. It includes the fields you need to integrate and permits additive response fields. Internal staff operations, private reviewer downloads and biometric-session links are outside this public reference.
Read authentication, errors and retries and the integration checklist before shipping.
Use the machine-readable contract
Download OpenAPI 3.0 JSON to inspect the documented schemas in your own API tools. The specification uses placeholders rather than live keys, card identifiers or customer records. Browser-based “try it” tools are deliberately not embedded.
The data model reference explains fields, null values, money and timestamps. The documentation changelog records the reference edition.