diff options
author | Antoine A <> | 2023-11-08 01:01:08 +0000 |
---|---|---|
committer | Antoine A <> | 2023-11-08 01:01:23 +0000 |
commit | df386c3cc1ea558ac528578afcc2acdfd0c8650e (patch) | |
tree | 6483b80a2e23bbb5bdf3fb250011fed164c1422e | |
parent | c97d8db8e7feefad58a0f943e4cde5bc018c5d12 (diff) | |
download | docs-df386c3cc1ea558ac528578afcc2acdfd0c8650e.tar.gz docs-df386c3cc1ea558ac528578afcc2acdfd0c8650e.tar.bz2 docs-df386c3cc1ea558ac528578afcc2acdfd0c8650e.zip |
Update bank spec
-rw-r--r-- | core/api-corebank.rst | 67 |
1 files changed, 38 insertions, 29 deletions
diff --git a/core/api-corebank.rst b/core/api-corebank.rst index 1a1ebc30..aff40f3c 100644 --- a/core/api-corebank.rst +++ b/core/api-corebank.rst @@ -1072,15 +1072,21 @@ Monitor interface MonitorJustPayouts { type: "just-payouts"; - // This number identifies how many payments were made by a - // Taler exchange to a merchant bank account in the internal - // currency, in the timeframe specified in the request. - talerPayoutCount: number; - - // This amount accounts the overall *internal* currency that - // has been paid by a Taler exchange to a merchant internal - // bank account, in the timeframe specified in the request. - talerPayoutInternalVolume: Amount; + // How many payments were made to a Taler exchange by another + // internal bank account. + talerInCount: number; + + // Overall *internal* currency that has been paid to a Taler + // exchange by another bank account. + talerInInternalVolume: Amount; + + // How many payments were made by a Taler exchange to another + // internal bank account. + talerOutCount: number; + + // Overall *internal* currency that has been paid by a Taler + // exchange to another bank account. + talerOutInternalVolume: Amount; } .. ts:def:: MonitorWithCashout @@ -1089,38 +1095,41 @@ Monitor interface MonitorWithCashout { type: "with-cashout"; - // This number identifies how many cashin operations - // took place in the timeframe specified in the request. - // This number corresponds to how many withdrawals have - // been initiated by a wallet owner. Note: wallet owners + // How many cashin operations were confirmed by a + // wallet owner. Note: wallet owners // are NOT required to be customers of the libeufin-bank. cashinCount: number; - // This amount accounts how much external currency has been - // spent to withdraw Taler coins in the internal currency. + // Overall *external* currency that has been spend to withdraw + // Taler coins in the internal currency. // The exact amount of internal currency being created can be // calculated using the advertised conversion rates. cashinExternalVolume: Amount; - // This number identifies how many cashout operations were - // confirmed in the timeframe speficied in the request. + // How many cashout operations were confirmed. cashoutCount: number; - // This amount corresponds to how much *external* currency was - // paid by the libeufin-bank administrator to fulfill all the - // confirmed cashouts related to the timeframe specified in the - // request. + // Overall *external* currency that has been paid by the libeufin-bank + // administrator to fulfill all the confirmed cashouts. + // The exact amount of internal currency being created can be + // calculated using the advertised conversion rates. cashoutExternalVolume: Amount; - // This number identifies how many payments were made by a - // Taler exchange to a merchant bank account in the internal - // currency, in the timeframe specified in the request. - talerPayoutCount: number; + // How many payments were made to a Taler exchange by another + // internal bank account. + talerInCount: number; + + // Overall *internal* currency that has been paid to a Taler + // exchange by another bank account. + talerInInternalVolume: Amount; + + // How many payments were made by a Taler exchange to another + // internal bank account. + talerOutCount: number; - // This amount accounts the overall *internal* currency that - // has been paid by a Taler exchange to a merchant internal - // bank account, in the timeframe specified in the request. - talerPayoutInternalVolume: Amount; + // Overall *internal* currency that has been paid by a Taler + // exchange to another bank account. + talerOutInternalVolume: Amount; } |