taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

commit 3bd597bb73f5cf96004e81c183eed9e366d8b561
parent 988c3e1ff0ca343e864a51d827930572aac99151
Author: Christian Grothoff <christian@grothoff.org>
Date:   Tue, 31 Jan 2023 15:15:40 +0100

fix #7611

Diffstat:
Mcore/api-exchange.rst | 36++++++++++++++++++++++--------------
Mcore/api-merchant.rst | 19++++---------------
2 files changed, 26 insertions(+), 29 deletions(-)

diff --git a/core/api-exchange.rst b/core/api-exchange.rst @@ -1132,6 +1132,7 @@ Management operations authorized by master key **Details:** .. ts:def:: AmlOfficerSetup + interface AmlOfficerSetup { // Public key of the AML officer @@ -1141,10 +1142,10 @@ Management operations authorized by master key officer_name: string; // Is the account active? - is_active: bool; + is_active: boolean; // Is the account read-only? - read_only: bool; + read_only: boolean; // Signature by the exchange master key over a // `TALER_MasterAmlOfficerStatusPS`. @@ -1181,6 +1182,7 @@ Management operations authorized by master key **Details:** .. ts:def:: ExchangePartner + interface ExchangePartner { // Base URL of the partner exchange @@ -1235,7 +1237,7 @@ and freeze or unfreeze accounts suspected of money laundering. **Response** - :http:statuscode:`200 Success`: + :http:statuscode:`200 OK`: The responds will be an `AmlRecords` message. :http:statuscode:`204 No content`: There are no matching AML records. @@ -1249,6 +1251,7 @@ and freeze or unfreeze accounts suspected of money laundering. **Details:** .. ts:def:: AmlRecords + interface AmlRecords { // Array of AML records matching the query. @@ -1256,14 +1259,15 @@ and freeze or unfreeze accounts suspected of money laundering. } .. ts:def:: AmlRecord + interface AmlRecord { // Which payto-address is this record about. // Identifies a GNU Taler wallet or an affected bank account. - h_payto: Hash; + h_payto: PaytoHash; // What is the current AML state. - current_state: integer; + current_state: Integer; // When was the last decision made? last_decision_time: Timestamp; @@ -1299,6 +1303,7 @@ and freeze or unfreeze accounts suspected of money laundering. **Details:** .. ts:def:: AmlDecisionDetails + interface AmlDecisionDetails { // Array of AML decisions made for this account. Possibly @@ -1310,14 +1315,15 @@ and freeze or unfreeze accounts suspected of money laundering. kyc_records: KycDetail[]; } - .. ts:def:: AmlDecisionDetails - interface AmlDecisionDetails { + .. ts:def:: AmlDecisionDetail + + interface AmlDecisionDetail { // What was the justification given? - justification: String; + justification: string; // What is the new AML state. - new_state: integer; + new_state: Integer; // When was this decision made? decision_time: Timestamp; @@ -1325,11 +1331,12 @@ and freeze or unfreeze accounts suspected of money laundering. } .. ts:def:: KycDetail + interface KycDetail { // Name of the configuration section that specifies the provider // which was used to collect the KYC details - provider_section: String; + provider_section: string; // The collected KYC data. attributes: Object; @@ -1340,7 +1347,7 @@ and freeze or unfreeze accounts suspected of money laundering. } - .. http:post:: /aml/$OFFICER_PUB/decision + .. http:post:: /aml/$OFFICER_PUB/decision Make an AML decision. Triggers the respective action and records the justification. @@ -1369,6 +1376,7 @@ and freeze or unfreeze accounts suspected of money laundering. **Details:** .. ts:def:: AmlDecision + interface AmlDecision { // Human-readable justification for the decision. @@ -1380,11 +1388,11 @@ and freeze or unfreeze accounts suspected of money laundering. // Which payto-address is the decision about? // Identifies a GNU Taler wallet or an affected bank account. - h_payto: Hash; + h_payto: PaytoHash; // What is the new AML state (e.g. frozen, unfrozen, etc.) // Numerical values are defined in `enum TALER_AmlDecisionState`. - new_state: integer; + new_state: Integer; // Signature by the AML officer over a // `TALER_MasterAmlOfficerStatusPS`. @@ -1762,7 +1770,7 @@ exchange. reserve_sig: EddsaSignature; // Target account ``payto://``, optional. - h_payto?: string; + h_payto?: PaytoHash; // Timestamp of the close request. request_timestamp: Timestamp; diff --git a/core/api-merchant.rst b/core/api-merchant.rst @@ -3182,14 +3182,11 @@ Using template **Response:** - :http:statuscode:`200 OK`: - The using template is successful. Returns a `UsingTemplateResponse`. - :http:statuscode:`302 Found`: - The client should go to the indicated location. Only returned if the content type was HTML. The target site may allow the client to pay his order. - :http:statuscode:`404 Not found`: - The merchant instance is unknown or the template is unknown. - + The response is exactly the same type of response as when + creating an order using :ref:`POST /private/orders <post-order>`. + **Details:** + .. ts:def:: UsingTemplateDetails interface UsingTemplateDetails { @@ -3201,14 +3198,6 @@ Using template amount?: Amount; } - .. ts:def:: UsingTemplateResponse - - interface UsingTemplateResponse { - - // After enter the request. The user will be pay with a taler URL. - taler_url: string; - } - -------- Webhooks