Entity Management

Entity Management

The Entity Management API provides a single interface to create and maintain every business object that drives payments in Bead.

Partner → Merchant → Location → Terminal → Payment

It covers the full life cycle, from initial KYB onboarding through routine updates, so you can automate provisioning flows and build self service dashboards.

Why use Entity Management

Need Onboard a new merchant

How the API helps Submit KYB details and generate a hosted onboarding link that the signer can complete securely.

Need Track onboarding progress

How the API helps Query onboarding status to see missing or invalid fields and determine when a merchant is ready for production.

Need Manage locations

How the API helps Create, rename, or deactivate merchant locations so your reporting and settlement views reflect the merchant’s structure.

Need Manage terminals

How the API helps Create, list, update, disable, or delete devices and set device level webhooks that drive payment status events.

Available sections

Onboarding Submit KYB details for merchants and partners, generate hosted onboarding links, and track status to approval.

Merchant Management Create, read, update, and deactivate merchants once onboarding is complete. Check merchant status before enabling production traffic.

Location Management Create and maintain merchant locations, including display names and address details used in receipts, reporting, and settlement.

Terminal Management Provision and manage terminals, including webhooks and configuration that control how payments are initiated and where events are delivered.

Navigation

Use the left navigation to move between sections:

• Onboarding

• Merchant Management

• Location Management

• Terminal Management

• Change Log

Getting started

1. Obtain an access token

   • See the Authentication page for how to request and refresh tokens.

2. Create or retrieve the parent objects in order

   • Partner → Merchant → Location

3. Provision terminals under the correct location

   • Each terminal belongs to a location and merchant.

4. Use the terminalId when creating payments

   • Payments created through the Payments API reference the terminal and merchant defined here and then appear in Reporting and Settlement.