Quickstart

Get started

Quickstart

This quickstart outlines the first integration path for a BroSettlement pilot: create an organization-scoped wallet, subscribe to lifecycle events, and reconcile activity against ledger entries.

Prerequisites

Before you begin, confirm you have:

  • A BroSettlement organization.
  • A user with the owner or admin role.
  • Mandatory 2FA enabled for human users.
  • An Ed25519 API key pair registered for your backend or service account.
  • IP allowlisting configured for production environments.
  • A Co-Signer deployment plan if the pilot includes withdrawal signing.

Integration flow

  1. Create API access

Create a service account API key for your backend. Register the public key with BroSettlement and keep the private key in your secrets manager.

  1. Sign each request

Every API request should include a timestamp, nonce, and Ed25519 signature.

bash
curl https://api.brosettlement.com/v1/wallets \
  -H "X-Bro-Api-Key: api_key_123" \
  -H "X-Bro-Timestamp: 2026-06-25T09:00:00Z" \
  -H "X-Bro-Nonce: 8f7b8f24-4e6a-45d2-a944-4b11c4c7d2f8" \
  -H "X-Bro-Signature: base64_ed25519_signature" \
  -H "Content-Type: application/json" \
  -d '{
    "organizationId": "org_123",
    "chain": "TRON",
    "asset": "USDT",
    "label": "Merchant 784 deposit wallet"
  }'
  1. Create a wallet or deposit address

Request a wallet for the customer, merchant, seller, recipient, player, or internal account that needs isolated on-chain attribution.

json
{
  "walletId": "wal_123",
  "organizationId": "org_123",
  "chain": "TRON",
  "asset": "USDT",
  "address": "TQ9y...",
  "status": "active"
}
  1. Subscribe to events

Connect your backend to lifecycle events for observed deposits, confirmations, withdrawal state changes, broadcast results, and failures.

bash
wscat -c "wss://events.brosettlement.com/v1?organizationId=org_123"
  1. Deploy the Co-Signer

For withdrawal flows, deploy the client-run Co-Signer in your own cloud, VPC, or environment so your policy can participate in MPC signing.

  1. Reconcile with the ledger

Use ledger entries as the operating record for balances. Treat blockchain events as operational signals and ledger entries as accounting state.

Next steps

What BroSettlement isUnderstand the product boundary before designing your integration.Co-SignerLearn how client-controlled signing fits into withdrawal operations.ReconciliationConnect wallet events to ledger records and internal balances.