diff options
author | Özgür Kesim <oec-taler@kesim.org> | 2021-10-21 12:36:18 +0200 |
---|---|---|
committer | Özgür Kesim <oec-taler@kesim.org> | 2021-10-21 12:36:18 +0200 |
commit | 62d59b76e237d82c3f8952c31949fac410332940 (patch) | |
tree | 2bee314d73b312f01af6ba4420c9ffa9fbbd1a84 | |
parent | 98a642e020994da811f5aa993c8bbbd74c76b724 (diff) | |
parent | 8e45ff21dd6fab404b8d1b24dbaee27fea12365a (diff) | |
download | docs-62d59b76e237d82c3f8952c31949fac410332940.tar.gz docs-62d59b76e237d82c3f8952c31949fac410332940.tar.bz2 docs-62d59b76e237d82c3f8952c31949fac410332940.zip |
Merge branch 'master' of ssh://git.taler.net/docs
-rw-r--r-- | core/api-bank-access.rst | 54 | ||||
-rw-r--r-- | core/api-exchange.rst | 9 | ||||
-rw-r--r-- | core/api-merchant.rst | 12 | ||||
-rw-r--r-- | manpages/taler.conf.5.rst | 5 |
4 files changed, 64 insertions, 16 deletions
diff --git a/core/api-bank-access.rst b/core/api-bank-access.rst index 7e0e84e..a530760 100644 --- a/core/api-bank-access.rst +++ b/core/api-bank-access.rst @@ -36,7 +36,8 @@ name and account password, at least in the GNU Taler demo bank implementation. .. http:get:: ${BANK_API_BASE_URL}/accounts/${account_name} - Request the current balance of an account. + Request the current balance of an account. (New: ) In case of a public bank + account, no authentication is required. **Response** @@ -136,6 +137,57 @@ name and account password, at least in the GNU Taler demo bank implementation. :http:statuscode:`422 Unprocessable Entity` (New): The withdraw operation cannot be confirmed because no exchange and reserve public key selection happened before. +------------ +Transactions +------------ + +.. http:GET:: ${BANK_API_BASE_URL}/accounts/${account_name}/transactions + + Retrieve all the transactions where the bank account with the label ``account_name`` + was debited or credited. + + **Response** + + .. ts:def:: BankAccountTransaction + + interface BankAccountTransactionsResponse { + transactions: BankAccountTransaction[]; + } + +.. http:GET:: ${BANK_API_BASE_URL}/accounts/${account_name}/transactions/${transaction_id} + + **Response** + + Retrieve the transaction whose identifier is ``transaction_id``, + in the following format: + + .. ts:def:: BankAccountTransaction + + interface BankAccountTransaction { + + creditorIban: string; + creditorBic: string; + creditorName: string; + + debtorIban: string; + debtorBic: string; + debtorName: string; + + amount: number; + currency: string; + subject: string; + + date: string; // YYYY-MM-DD + uid: string; // transaction (unique) ID + direction: "DBIT" | "CRDT"; + } + + +.. http:POST:: ${BANK_API_BASE_URL}/accounts/${account_name}/transactions + + Create a new transaction where the bank account with the label ``account_name`` is **debited**. + + ---------------------- Registration (Testing) ---------------------- diff --git a/core/api-exchange.rst b/core/api-exchange.rst index 49f29da..3f0be5a 100644 --- a/core/api-exchange.rst +++ b/core/api-exchange.rst @@ -1703,15 +1703,6 @@ denomination. // URL, or if the base URL has changed since the deposit. transaction_base_url?: string; - // Payment target that the merchant should - // use to check for its KYC status using - // the ``/kyc-check/$PAYMENT_TARGET_UUID`` endpoint. - payment_target_uuid: Integer; - - // True if the KYC check for the merchant has been - // satisfied. - kyc_ok: boolean; - // Timestamp when the deposit was received by the exchange. exchange_timestamp: Timestamp; diff --git a/core/api-merchant.rst b/core/api-merchant.rst index 519a432..d96cdd5 100644 --- a/core/api-merchant.rst +++ b/core/api-merchant.rst @@ -1274,14 +1274,14 @@ KYC status checks .. ts:def:: ExchangeKycTimeout - interface ExchangeKycTimeout { + interface ExchangeKycTimeout { - // Base URL of the exchange this is about. - exchange_url: string; + // Base URL of the exchange this is about. + exchange_url: string; - // Numeric `error code <error-codes>` indicating errors the exchange - // returned, or TALER_EC_INVALID for none. - exchange_code: number; + // Numeric `error code <error-codes>` indicating errors the exchange + // returned, or TALER_EC_INVALID for none. + exchange_code: number; // HTTP status code returned by the exchange when we asked for // information about the KYC status. diff --git a/manpages/taler.conf.5.rst b/manpages/taler.conf.5.rst index c148d33..74beabb 100644 --- a/manpages/taler.conf.5.rst +++ b/manpages/taler.conf.5.rst @@ -114,6 +114,7 @@ MASTER_PRIV_FILE BASE_URL The base URL under which the exchange can be reached. Added to wire transfers to enable tracking by merchants. + Used by the KYC logic when interacting with OAuth 2.0. AGGREGATOR_IDLE_SLEEP_INTERVAL For how long should the taler-exchange-aggregator sleep when it is idle @@ -210,6 +211,10 @@ KYC_OAUTH2_CLIENT_ID KYC_OAUTH2_CLIENT_SECRET Client secret of the exchange to use when talking to the KYC Oauth2 endpoint. Requires KYC_ENABLED to be "OAUTH2". +KYC_OAUTH2_POST_URL + URL to which the exchange will redirect the client's browser after successful authorization/login for the KYC process. + + EXCHANGE OFFLINE SIGNING OPTIONS -------------------------------- |