Bre-B Participant API
API for creating and managing transfers through the Bre-B system
The Bre-B Participant API enables you to create and manage outgoing transfers, resolve transfer targets, and receive real-time webhook notifications about transfer status changes.
Authentication
This API uses OAuth 2.0 with Client Credentials flow. Request tokens from /api/v1/oauth/token.
Security Schemes
The API defines two security schemes that you'll see referenced in the endpoint documentation:
- oauth: Full access scheme for operations that create, update, or delete resources.
- oauth_readonly: Read-only access scheme for operations that only retrieve data.
Scopes
| Scope | Scheme | Description |
|---|---|---|
outgoing_transfers | oauth | Allow all permissions for outgoing transfers |
outgoing_transfers:readonly | oauth_readonly | Permissions to read outgoing transfers |
target_resolutions | oauth | Permission to read and resolve target resolutions |
target_resolutions:readonly | oauth_readonly | Permission to read target resolutions |
Endpoints
Authentication
OAuth 2.0 authentication with Client Credentials flow
Outgoing Transfers
Create and manage outgoing transfers through the Bre-B system