FRB Assistant
What is FRB Assistant ?
FRB Assistant is a Discord bot present in the Federal Reserve Bank of Redmont server, helping the Reserve's staff fulfill their daily duties.
This Discord bot is managed and maintained by Qash, the Reserve's Fintech, and communicates with the Qash Platform through the Core Banking and Reserve Connections APIs.
FRB Assistant Domains
FRB Assistant currently helps the Reserve manage Reserve Accounts for registered financial institutions by:
- Notifying the Reserve when a new deposit request is issued and when it is answered ;
- Notifying the Reserve when a new RDR-001 Deposits Return is filed ;
- Notifying the Reserve's Accounting Team of successful Cash Settlements ;
- Authorizing automated Reserve Deposits on behalf of financial institutions ;
- Allowing instant Reserve Balance and Reserve Statement access, both to Reserve staff and to the financial institutions themselves.
Access & Permissions
FRB Assistant enforces two permission tiers on top of Discord's own guild permissions :
- Authorized Reserve operators : members holding one of the Discord roles configured for the Reserve. They can issue deposit requests and configure Reserve Relations channels on behalf of any financial institution.
- Financial Institution representatives : members of a financial institution's Qash partner team. They can access reserve balance and statement information, but only for their own institution.
Commands that expose sensitive operations (creating deposit requests, setting up relation channels) are restricted to authorized Reserve operators. Commands that only expose read access to an institution's own reserve information (balance, statements) are available to both authorized Reserve operators and that institution's own representatives.
If you attempt to run a command without the required permissions, FRB Assistant will reply with an ephemeral "You do not have permission to run this command." message.
Commands
All commands below are Discord slash commands, only available within the Federal Reserve Bank of Redmont's official Discord server.
/get-reserve-balance
Returns the current settled balance of a financial institution's Reserve Account.
| Parameter | Type | Required | Description |
|---|---|---|---|
institution-id | string | Yes | The Financial Institution's ID. Supports autocompletion by name. |
Who can use it: authorized Reserve operators, or a representative of the targeted financial institution.
/get-reserve-statement
Generates and returns a PDF statement for a financial institution's Reserve Account, for a given month and year.
| Parameter | Type | Required | Description |
|---|---|---|---|
institution-id | string | Yes | The Financial Institution's ID. Supports autocompletion by name. |
year | number | Yes | The statement's year. Supports autocompletion. |
month | number | Yes | The statement's month. Supports autocompletion, scoped to months that have already elapsed for the selected year. |
Who can use it: authorized Reserve operators, or a representative of the targeted financial institution.
/create-deposit-request
Creates a deposit request against a financial institution's Reserve Account through the Qash Core Banking API. Once created, the financial institution is notified (see Deposit Request Created) and given payment instructions to honor the request.
| Parameter | Type | Required | Description |
|---|---|---|---|
institution-id | string | Yes | The Financial Institution's ID. Supports autocompletion by name. |
amount | number | Yes | The amount to request, in the account's major currency unit. Must be greater than 0. |
Who can use it: authorized Reserve operators only.
Note: The targeted financial institution must already have a Redmont Reserve Account configured, otherwise the command will fail.
/setup-relation-channel
Designates a Discord text channel as the Reserve Relations channel for a financial institution. This channel is where FRB Assistant will post Deposit Request Created, Deposit Request Answered, and Deposits Returns filled notifications for that institution.
| Parameter | Type | Required | Description |
|---|---|---|---|
institution-id | string | Yes | The Financial Institution's ID. Supports autocompletion by name. |
channel | channel | Yes | The text channel to designate as the relations channel. |
Who can use it: authorized Reserve operators only.
Notifications
FRB Assistant delivers notifications to two kinds of channels :
- A single, Reserve-wide Settlement channel, used for Cash Settlement notifications.
- A Reserve Relations channel, configured per financial institution using
/setup-relation-channel, used for deposit request and deposits return notifications concerning that specific institution.
Cash Settlement
The Reserve's Accounting Team may receive notifications of successful Cash Settlements in the Settlement channel. Cash Settlements are emitted when Qash accepts money deposited on its accounts on behalf of the Federal Reserve.
These embeds will contain the following fields :
| Field | Description |
|---|---|
| Settlement ID | A technical tracking number that can be used to manage the cash settlement on the Qash Platform. |
| Amount | The Settlement Amount. |
| Reconciliation mode | How the transaction was registered, and on which ledger the money was affected. |
| Settlement mode | How the money was paid. |
The Reconciliation Mode describes how the transaction was registered and on which ledger the money was affected :
- "Done at CBS Account (
accountId)": the transaction was registered and affected on a Reserve Account directly ; - "Done at Platform Account (
accountId)": the transaction was registered and affected on the Platform Account. This has different meanings depending on how the money was settled. If the money was settled by a direct cash payment, there will be 2 records (a credit for the money received, then a debit for the money withdrawn). If the money was settled on the Platform Account itself, the money is still at Qash, ready for withdrawal.
The Settlement Mode describes how the money was paid :
- "Paid directly to account #
ID": the money has left Qash balances and is now available on the Reserve accounts. - "Paid to Platform Account (
accountId)": as noted while describing Reconciliation Mode, the money is in Qash's balance, affected to the Reserve's Partner Platform Account.
Deposit Request Created
Financial institutions are notified in their Reserve Relations channel whenever a new deposit request is created against their Reserve Account, whether through /create-deposit-request or through the Qash Core Banking API directly.
This embed will contain the following fields :
| Field | Description |
|---|---|
| Amount | The Declared Amount of the deposit request. |
| Remarks | Any remarks attached to the request, if any. |
| Request ID | The original Request ID, used to reference and honor the request. |
A second embed is sent alongside it with instructions on how to honor the request, listing the available payment methods (in-game payment command, Treasury API transfer, or the Qash API's Honor Redmont Reserve Deposit Request endpoint), each tagged with the Request ID as a memo/reference.
Deposit Request Answered
The Reserve's Compliance and Accounting Teams may receive notifications of answered Deposits Requests in the relevant institution's Reserve Relations channel. Answered Deposits Requests notifications are emitted when a Financial Institution or one of its representatives has sent money to the Reserve referencing a Deposit Request tracking ID, and the Reserve Connections API has processed the request.
If the request was accepted, the Reserve Account is also updated in real time.
This embed will contain the following fields :
| Field | Description |
|---|---|
| Request Status | Whether the request was accepted or rejected. |
| Declared Amount | The request's Declared Amount. |
| Authorized Amount | The request's Authorized Amount. None if the request was rejected. |
| Remarks | Any remarks tied to the request, if any. |
| Request ID | The original Request ID. |
Deposits Returns filed
The Reserve's Compliance Team may receive notifications of Deposits Returns filings in the relevant institution's Reserve Relations channel. Deposits Returns Filing notifications are emitted when a Financial Institution partnered with Qash has filed a new Deposits Returns (RDR-001) form through Qash's platform via the Reserve Connections API.
This embed will contain the following fields :
| Field | Description |
|---|---|
| ID | The Deposits Returns filing's ID. |
| Period Start | The start date of the returns period. |
| Period End | The end date of the returns period. |
| Total Customer Deposit Liabilities | The total customer deposit liabilities declared for the period. |
| Signature | The name and position of the person who certified the filing. |
Note: Requesting a signed certificate of filing directly from FRB Assistant is a planned capability and is not yet available. In the meantime, certificates can be requested from Qash's Compliance Team by referencing the Deposits Returns ID above.