diff options
author | Christian Grothoff <christian@grothoff.org> | 2021-03-29 12:21:02 +0200 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2021-03-29 12:21:02 +0200 |
commit | 9753a6edb80e8e5496a427bbec013fc45b140b65 (patch) | |
tree | 9588684d95def42ead178d9b90d745006998adf9 /core/api-bank-integration.rst | |
parent | 319274126cd0d4baafdac1fe8fb9a90359939d05 (diff) | |
parent | 5f62198bd0ccc1599a836295f4c42be84b362606 (diff) | |
download | docs-9753a6edb80e8e5496a427bbec013fc45b140b65.tar.gz docs-9753a6edb80e8e5496a427bbec013fc45b140b65.tar.bz2 docs-9753a6edb80e8e5496a427bbec013fc45b140b65.zip |
Merge branch 'master' of git+ssh://git.taler.net/docs
Diffstat (limited to 'core/api-bank-integration.rst')
-rw-r--r-- | core/api-bank-integration.rst | 19 |
1 files changed, 9 insertions, 10 deletions
diff --git a/core/api-bank-integration.rst b/core/api-bank-integration.rst index 07299d6a..2864fbfd 100644 --- a/core/api-bank-integration.rst +++ b/core/api-bank-integration.rst @@ -28,7 +28,7 @@ to tightly integrate with GNU Taler. .. http:get:: /config - Get a configuration information about the bank. + Get configuration information about the bank. **Request:** @@ -48,10 +48,10 @@ to tightly integrate with GNU Taler. // The format is "current:revision:age". version: string; - // currency used by this bank + // Currency used by this bank. currency: string; - // name of the API + // Name of the API. name: "taler-bank-integration"; } @@ -61,8 +61,8 @@ Withdrawing ----------- Withdrawals with a Taler-integrated bank are based on withdrawal operations. -Some user interaction (on the Bank's website or a Taler-enabled ATM) creates a -withdrawal operation record in the Bank's database. The wallet can use a unique identifier +Some user interaction (on the bank's website or a Taler-enabled ATM) creates a +withdrawal operation record in the bank's database. The wallet can use a unique identifier for the withdrawal operation (the ``wopid``) to interact with the withdrawal operation. .. http:get:: ${BANK_API_BASE_URL}/withdrawal-operation/${wopid} @@ -87,7 +87,7 @@ for the withdrawal operation (the ``wopid``) to interact with the withdrawal ope .. ts:def:: BankWithdrawalOperationStatus export class BankWithdrawalOperationStatus { - // has the wallet selected parameters for the withdrawal operation + // Has the wallet selected parameters for the withdrawal operation // (exchange and reserve public key) and successfully sent it // to the bank? selection_done: boolean; @@ -101,7 +101,7 @@ for the withdrawal operation (the ``wopid``) to interact with the withdrawal ope amount: Amount; // Bank account of the customer that is withdrawing, as a - // payto URI. + // ``payto`` URI. sender_wire?: string; // Suggestion for an exchange given by the bank. @@ -136,7 +136,7 @@ for the withdrawal operation (the ``wopid``) to interact with the withdrawal ope // Reserve public key. reserve_pub: string; - // Exchange bank details specified in the 'payto' + // Exchange bank details specified in the ``payto`` // format. NOTE: this field is optional, therefore // the bank will initiate the withdrawal with the // default exchange, if not given. @@ -154,7 +154,6 @@ for the withdrawal operation (the ``wopid``) to interact with the withdrawal ope // URL that the user needs to navigate to in order to // complete some final confirmation (e.g. 2FA). // - // Only applicable when 'transfer_done' is false. + // Only applicable when ``transfer_done`` is ``false``. confirm_transfer_url?: string; } - |