Integration example
A realistic walkthrough of building a Bre-B participant integration.
This page walks through a representative Bre-B integration end-to-end: a bank or licensed entity that wants to let its customers send and receive Bre-B payments from inside the bank app. You will see the full path from token exchange to QR generation, payment receipt, target resolution, outgoing transfer, and webhook handling.
If you are building a different Bre-B use case — a marketplace acquirer, a wallet that bridges to Bre-B, a treasury system — the patterns transfer directly; only the entity names change.
This page is an integration-example scaffold. The full version will include code per step, sequence diagrams for both the payin and payout flows, and a full reference architecture.
What you will build
A Bre-B participant integration that supports:
- Onboarding — register a tenant account that will hold balances and receive Bre-B payments.
- Receive payments — generate Bre-B QR codes and reconcile collection events.
- Send payments — resolve a destination payment key, confirm with the user, and dispatch an outgoing transfer.
- Lifecycle — track outgoing transfer states and handle errors.
Architecture
| Layer | Component |
|---|---|
| Frontend | Customer-facing UI for QR display and outgoing-transfer initiation |
| Backend | OAuth refresh, collection generation, resolution + dispatch, webhook receiver |
| Mono | Bre-B Participant API + webhooks |
| External | Bre-B central directory + counterparty banks |
Walkthrough
The full walkthrough is pending. Until it is published, see: