diff options
Diffstat (limited to 'core/api-exchange.rst')
| -rw-r--r-- | core/api-exchange.rst | 2524 |
1 files changed, 1675 insertions, 849 deletions
diff --git a/core/api-exchange.rst b/core/api-exchange.rst index 720d5a82..4c5be000 100644 --- a/core/api-exchange.rst +++ b/core/api-exchange.rst @@ -1,6 +1,6 @@ .. This file is part of GNU TALER. - Copyright (C) 2014-2022 Taler Systems SA + Copyright (C) 2014-2024 Taler Systems SA TALER is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software @@ -24,50 +24,12 @@ for all details not specified in the individual requests. The `glossary <https://docs.taler.net/glossary.html#glossary>`_ defines all specific terms used in this section. -.. _keys: - --------------------- -Terms of service API --------------------- - -These APIs allow merchants and wallets to obtain the terms of service -and the privacy policy of an exchange. - - -.. http:get:: /terms - - Get the terms of service of the exchange. - The exchange will consider the "Accept" and "Accept-Language" and - "Accept-Encoding" headers when generating a response. Specifically, - it will try to find a response with an acceptable mime-type, then - pick the version in the most preferred language of the user, and - finally apply compression if that is allowed by the client and - deemed beneficial. - - The exchange will set an "Etag", and subsequent requests of the - same client should provide the tag in an "If-None-Match" header - to detect if the terms of service have changed. If not, a - "204 Not Modified" response will be returned. - - If the "Etag" is missing, the client should not cache the response and instead prompt the user again at the next opportunity. This is usually only the case if the terms of service were not configured correctly. - - -.. http:get:: /privacy - - Get the privacy policy of the exchange. - The exchange will consider the "Accept" and "Accept-Language" and - "Accept-Encoding" headers when generating a response. Specifically, - it will try to find a response with an acceptable mime-type, then - pick the version in the most preferred language of the user, and - finally apply compression if that is allowed by the client and - deemed beneficial. +.. contents:: Table of Contents + :local: - The exchange will set an "Etag", and subsequent requests of the - same client should provide the tag in an "If-None-Match" header - to detect if the privacy policy has changed. If not, a - "204 Not Modified" response will be returned. +.. include:: tos.rst - If the "Etag" is missing, the client should not cache the response and instead prompt the user again at the next opportunity. This is usually only the case if the privacy policy was not configured correctly. +.. _keys: --------------------------- Exchange status information @@ -94,6 +56,75 @@ possibly by using HTTPS. returned MUST be mixed with locally generated entropy. +.. http:get:: /config + + Return the protocol version and currency supported by this exchange backend, + as well as the list of possible KYC requirements. This endpoint is largely + for the SPA for AML officers. Merchants should use ``/keys`` which also + contains the protocol version and currency. + This specification corresponds to ``current`` protocol being **v19**. + + **Response:** + + :http:statuscode:`200 OK`: + The body is a `VersionResponse`. + + .. ts:def:: ExchangeVersionResponse + + interface ExchangeVersionResponse { + // libtool-style representation of the Exchange protocol version, see + // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning + // The format is "current:revision:age". + version: string; + + // Name of the protocol. + name: "taler-exchange"; + + // URN of the implementation (needed to interpret 'revision' in version). + // @since **v18**, may become mandatory in the future. + implementation?: string; + + // Currency supported by this exchange, given + // as a currency code ("USD" or "EUR"). + currency: string; + + // How wallets should render this currency. + currency_specification: CurrencySpecification; + + // Names of supported KYC requirements. + supported_kyc_requirements: string[]; + + } + + .. ts:def:: CurrencySpecification + + interface CurrencySpecification { + // Name of the currency. Like "US Dollar". + name: string; + + // Code of the currency. + // Deprecated in protocol **v18** for the exchange + // and in protocol v6 for the merchant. + currency: string; + + // how many digits the user may enter after the decimal_separator + num_fractional_input_digits: Integer; + + // Number of fractional digits to render in normal font and size. + num_fractional_normal_digits: Integer; + + // Number of fractional digits to render always, if needed by + // padding with zeros. + num_fractional_trailing_zero_digits: Integer; + + // map of powers of 10 to alternative currency names / symbols, must + // always have an entry under "0" that defines the base name, + // e.g. "0 => €" or "3 => k€". For BTC, would be "0 => BTC, -3 => mBTC". + // Communicates the currency symbol to be used. + alt_unit_names: { log10 : string }; + } + + .. http:get:: /keys Get a list of all denomination keys offered by the exchange, @@ -120,9 +151,55 @@ possibly by using HTTPS. // The format is "current:revision:age". version: string; - // The exchange's currency. + // The exchange's base URL. + base_url: string; + + // The exchange's currency or asset unit. currency: string; + // How wallets should render this currency. + currency_specification: CurrencySpecification; + + // Absolute cost offset for the STEFAN curve used + // to (over) approximate fees payable by amount. + stefan_abs: Amount; + + // Factor to multiply the logarithm of the amount + // with to (over) approximate fees payable by amount. + // Note that the total to be paid is first to be + // divided by the smallest denomination to obtain + // the value that the logarithm is to be taken of. + stefan_log: Amount; + + // Linear cost factor for the STEFAN curve used + // to (over) approximate fees payable by amount. + // + // Note that this is a scalar, as it is multiplied + // with the actual amount. + stefan_lin: Float; + + // Type of the asset. "fiat", "crypto", "regional" + // or "stock". Wallets should adjust their UI/UX + // based on this value. + asset_type: string; + + // Array of wire accounts operated by the exchange for + // incoming wire transfers. + accounts: WireAccount[]; + + // Object mapping names of wire methods (i.e. "iban" or "x-taler-bank") + // to wire fees. + wire_fees: { method : AggregateTransferFee[] }; + + // List of exchanges that this exchange is partnering + // with to enable wallet-to-wallet transfers. + wads: ExchangePartner[]; + + // Set to true if this exchange allows the use + // of reserves for rewards. + // @deprecated in protocol **v18**. + rewards_allowed: false; + // EdDSA master public key of the exchange, used to sign entries // in ``denoms`` and ``signkeys``. master_public_key: EddsaPublicKey; @@ -137,18 +214,20 @@ possibly by using HTTPS. // Currency must match ``currency``. wallet_balance_limit_without_kyc?: Amount[]; - // Denominations offered by this exchange. - // DEPRECATED: Will eventually be replaced by the - // differently structured "denominations" field. - denoms: Denom[]; - // Denominations offered by this exchange denominations: DenomGroup[]; - // Compact EdDSA `signature` (binary-only) over the XOR of all - // .hash fields (in binary) in the list "denominations". - // Signature of `TALER_ExchangeKeySetPS` - denominations_sig: EddsaSignature; + // Compact EdDSA `signature` (binary-only) over the + // contatentation of all of the master_sigs (in reverse + // chronological order by group) in the arrays under + // "denominations". Signature of `TALER_ExchangeKeySetPS` + exchange_sig: EddsaSignature; + + // Public EdDSA key of the exchange that was used to generate the signature. + // Should match one of the exchange's signing keys from ``signkeys``. It is given + // explicitly as the client might otherwise be confused by clock skew as to + // which signing key was used for the ``exchange_sig``. + exchange_pub: EddsaPublicKey; // Denominations for which the exchange currently offers/requests recoup. recoup: Recoup[]; @@ -165,24 +244,99 @@ possibly by using HTTPS. // The exchange's signing keys. signkeys: SignKey[]; - // Compact EdDSA `signature` (binary-only) over the SHA-512 hash of the - // concatenation of all SHA-512 hashes of the RSA denomination public keys - // in ``denoms`` in the same order as they were in ``denoms``. Note that for - // hashing, the binary format of the RSA public keys is used, and not their - // `base32 encoding <base32>`. Wallets cannot do much with this signature by itself; - // it is only useful when multiple clients need to establish that the exchange - // is sabotaging end-user anonymity by giving disjoint denomination keys to - // different users. If an exchange were to do this, this signature allows the - // clients to demonstrate to the public that the exchange is dishonest. - // Signature of `TALER_ExchangeKeySetPS` - // DEPRICATED: Will eventually replaced by "denominations_sig" - eddsa_sig: EddsaSignature; + // Optional field with a dictionary of (name, object) pairs defining the + // supported and enabled extensions, such as ``age_restriction``. + extensions?: { name: ExtensionManifest }; + + // Signature by the exchange master key of the SHA-256 hash of the + // normalized JSON-object of field extensions, if it was set. + // The signature has purpose TALER_SIGNATURE_MASTER_EXTENSIONS. + extensions_sig?: EddsaSignature; + + } + + The specification for the account object is: + + .. ts:def:: WireAccount + + interface WireAccount { + // ``payto://`` URI identifying the account and wire method + payto_uri: string; + + // URI to convert amounts from or to the currency used by + // this wire account of the exchange. Missing if no + // conversion is applicable. + conversion_url?: string; + + // Restrictions that apply to bank accounts that would send + // funds to the exchange (crediting this exchange bank account). + // Optional, empty array for unrestricted. + credit_restrictions: AccountRestriction[]; + + // Restrictions that apply to bank accounts that would receive + // funds from the exchange (debiting this exchange bank account). + // Optional, empty array for unrestricted. + debit_restrictions: AccountRestriction[]; + + // Signature using the exchange's offline key over + // a `TALER_MasterWireDetailsPS` + // with purpose ``TALER_SIGNATURE_MASTER_WIRE_DETAILS``. + master_sig: EddsaSignature; + + // Display label wallets should use to show this + // bank account. + // Since protocol **v19**. + bank_label?: string; + + // *Signed* integer with the display priority for + // this bank account. Optional, 0 if missing. + // Since protocol **v19**. + priority?: Integer; + + } + + .. ts:def:: AccountRestriction + + type AccountRestriction = + | RegexAccountRestriction + | DenyAllAccountRestriction + + .. ts:def:: DenyAllAccountRestriction + + // Account restriction that disables this type of + // account for the indicated operation categorically. + interface DenyAllAccountRestriction { + + type: "deny"; + } + + .. ts:def:: RegexAccountRestriction + + // Accounts interacting with this type of account + // restriction must have a payto://-URI matching + // the given regex. + interface RegexAccountRestriction { + + type: "regex"; + + // Regular expression that the payto://-URI of the + // partner account must follow. The regular expression + // should follow posix-egrep, but without support for character + // classes, GNU extensions, back-references or intervals. See + // https://www.gnu.org/software/findutils/manual/html_node/find_html/posix_002degrep-regular-expression-syntax.html + // for a description of the posix-egrep syntax. Applications + // may support regexes with additional features, but exchanges + // must not use such regexes. + payto_regex: string; + + // Hint for a human to understand the restriction + // (that is hopefully easier to comprehend than the regex itself). + human_hint: string; + + // Map from IETF BCP 47 language tags to localized + // human hints. + human_hint_i18n?: { [lang_tag: string]: string }; - // Public EdDSA key of the exchange that was used to generate the signature. - // Should match one of the exchange's signing keys from ``/keys``. It is given - // explicitly as the client might otherwise be confused by clock skew as to - // which signing key was used. - eddsa_pub: EddsaPublicKey; } .. ts:def:: GlobalFees @@ -195,11 +349,6 @@ possibly by using HTTPS. // What date (exclusive) does this fees stop going into effect? end_date: Timestamp; - // KYC fee, charged when a user wants to create an account. - // The first year of the account_annual_fee after the KYC is - // always included. - kyc_fee: Amount; - // Account history fee, charged when a user wants to // obtain a reserve/account history. history_fee: Amount; @@ -221,13 +370,6 @@ possibly by using HTTPS. // retain the account history for legal reasons until this time. history_expiration: RelativeTime; - // How long does the exchange promise to keep funds - // an account for which the KYC has never happened - // after a purse was merged into an account? Basically, - // after this time funds in an account without KYC are - // forfeit. - account_kyc_timeout: RelativeTime; - // Non-negative number of concurrent purses that any // account holder is allowed to create without having // to pay the purse_fee. @@ -244,7 +386,6 @@ possibly by using HTTPS. } - .. ts:def:: AgeMask // Binary representation of the age groups. @@ -330,10 +471,6 @@ possibly by using HTTPS. // Fee charged by the exchange for refunding a coin of this denomination. fee_refund: Amount; - // XOR of all the SHA-512 hash values of the denominations' public keys - // in this group. Note that for hashing, the binary format of the - // public keys is used, and not their base32 encoding. - hash: HashCode; } .. ts:def:: DenomCommon @@ -345,51 +482,27 @@ possibly by using HTTPS. // When does the denomination key become valid? stamp_start: Timestamp; - // When is it no longer possible to deposit coins + // When is it no longer possible to withdraw coins // of this denomination? stamp_expire_withdraw: Timestamp; - // Timestamp indicating by when legal disputes relating to these coins must - // be settled, as the exchange will afterwards destroy its evidence relating to - // transactions involving this coin. - stamp_expire_legal: Timestamp; - } - - .. ts:def:: Denom - - interface Denom { - // How much are coins of this denomination worth? - value: Amount; - - // When does the denomination key become valid? - stamp_start: Timestamp; - // When is it no longer possible to deposit coins // of this denomination? - stamp_expire_withdraw: Timestamp; + stamp_expire_deposit: Timestamp; // Timestamp indicating by when legal disputes relating to these coins must // be settled, as the exchange will afterwards destroy its evidence relating to // transactions involving this coin. stamp_expire_legal: Timestamp; - // Public key for the denomination. - denom_pub: DenominationKey; - - // Fee charged by the exchange for withdrawing a coin of this denomination. - fee_withdraw: Amount; - - // Fee charged by the exchange for depositing a coin of this denomination. - fee_deposit: Amount; - - // Fee charged by the exchange for refreshing a coin of this denomination. - fee_refresh: Amount; - - // Fee charged by the exchange for refunding a coin of this denomination. - fee_refund: Amount; - - // Signature of `TALER_DenominationKeyValidityPS`. - master_sig: EddsaSignature; + // Set to 'true' if the exchange somehow "lost" + // the private key. The denomination was not + // necessarily revoked, but still cannot be used + // to withdraw coins at this time (theoretically, + // the private key could be recovered in the + // future; coins signed with the private key + // remain valid). + lost?: boolean; } .. ts:def:: DenominationKey @@ -513,53 +626,6 @@ possibly by using HTTPS. Both the individual denominations *and* the denomination list is signed, allowing customers to prove that they received an inconsistent list. -.. _wire-req: - -.. http:get:: /wire - - Returns a list of payment methods supported by the exchange. The idea is that wallets may use this information to instruct users on how to perform wire transfers to top up their wallets. - - **Response:** - - :http:statuscode:`200 Ok`: - The exchange responds with a `WireResponse` object. This request should virtually always be successful. - - **Details:** - - .. ts:def:: WireResponse - - interface WireResponse { - - // Master public key of the exchange, must match the key returned in ``/keys``. - master_public_key: EddsaPublicKey; - - // Array of wire accounts operated by the exchange for - // incoming wire transfers. - accounts: WireAccount[]; - - // Object mapping names of wire methods (i.e. "iban" or "x-taler-bank") - // to wire fees. - fees: { method : AggregateTransferFee }; - - // List of exchanges that this exchange is partnering - // with to enable wallet-to-wallet transfers. - wads: ExchangePartner[]; - } - - The specification for the account object is: - - .. ts:def:: WireAccount - - interface WireAccount { - // ``payto://`` URI identifying the account and wire method - payto_uri: string; - - // Signature using the exchange's offline key over - // a `TALER_MasterWireDetailsPS` - // with purpose ``TALER_SIGNATURE_MASTER_WIRE_DETAILS``. - master_sig: EddsaSignature; - } - Aggregate wire transfer fees representing the fees the exchange charges per wire transfer to a merchant must be specified as an array in all wire transfer response objects under ``fees``. The @@ -574,9 +640,6 @@ possibly by using HTTPS. // Per transfer closing fee. closing_fee: Amount; - // Per exchange-to-exchange transfer (wad) fee. - wad_fee: Amount; - // What date (inclusive) does this fee go into effect? // The different fees must cover the full time period in which // any of the denomination keys are valid without overlap. @@ -601,6 +664,9 @@ possibly by using HTTPS. // Public master key of the partner exchange. partner_master_pub: EddsaPublicKey; + // Per exchange-to-exchange transfer (wad) fee. + wad_fee: Amount; + // Exchange-to-exchange wad (wire) transfer frequency. wad_frequency: RelativeTime; @@ -685,8 +751,8 @@ Management operations authorized by master key // transactions involving this coin. stamp_expire_legal: Timestamp; - // Public (RSA) key for the denomination. - denom_pub: RsaPublicKey; + // Public key for the denomination. + denom_pub: DenominationKey; // Fee charged by the exchange for withdrawing a coin of this denomination. fee_withdraw: Amount; @@ -767,7 +833,7 @@ Management operations authorized by master key interface DenomSignature { - // Hash of the public (RSA) key of the denomination. + // Hash of the public key of the denomination. h_denom_pub: HashCode; // Signature over `TALER_DenominationKeyValidityPS`. @@ -942,7 +1008,7 @@ Management operations authorized by master key .. http:post:: /management/wire-fee - This request will be used to configure wire fees. + This request is used to configure wire fees. **Request:** @@ -982,9 +1048,6 @@ Management operations authorized by master key // Wire fee to charge during that time period for this wire method. wire_fee: Amount; - // Wad fee to charge during that time period for this wire method. - wad_fee: Amount; - } .. http:post:: /management/global-fees @@ -1050,6 +1113,16 @@ Management operations authorized by master key // become active immediately! Used ONLY to detect replay attacks. validity_start: Timestamp; + // Display label wallets should use to show this + // bank account. + // Since protocol **v19**. + bank_label?: string; + + // *Signed* integer with the display priority for + // this bank account. + // Since protocol **v19**. + priority?: Integer; + } .. http:post:: /management/wire/disable @@ -1147,479 +1220,429 @@ Management operations authorized by master key } -.. http:post:: /management/partners +.. http:post:: /management/aml-officers - Enables a partner exchange for wad transfers. - - .. note:: - - This is a draft API that is not yet implemented. + Update settings for an AML Officer status. **Request:** - The request must be an `ExchangePartner` message. + The request must be an `AmlOfficerSetup` message. **Response** :http:statuscode:`204 No content`: - The partner has been added successfully. + The officer settings have been updated successfully. :http:statuscode:`403 Forbidden`: The signature is invalid. :http:statuscode:`409 Conflict`: The exchange has previously received a conflicting configuration message. + **Details:** + .. ts:def:: AmlOfficerSetup + interface AmlOfficerSetup { ---------------- -Auditor actions ---------------- + // Public key of the AML officer + officer_pub: EddsaPublicKey; -.. _auditor_action: + // Legal full name of the AML officer + officer_name: string; -This part of the API is for the use by auditors interacting with the exchange. + // Is the account active? + is_active: boolean; + // Is the account read-only? + read_only: boolean; -.. http:post:: /auditors/$AUDITOR_PUB/$H_DENOM_PUB + // Signature by the exchange master key over a + // `TALER_MasterAmlOfficerStatusPS`. + // Must have purpose ``TALER_SIGNATURE_MASTER_AML_KEY``. + master_sig: EddsaSignature; - This is used to add an auditor signature to the ``/keys`` response. It - affirms to wallets and merchants that this auditor is indeed auditing - the coins issued by the respective denomination. There is no "delete" - operation for this, as auditors can only stop auditing a denomination - when it expires. + // When will the change take effect? + change_date: Timestamp; + + } + + + .. http:post:: /management/partners + + Enables a partner exchange for wad transfers. **Request:** - The request must be a `AuditorSignatureAddMessage`. + The request must be an `ExchangePartner` message. - **Response:** + **Response** :http:statuscode:`204 No content`: - The backend has successfully stored the auditor signature. + The partner has been added successfully. :http:statuscode:`403 Forbidden`: - The auditor signature is invalid. - :http:statuscode:`404 Not found`: - The denomination key for which the auditor is providing a signature is unknown. - The response will be a `DenominationUnknownMessage`. - :http:statuscode:`410 Gone`: - This auditor is no longer supported by the exchange. - :http:statuscode:`412 Precondition failed`: - This auditor is not yet known to the exchange. + The signature is invalid. + :http:statuscode:`409 Conflict`: + The exchange has previously received a conflicting configuration message. **Details:** - .. ts:def:: DenominationUnknownMessage + .. ts:def:: ExchangePartner - interface DenominationUnknownMessage { + interface ExchangePartner { - // Taler error code. - code: number; + // Base URL of the partner exchange + partner_base_url: string; - // Signature by the exchange over a - // `TALER_DenominationUnknownAffirmationPS`. - // Must have purpose ``TALER_SIGNATURE_EXCHANGE_AFFIRM_DENOM_UNKNOWN``. - exchange_sig: EddsaSignature; + // Master (offline) public key of the partner exchange. + partner_pub: EddsaPublicKey; - // Public key of the exchange used to create - // the 'exchange_sig. - exchange_pub: EddsaPublicKey; + // How frequently will wad transfers be made + wad_frequency: RelativeTime; - // Hash of the denomination public key that is unknown. - h_denom_pub: HashCode; + // Signature by the exchange master key over a + // `TALER_PartnerConfigurationPS`. + // Must have purpose ``TALER_SIGNATURE_MASTER_PARTNER_DETAILS``. + master_sig: EddsaSignature; - // When was the signature created. - timestamp: Timestamp; + // When will the partner relationship start (inclusive). + start_date: Timestamp; + + // When will the partner relationship end (exclusive). + end_date: Timestamp; + + // Wad fee to be charged (to customers). + wad_fee: Amount; } - .. ts:def:: AuditorSignatureAddMessage +-------------- +AML operations +-------------- - interface AuditorSignatureAddMessage { +This API is only for designated AML officers. It is used +to allow exchange staff to monitor suspicious transactions +and freeze or unfreeze accounts suspected of money laundering. - // Signature by the auditor over a - // `TALER_ExchangeKeyValidityPS`. - // Must have purpose ``TALER_SIGNATURE_AUDITOR_EXCHANGE_KEYS``. - auditor_sig: EddsaSignature; - } +.. http:get:: /aml/$OFFICER_PUB/decisions/$STATE + Obtain list of AML decisions (filtered by $STATE). ``$STATE`` must be either ``normal``, ``pending`` or ``frozen``. ----------- -Withdrawal ----------- + *Taler-AML-Officer-Signature*: The client must provide Base-32 encoded EdDSA signature with ``$OFFICER_PRIV``, affirming the desire to obtain AML data. Note that this is merely a simple authentication mechanism, the details of the request are not protected by the signature. -This API is used by the wallet to obtain digital coins. + :query delta: *Optional*. takes value of the form ``N (-N)``, so that at most ``N`` values strictly older (younger) than ``start`` are returned. Defaults to ``-20`` to return the last 20 entries (before ``start``). + :query start: *Optional*. Row number threshold, see ``delta`` for its interpretation. Defaults to ``INT64_MAX``, namely the biggest row id possible in the database. -When transferring money to the exchange such as via SEPA transfers, the exchange creates -a *reserve*, which keeps the money from the customer. The customer must -specify an EdDSA reserve public key as part of the transfer, and can then -withdraw digital coins using the corresponding private key. All incoming and -outgoing transactions are recorded under the corresponding public key by the -exchange. + **Response** -.. note:: + :http:statuscode:`200 OK`: + The responds will be an `AmlRecords` message. + :http:statuscode:`204 No content`: + There are no matching AML records. + :http:statuscode:`403 Forbidden`: + The signature is invalid. + :http:statuscode:`404 Not found`: + The designated AML account is not known. + :http:statuscode:`409 Conflict`: + The designated AML account is not enabled. - Eventually the exchange will need to advertise a policy for how long it will - keep transaction histories for inactive or even fully drained reserves. We - will therefore need some additional handler similar to ``/keys`` to - advertise those terms of service. + **Details:** + .. ts:def:: AmlRecords -.. http:get:: /reserves/$RESERVE_PUB + interface AmlRecords { - Request information about a reserve. + // Array of AML records matching the query. + records: AmlRecord[]; + } - **Request:** + .. ts:def:: AmlRecord - :query timeout_ms=MILLISECONDS: *Optional.* If specified, the exchange will wait up to MILLISECONDS for incoming funds before returning a 404 if the reserve does not yet exist. + interface AmlRecord { - **Response:** + // Which payto-address is this record about. + // Identifies a GNU Taler wallet or an affected bank account. + h_payto: PaytoHash; - :http:statuscode:`200 OK`: - The exchange responds with a `ReserveSummary` object; the reserve was known to the exchange. - :http:statuscode:`404 Not found`: - The reserve key does not belong to a reserve known to the exchange. + // What is the current AML state. + current_state: Integer; - **Details:** + // Monthly transaction threshold before a review will be triggered + threshold: Amount; - .. ts:def:: ReserveSummary + // RowID of the record. + rowid: Integer; - interface ReserveSummary { - // Balance left in the reserve. - balance: Amount; } -.. http:post:: /reserves/$RESERVE_PUB/status +.. http:get:: /aml/$OFFICER_PUB/decision/$H_PAYTO - Request information about a reserve or an account. + Obtain deails about an AML decision. - **Request:** + *Taler-AML-Officer-Signature*: The client must provide Base-32 encoded EdDSA signature with ``$OFFICER_PRIV``, affirming the desire to obtain AML data. Note that this is merely a simple authentication mechanism, the details of the request are not protected by the signature. - The request body must be a `ReserveStatusRequest` object. + :query history: *Optional*. If set to yes, we return all historic decisions and not only the last one. - **Response:** + **Response** :http:statuscode:`200 OK`: - The exchange responds with a `ReserveStatus` object; the reserve was known to the exchange. + The responds will be an `AmlDecisionDetails` message. + :http:statuscode:`204 No content`: + There are no matching AML records for the given payto://-URI. :http:statuscode:`403 Forbidden`: - The *TALER_SIGNATURE_RESERVE_STATUS_REQUEST* signature is invalid. - This response comes with a standard `ErrorDetail` response. Alternatively, the provided timestamp is not close to the current time. + The signature is invalid. :http:statuscode:`404 Not found`: - The reserve key does not belong to a reserve known to the exchange. + The designated AML account is not known. + :http:statuscode:`409 Conflict`: + The designated AML account is not enabled. **Details:** - .. ts:def:: ReserveStatusRequest - - interface ReserveStatusRequest { - // Signature of purpose - // ``TALER_SIGNATURE_RESERVE_STATUS_REQUEST`` over - // a `TALER_ReserveStatusRequestSignaturePS`. - reserve_sig: EddsaSignature; - - // Time when the client made the request. - // Timestamp must be reasonably close to the time of - // the exchange, otherwise the exchange may reject - // the request. - request_timestamp: Timestamp; - } + .. ts:def:: AmlDecisionDetails - .. ts:def:: ReserveStatus + interface AmlDecisionDetails { - interface ReserveStatus { - // Balance left in the reserve. - balance: Amount; + // Array of AML decisions made for this account. Possibly + // contains only the most recent decision if "history" was + // not set to 'true'. + aml_history: AmlDecisionDetail[]; - // Transaction history for this reserve. - // May be partial (!). - history: TransactionHistoryItem[]; + // Array of KYC attributes obtained for this account. + kyc_attributes: KycDetail[]; } - Objects in the transaction history have the following format: - - .. ts:def:: TransactionHistoryItem - - // Union discriminated by the "type" field. - type TransactionHistoryItem = - | AccountMergeTransaction - | AccountSetupTransaction - | ReserveHistoryTransaction - | ReserveWithdrawTransaction - | ReserveCreditTransaction - | ReserveClosingTransaction - | PurseMergeTransaction; - - .. ts:def:: PurseMergeTransaction - - interface PurseMergeTransaction { - type: "MERGE"; - - // SHA-512 hash of the contact of the purse. - h_contract_terms: HashCode; - - // EdDSA public key used to approve merges of this purse. - merge_pub: EddsaPublicKey; - - // Minimum age required for all coins deposited into the purse. - min_age: Integer; + .. ts:def:: AmlDecisionDetail - // Number that identifies who created the purse - // and how it was paid for. - flags: Integer; + interface AmlDecisionDetail { - // Purse public key. - purse_pub: EddsaPublicKey; + // What was the justification given? + justification: string; - // EdDSA signature of the account/reserve affirming the merge - // over a `TALER_AccountMergeSignaturePS`. - // Must be of purpose ``TALER_SIGNATURE_ACCOUNT_MERGE`` - reserve_sig: EddsaSignature; + // FIXME: review! + // What is the new AML state. + new_state: Integer; - // Client-side timestamp of when the merge request was made. - merge_timestamp: Timestamp; + // When was this decision made? + decision_time: Timestamp; - // Indicative time by which the purse should expire - // if it has not been merged into an account. At this - // point, all of the deposits made should be - // auto-refunded. - purse_expiration: Timestamp; + // What is the new AML decision threshold (in monthly transaction volume)? + new_threshold: Amount; - // Purse fee the reserve owner paid for the purse creation. - purse_fee: Amount; - - // Total amount merged into the reserve. - // (excludes fees). - amount: Amount; + // Who made the decision? + decider_pub: AmlOfficerPublicKeyP; - // True if the purse was actually merged. - // If false, only the purse_fee has an impact - // on the reserve balance! - merged: boolean; } - .. ts:def:: ReserveHistoryTransaction + .. ts:def:: KycDetail - interface ReserveHistoryTransaction { - type: "HISTORY"; + interface KycDetail { - // Fee agreed to by the reserve owner. - amount: Amount; + // Name of the configuration section that specifies the provider + // which was used to collect the KYC details + // FIXME: review! + provider_section: string; - // Time when the request was made. - request_timestamp: Timestamp; + // The collected KYC data. NULL if the attribute data could not + // be decrypted (internal error of the exchange, likely the + // attribute key was changed). + attributes?: Object; - // Signature created with the reserve's private key. - // Must be of purpose ``TALER_SIGNATURE_RESERVE_HISTORY_REQUEST`` over - // a `TALER_ReserveHistoryRequestSignaturePS`. - reserve_sig: EddsaSignature; + // Time when the KYC data was collected + collection_time: Timestamp; - } + // Time when the validity of the KYC data will expire + expiration_time: Timestamp; - .. ts:def:: AccountSetupTransaction + } - interface AccountSetupTransaction { - type: "SETUP"; - // KYC fee agreed to by the reserve owner. - kyc_fee: Amount; + .. http:post:: /aml/$OFFICER_PUB/decision - // Time when the KYC was triggered. - kyc_timestamp: Timestamp; + Make an AML decision. Triggers the respective action and + records the justification. - // Hash of the wire details of the account. - // Note that this hash is unsalted and potentially - // private (as it could be inverted), hence access - // to this endpoint must be authorized using the - // private key of the reserve. - h_wire: HashCode; + **Request:** - // Signature created with the reserve's private key. - // Must be of purpose ``TALER_SIGNATURE_ACCOUNT_SETUP_REQUEST`` over - // a ``TALER_AccountSetupRequestSignaturePS``. - reserve_sig: EddsaSignature; + The request must be an `AmlDecision` message. - } + **Response** - .. ts:def:: AccountMergeTransaction + :http:statuscode:`204 No content`: + The AML decision has been executed and recorded successfully. + :http:statuscode:`403 Forbidden`: + The signature is invalid. + :http:statuscode:`404 Not found`: + The address the decision was made upon is unknown to the exchange or + the designated AML account is not known. + :http:statuscode:`409 Conflict`: + The designated AML account is not enabled or a more recent + decision was already submitted. - interface AccountMergeTransaction { - type: "MERGE"; + **Details:** - // Actual amount merged (what was left after fees). - amount: Amount; + .. ts:def:: AmlDecision - // Minimum amount merged (amount signed by the - // reserve and purse signatures). - minimum_amount: Amount; + interface AmlDecision { - // Purse that was merged. - purse_pub: EddsaPublicKey; + // Human-readable justification for the decision. + justification: string; - // Time of the merge. - merge_timestamp: Timestamp; + // At what monthly transaction volume should the + // decision be automatically reviewed? + new_threshold: Amount; - // Expiration time of the purse. - purse_expiration: Timestamp; + // Which payto-address is the decision about? + // Identifies a GNU Taler wallet or an affected bank account. + h_payto: PaytoHash; - // Hash of the contract. - h_contract: HashCode; + // What is the new AML state (e.g. frozen, unfrozen, etc.) + // Numerical values are defined in `AmlDecisionState`. + new_state: Integer; - // Hash of the wire details of the reserve. - h_wire: HashCode; + // Signature by the AML officer over a `TALER_AmlDecisionPS`. + // Must have purpose ``TALER_SIGNATURE_MASTER_AML_KEY``. + officer_sig: EddsaSignature; - // Signature created with the reserve's private key. - // Must be of purpose ``TALER_SIGNATURE_ACCOUNT_MERGE`` over - // a `TALER_AccountMergeSignaturePS`. - reserve_sig: EddsaSignature; + // When was the decision made? + decision_time: Timestamp; - // Signature created with the purse's private key. - // Must be of purpose ``TALER_SIGNATURE_PURSE_MERGE`` - // over a `TALER_PurseMergeSignaturePS`. - purse_sig: EddsaSignature; - - // Deposit fees that were charged to the purse. - deposit_fees: Amount; + // Optional argument to impose new KYC requirements + // that the customer has to satisfy to unblock transactions. + kyc_requirements?: string[]; } - .. ts:def:: ReserveWithdrawTransaction - interface ReserveWithdrawTransaction { - type: "WITHDRAW"; +--------------- +Auditor actions +--------------- - // Amount withdrawn. - amount: Amount; +.. _auditor_action: - // Hash of the denomination public key of the coin. - h_denom_pub: HashCode; +This part of the API is for the use by auditors interacting with the exchange. - // Hash of the blinded coin to be signed. - h_coin_envelope: HashCode; - // Signature over a `TALER_WithdrawRequestPS` - // with purpose ``TALER_SIGNATURE_WALLET_RESERVE_WITHDRAW`` - // created with the reserve's private key. - reserve_sig: EddsaSignature; +.. http:post:: /auditors/$AUDITOR_PUB/$H_DENOM_PUB - // Fee that is charged for withdraw. - withdraw_fee: Amount; - } + This is used to add an auditor signature to the ``/keys`` response. It + affirms to wallets and merchants that this auditor is indeed auditing + the coins issued by the respective denomination. There is no "delete" + operation for this, as auditors can only stop auditing a denomination + when it expires. + **Request:** - .. ts:def:: ReserveCreditTransaction + The request must be a `AuditorSignatureAddMessage`. - interface ReserveCreditTransaction { - type: "CREDIT"; + **Response:** - // Amount deposited. - amount: Amount; + :http:statuscode:`204 No content`: + The backend has successfully stored the auditor signature. + :http:statuscode:`403 Forbidden`: + The auditor signature is invalid. + :http:statuscode:`404 Not found`: + The denomination key for which the auditor is providing a signature is unknown. + The response will be a `DenominationUnknownMessage`. + :http:statuscode:`410 Gone`: + This auditor is no longer supported by the exchange. + :http:statuscode:`412 Precondition failed`: + This auditor is not yet known to the exchange. - // Sender account ``payto://`` URL. - sender_account_url: string; + **Details:** - // Opaque identifier internal to the exchange that - // uniquely identifies the wire transfer that credited the reserve. - wire_reference: Integer; + .. ts:def:: DenominationUnknownMessage - // Timestamp of the incoming wire transfer. - timestamp: Timestamp; - } + interface DenominationUnknownMessage { + // Taler error code. + code: number; - .. ts:def:: ReserveClosingTransaction + // Signature by the exchange over a + // `TALER_DenominationUnknownAffirmationPS`. + // Must have purpose ``TALER_SIGNATURE_EXCHANGE_AFFIRM_DENOM_UNKNOWN``. + exchange_sig: EddsaSignature; - interface ReserveClosingTransaction { - type: "CLOSING"; + // Public key of the exchange used to create + // the 'exchange_sig. + exchange_pub: EddsaPublicKey; - // Closing balance. - amount: Amount; + // Hash of the denomination public key that is unknown. + h_denom_pub: HashCode; - // Closing fee charged by the exchange. - closing_fee: Amount; + // When was the signature created. + timestamp: Timestamp; - // Wire transfer subject. - wtid: Base32; + } - // ``payto://`` URI of the wire account into which the funds were returned to. - receiver_account_details: string; + .. ts:def:: AuditorSignatureAddMessage - // This is a signature over a - // struct `TALER_ReserveCloseConfirmationPS` with purpose - // ``TALER_SIGNATURE_EXCHANGE_RESERVE_CLOSED``. - exchange_sig: EddsaSignature; + interface AuditorSignatureAddMessage { - // Public key used to create 'exchange_sig'. - exchange_pub: EddsaPublicKey; + // Signature by the auditor over a + // `TALER_ExchangeKeyValidityPS`. + // Must have purpose ``TALER_SIGNATURE_AUDITOR_EXCHANGE_KEYS``. + auditor_sig: EddsaSignature; - // Time when the reserve was closed. - timestamp: Timestamp; } +.. _exchange-withdrawal: - .. ts:def:: ReserveRecoupTransaction - - interface ReserveRecoupTransaction { - type: "RECOUP"; - - // Amount paid back. - amount: Amount; +---------- +Withdrawal +---------- - // This is a signature over - // a struct `TALER_RecoupConfirmationPS` with purpose - // ``TALER_SIGNATURE_EXCHANGE_CONFIRM_RECOUP``. - exchange_sig: EddsaSignature; +This API is used by the wallet to obtain digital coins. - // Public key used to create 'exchange_sig'. - exchange_pub: EddsaPublicKey; +When transferring money to the exchange such as via SEPA transfers, the exchange creates +a *reserve*, which keeps the money from the customer. The customer must +specify an EdDSA reserve public key as part of the transfer, and can then +withdraw digital coins using the corresponding private key. All incoming and +outgoing transactions are recorded under the corresponding public key by the +exchange. - // Time when the funds were paid back into the reserve. - timestamp: Timestamp; +.. note:: - // Public key of the coin that was paid back. - coin_pub: CoinPublicKey; - } + Eventually the exchange will need to advertise a policy for how long it will + keep transaction histories for inactive or even fully drained reserves. We + will therefore need some additional handler similar to ``/keys`` to + advertise those terms of service. -.. http:post:: /reserves/$RESERVE_PUB/history +.. http:get:: /reserves/$RESERVE_PUB - Request information about the full history of - a reserve or an account. + Request summary information about a reserve. **Request:** - The request body must be a `ReserveHistoryRequest` object. + :query timeout_ms=MILLISECONDS: *Optional.* If specified, the exchange will wait up to MILLISECONDS for incoming funds before returning a 404 if the reserve does not yet exist. **Response:** :http:statuscode:`200 OK`: - The exchange responds with a `ReserveStatus` object; the reserve was known to the exchange. - :http:statuscode:`403 Forbidden`: - The *TALER_SIGNATURE_RESERVE_HISTORY_REQUEST* is invalid. - This response comes with a standard `ErrorDetail` response. Alternatively, the provided timestamp is not close to the current time. + The exchange responds with a `ReserveSummary` object; the reserve was known to the exchange. :http:statuscode:`404 Not found`: The reserve key does not belong to a reserve known to the exchange. - :http:statuscode:`412 Precondition failed`: - The balance in the reserve is insufficient to pay for the history request. - This response comes with a standard `ErrorDetail` response. **Details:** - .. ts:def:: ReserveHistoryRequest + .. ts:def:: ReserveSummary - interface ReserveHistoryRequest { - // Signature of type - // ``TALER_SIGNATURE_RESERVE_HISTORY_REQUEST`` - // over a `TALER_ReserveHistoryRequestSignaturePS`. - reserve_sig: EddsaSignature; + interface ReserveSummary { + // Balance left in the reserve. + balance: Amount; - // Time when the client made the request. - // Timestamp must be reasonably close to the time of - // the exchange, otherwise the exchange may reject - // the request. - request_timestamp: Timestamp; + // If set, age restriction is required to be set for each coin to this + // value during the withdrawal from this reserve. The client then MUST + // use a denomination with support for age restriction enabled for the + // withdrawal. + // The value represents a valid age group from the list of permissible + // age groups as defined by the exchange's output to /keys. + maximum_age_group?: number; } +Withdraw +~~~~~~~~ + .. http:post:: /csr-withdraw Obtain exchange-side input values in preparation for a @@ -1662,7 +1685,7 @@ exchange. .. ts:def:: WithdrawPrepareResponse - type WithdrawPrepareResponse + type WithdrawPrepareResponse = | ExchangeWithdrawValue; .. ts:def:: ExchangeWithdrawValue @@ -1689,28 +1712,32 @@ exchange. r_pub_1: CsRPublic; } -.. http:post:: /reserves/$RESERVE_PUB/withdraw - Withdraw a coin of the specified denomination. Note that the client should - commit all of the request details, including the private key of the coin and - the blinding factor, to disk *before* issuing this request, so that it can +Batch Withdraw +~~~~~~~~~~~~~~ + +.. http:post:: /reserves/$RESERVE_PUB/batch-withdraw + + Withdraw multiple coins from the same reserve. Note that the client should + commit all of the request details, including the private key of the coins and + the blinding factors, to disk *before* issuing this request, so that it can recover the information if necessary in case of transient failures, like power outage, network outage, etc. - **Request:** The request body must be a `WithdrawRequest` object. + **Request:** The request body must be a `BatchWithdrawRequest` object. **Response:** :http:statuscode:`200 OK`: - The request was successful, and the response is a `WithdrawResponse`. Note that repeating exactly the same request - will again yield the same response, so if the network goes down during the - transaction or before the client can commit the coin signature to disk, the - coin is not lost. + The request was successful, and the response is a `BatchWithdrawResponse`. + Note that repeating exactly the same request will again yield the same + response, so if the network goes down during the transaction or before the + client can commit the coin signature to disk, the coin is not lost. :http:statuscode:`403 Forbidden`: - The signature is invalid. + A signature is invalid. This response comes with a standard `ErrorDetail` response. :http:statuscode:`404 Not found`: - The denomination key or the reserve are not known to the exchange. If the + A denomination key or the reserve are not known to the exchange. If the denomination key is unknown, this suggests a bug in the wallet as the wallet should have used current denomination keys from ``/keys``. In this case, the response will be a `DenominationUnknownMessage`. @@ -1720,14 +1747,19 @@ exchange. In this case, the wallet should repeat the exact same request later again using exactly the same blinded coin. :http:statuscode:`409 Conflict`: - The balance of the reserve is not sufficient to withdraw a coin of the indicated denomination. - The response is `WithdrawError` object. + One of the following reasons occured: + + 1. The balance of the reserve is not sufficient to withdraw the coins of the + indicated denominations. The response is `WithdrawError` object. + + 2. The reserve has a birthday set and requires a request to ``/age-withdraw`` instead. + The response comes with a standard `ErrorDetail` response with error-code ``TALER_EC_EXCHANGE_RESERVES_AGE_RESTRICTION_REQUIRED`` and an additional field ``maximum_allowed_age`` for the maximum age (in years) that the client can commit to in the call to ``/age-withdraw`` :http:statuscode:`410 Gone`: - The requested denomination key is not yet or no longer valid. - It either before the validity start, past the expiration or was revoked. The response is a - `DenominationExpiredMessage`. Clients must evaluate - the error code provided to understand which of the - cases this is and handle it accordingly. + A requested denomination key is not yet or no longer valid. + It either before the validity start, past the expiration or was revoked. + The response is a `DenominationExpiredMessage`. Clients must evaluate the + error code provided to understand which of the cases this is and handle it + accordingly. :http:statuscode:`451 Unavailable for Legal Reasons`: This reserve has received funds from a purse or the amount withdrawn exceeds another legal threshold and thus the reserve must @@ -1750,41 +1782,18 @@ exchange. **Details:** - .. ts:def:: DenominationExpiredMessage - - interface DenominationExpiredMessage { - - // Taler error code. Note that beyond - // expiration this message format is also - // used if the key is not yet valid, or - // has been revoked. - code: number; - - // Signature by the exchange over a - // `TALER_DenominationExpiredAffirmationPS`. - // Must have purpose ``TALER_SIGNATURE_EXCHANGE_AFFIRM_DENOM_EXPIRED``. - exchange_sig: EddsaSignature; - - // Public key of the exchange used to create - // the 'exchange_sig. - exchange_pub: EddsaPublicKey; - - // Hash of the denomination public key that is unknown. - h_denom_pub: HashCode; + .. ts:def:: BatchWithdrawRequest - // When was the signature created. - timestamp: Timestamp; + interface BatchWithdrawRequest { + // Array of requests for the individual coins to withdraw. + planchets: WithdrawRequest[]; - // What kind of operation was requested that now - // failed? - oper: string; } - .. ts:def:: WithdrawRequest interface WithdrawRequest { - // Hash of a denomination public key (RSA), specifying the type of coin the client + // Hash of a denomination public key, specifying the type of coin the client // would like the exchange to create. denom_pub_hash: HashCode; @@ -1799,6 +1808,16 @@ exchange. } + + .. ts:def:: BatchWithdrawResponse + + interface BatchWithdrawResponse { + // Array of blinded signatures, in the same order as was + // given in the request. + ev_sigs: WithdrawResponse[]; + + } + .. ts:def:: WithdrawResponse interface WithdrawResponse { @@ -1842,6 +1861,14 @@ exchange. interface KycNeededRedirect { + // Numeric `error code <error-codes>` unique to the condition. + // Should always be ``TALER_EC_EXCHANGE_GENERIC_KYC_REQUIRED``. + code: number; + + // Human-readable description of the error, i.e. "missing parameter", "commitment violation", ... + // Should give a human-readable hint about the error's nature. Optional, may change without notice! + hint?: string; + // Hash of the payto:// account URI that identifies // the account which is being KYCed. h_payto: PaytoHash; @@ -1870,49 +1897,86 @@ exchange. history: TransactionHistoryItem[] } + .. ts:def:: DenominationExpiredMessage + interface DenominationExpiredMessage { + // Taler error code. Note that beyond + // expiration this message format is also + // used if the key is not yet valid, or + // has been revoked. + code: number; -.. http:post:: /reserves/$RESERVE_PUB/batch-withdraw + // Signature by the exchange over a + // `TALER_DenominationExpiredAffirmationPS`. + // Must have purpose ``TALER_SIGNATURE_EXCHANGE_AFFIRM_DENOM_EXPIRED``. + exchange_sig: EddsaSignature; - Withdraw multiple coins from the same reserve. Note that the client should - commit all of the request details, including the private key of the coins and - the blinding factors, to disk *before* issuing this request, so that it can - recover the information if necessary in case of transient failures, like - power outage, network outage, etc. + // Public key of the exchange used to create + // the 'exchange_sig. + exchange_pub: EddsaPublicKey; - **Request:** The request body must be a `BatchWithdrawRequest` object. + // Hash of the denomination public key that is unknown. + h_denom_pub: HashCode; + + // When was the signature created. + timestamp: Timestamp; + + // What kind of operation was requested that now + // failed? + oper: string; + } + + + + + +Withdraw with Age Restriction +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If the reserve was marked with a maximum age group, the client has to perform a +cut&choose protocol with the exchange. It first calls +``/reserves/$RESERVE_PUB/age-withdraw`` and commits to ``n*kappa`` coins. On +success, the exchange answers this request with an noreveal-index. The client +then has to call ``/age-withdraw/$ACH/reveal`` to reveal all ``n*(kappa - 1)`` +coins along with their age commitments to proof that they were appropriate. +If so, the exchange will blindly sign ``n`` undisclosed coins from the request. + + +.. http:post:: /reserves/$RESERVE_PUB/age-withdraw + + Withdraw multiple coins *with age restriction* from the same reserve. + Note that the client should commit all of the request details, including the + private key of the coins and the blinding factors, to disk *before* issuing + this request, so that it can recover the information if necessary in case of + transient failures, like power outage, network outage, etc. + + **Request:** The request body must be a `AgeWithdrawRequest` object. **Response:** :http:statuscode:`200 OK`: - The request was successful, and the response is a `BatchWithdrawResponse`. - Note that repeating exactly the same request - will again yield the same response, so if the network goes down during the - transaction or before the client can commit the coin signature to disk, the - coin is not lost. + The request was successful, and the response is a `AgeWithdrawResponse`. + Note that repeating exactly the same request will again yield the same + response, so if the network goes down during the transaction or before the + client can commit the coin signature to disk, the coin is not lost. :http:statuscode:`403 Forbidden`: A signature is invalid. This response comes with a standard `ErrorDetail` response. - :http:statuscode:`404 Not found`: - A denomination key or the reserve are not known to the exchange. If the - denomination key is unknown, this suggests a bug in the wallet as the - wallet should have used current denomination keys from ``/keys``. - In this case, the response will be a `DenominationUnknownMessage`. - If the reserve is unknown, the wallet should not report a hard error yet, but - instead simply wait for up to a day, as the wire transaction might simply - not yet have completed and might be known to the exchange in the near future. - In this case, the wallet should repeat the exact same request later again - using exactly the same blinded coin. :http:statuscode:`409 Conflict`: - The balance of the reserve is not sufficient to withdraw the coins of the indicated denominations. - The response is `WithdrawError` object. + One of two reasons occured: + + 1. The balance of the reserve is not sufficient to withdraw the coins of the + given amount. The response is a `WithdrawError` object. + + 2. The provided value for ``max_age`` is higher than the allowed value according to the reserve's birthday. + The response comes with a standard `ErrorDetail` response with error-code ``TALER_EC_EXCHANGE_AGE_WITHDRAW_MAXIMUM_AGE_TOO_LARGE`` and an additional field ``maximum_allowed_age`` for the maximum age (in years) that the client can commit to in a call to ``/age-withdraw`` :http:statuscode:`410 Gone`: A requested denomination key is not yet or no longer valid. - It either before the validity start, past the expiration or was revoked. The response is a - `DenominationExpiredMessage`. Clients must evaluate - the error code provided to understand which of the - cases this is and handle it accordingly. + It either before the validity start, past the expiration or was revoked. + The response is a `DenominationExpiredMessage`. Clients must evaluate the + error code provided to understand which of the cases this is and handle it + accordingly. :http:statuscode:`451 Unavailable for Legal Reasons`: This reserve has received funds from a purse or the amount withdrawn exceeds another legal threshold and thus the reserve must @@ -1924,271 +1988,551 @@ exchange. Afterwards, the request should be repeated. The response will be an `KycNeededRedirect` object. - Implementation note: internally, we need to - distinguish between upgrading the reserve to an - account (due to P2P payment) and identifying the - owner of the origin bank account (due to exceeding - the withdraw amount threshold), as we need to create - a different payto://-URI for the KYC check depending - on the case. + .. ts:def:: AgeWithdrawRequest + + interface AgeWithdrawRequest { + // Array of ``n`` hash codes of denomination public keys to order. + // These denominations MUST support age restriction as defined in the + // output to /keys. + // The sum of all denomination's values and fees MUST be at most the + // balance of the reserve. The balance of the reserve will be + // immediatley reduced by that amount. + denoms_h: HashCode[]; + + // ``n`` arrays of ``kappa`` entries with blinded coin envelopes. Each + // (toplevel) entry represents ``kappa`` canditates for a particular + // coin. The exchange will respond with an index ``gamma``, which is + // the index that shall remain undisclosed during the reveal phase. + // The SHA512 hash $ACH over the blinded coin envelopes is the commitment + // that is later used as the key to the reveal-URL. + blinded_coins_evs: CoinEnvelope[][]; + + // The maximum age to commit to. MUST be the same as the maximum + // age in the reserve. + max_age: number; + + // Signature of `TALER_AgeWithdrawRequestPS` created with + // the `reserves's private key <reserve-priv>` + // using purpose ``TALER_SIGNATURE_WALLET_RESERVE_AGE_WITHDRAW``. + reserve_sig: EddsaSignature; + } + .. ts:def:: AgeWithdrawResponse - **Details:** + interface AgeWithdrawResponse { + // index of the commitments that the client doesn't + // have to disclose + noreveal_index: Integer; - .. ts:def:: BatchWithdrawRequest + // Signature of `TALER_AgeWithdrawConfirmationPS` whereby + // the exchange confirms the ``noreveal_index``. + exchange_sig: EddsaSignature; + + // `Public EdDSA key <sign-key-pub>` of the exchange that was used to + // generate the signature. Should match one of the exchange's signing + // keys from ``/keys``. Again given explicitly as the client might + // otherwise be confused by clock skew as to which signing key was used. + exchange_pub: EddsaPublicKey; + } + + + +.. http:post:: /age-withdraw/$ACH/reveal + + The client has previously committed to multiple coins with age restriction + in a call to ``/reserve/$RESERVE_PUB/age-withdraw`` and got a + `AgeWithdrawResponse` from the exchange. By calling this + endpoint, the client has to reveal each coin and their ``kappa - 1`` + age commitments, except for the age commitments with index + ``noreveal_index``. The hash of all commitments from the former withdraw + request is given as the ``$ACH`` value in the URL to this endpoint. + + + **Request:** The request body must be a `AgeWithdrawRevealRequest` object. + + **Response:** + + :http:statuscode:`200 OK`: + The request was successful, and the response is a `AgeWithdrawRevealResponse`. + Note that repeating exactly the same request will again yield the same + response, so if the network goes down during the transaction or before the + client can commit the coin signature to disk, the coin is not lost. + :http:statuscode:`404 Not found`: + The provided commitment $ACH is unknown. + :http:statuscode:`409 Conflict`: + The reveal operation failed and the response is an `WithdrawError` object. + The error codes indicate one of two cases: + + 1. An age commitment for at least one of the coins did not fulfill the + required maximum age requirement of the corresponding reserve. + Error code: + ``TALER_EC_EXCHANGE_GENERIC_COIN_AGE_REQUIREMENT_FAILURE``. + 2. The computation of the hash of the commitment with provided input does + result in the value $ACH. + Error code: + ``TALER_EC_EXCHANGE_AGE_WITHDRAW_REVEAL_INVALID_HASH`` - interface BatchWithdrawRequest { - // Array of requests for the individual coins to withdraw. - planchets: WithdrawRequest[]; + .. ts:def:: AgeWithdrawRevealRequest + + interface AgeWithdrawRevealRequest { + // Array of ``n`` of ``(kappa - 1)`` disclosed coin master secrets, from + // which the coins' private key, blinding, nonce (for Clause-Schnorr) and + // age-restriction is calculated. + // + // Given each coin's private key and age commitment, the exchange will + // calculate each coin's blinded hash value und use all those (disclosed) + // blinded hashes together with the non-disclosed envelopes ``coin_evs`` + // during the verification of the original age-withdraw-commitment. + disclosed_coin_secrets: AgeRestrictedCoinSecret[][]; } - .. ts:def:: BatchWithdrawResponse + .. ts:def:: AgeRestrictedCoinSecret - interface BatchWithdrawResponse { - // Array of blinded signatures, in the same order as was - // given in the request. - ev_sigs: WithdrawResponse[]; + // The Master key material from which the coins' private key ``coin_priv``, + // blinding ``beta`` and nonce ``nonce`` (for Clause-Schnorr) itself are + // derived as usually in wallet-core. Given a coin's master key material, + // the age commitment for the coin MUST be derived from this private key as + // follows: + // + // Let m ∈ {1,...,M} be the maximum age group as defined in the reserve + // that the wallet can commit to. + // + // For age group $AG ∈ {1,...m}, set + // seed = HDKF(coin_secret, "age-commitment", $AG) + // p[$AG] = Edx25519_generate_private(seed) + // and calculate the corresponding Edx25519PublicKey as + // q[$AG] = Edx25519_public_from_private(p[$AG]) + // + // For age groups $AG ∈ {m,...,M}, set + // f[$AG] = HDKF(coin_secret, "age-factor", $AG) + // and calculate the corresponding Edx25519PublicKey as + // q[$AG] = Edx25519_derive_public(`PublishedAgeRestrictionBaseKey`, f[$AG]) + // + type AgeRestrictedCoinSecret = string; + + .. ts:def:: PublishedAgeRestrictionBaseKey + + // The value for ``PublishedAgeRestrictionBaseKey`` is a randomly chosen + // `Edx25519PublicKey` for which the private key is not known to the clients. It is + // used during the age-withdraw protocol so that clients can proof that they + // derived all public keys to age groups higher than their allowed maximum + // from this particular value. + const PublishedAgeRestrictionBaseKey = + new Edx25519PublicKey("CH0VKFDZ2GWRWHQBBGEK9MWV5YDQVJ0RXEE0KYT3NMB69F0R96TG"); + .. ts:def:: AgeWithdrawRevealResponse + + interface AgeWithdrawRevealResponse { + // List of the exchange's blinded RSA signatures on the new coins. + ev_sigs : BlindedDenominationSignature[]; } -.. _delete-reserve: +.. _reserve-history: -.. http:DELETE:: /reserves/$RESERVE_PUB +--------------- +Reserve History +--------------- - Forcefully closes a reserve. - The request header must contain an *Account-Request-Signature*. - Note: this endpoint is not currently implemented! +.. http:get:: /reserves/$RESERVE_PUB/history + + Request information about the full history of + a reserve or an account. **Request:** - *Account-Request-Signature*: The client must provide Base-32 encoded EdDSA signature made with ``$ACCOUNT_PRIV``, affirming its authorization to delete the account. The purpose used MUST be ``TALER_SIGNATURE_RESERVE_CLOSE``. + The GET request should come with the following HTTP headers: - :query force=BOOLEAN: *Optional.* If set to 'true' specified, the exchange - will delete the account even if there is a balance remaining. + *If-None-Match*: The client MAY provide an ``If-None-Match`` header with an + Etag. In that case, the server MUST additionally respond with an ``304`` + status code in case the reserve history matches the provided Etag. + + *Taler-Reserve-History-Signature*: The client MUST provide Base-32 encoded + EdDSA signature over a TALER_SIGNATURE_RESERVE_HISTORY_REQUEST made with + the respective ``$RESERVE_PRIV``, affirming desire to download the current + reserve transaction history. + + :query start=OFFSET: *Optional.* Only return reserve history entries with + offsets above the given OFFSET. Allows clients to not + retrieve history entries they already have. **Response:** :http:statuscode:`200 OK`: - The operation succeeded, the exchange provides details - about the account deletion. - The response will include a `ReserveClosedResponse` object. + The exchange responds with a `ReserveHistory` object; the reserve was known to the exchange. + :http:statuscode:`204 No content`: + The reserve history is known, but at this point from the given starting point it is empty. Can only happen if OFFSET was positive. + :http:statuscode:`304 Not modified`: + The reserve history matches the one identified by the "If-none-match" HTTP header of the request. :http:statuscode:`403 Forbidden`: - The *Account-Request-Signature* is invalid. + The *TALER_SIGNATURE_RESERVE_HISTORY_REQUEST* is invalid. This response comes with a standard `ErrorDetail` response. :http:statuscode:`404 Not found`: - The account is unknown to the exchange. - :http:statuscode:`409 Conflict`: - The account is still has digital cash in it, the associated - wire method is ``void`` and the *force* option was not provided. - This response comes with a standard `ErrorDetail` response. + The reserve key does not belong to a reserve known to the exchange. **Details:** - .. ts:def:: ReserveClosedResponse + .. ts:def:: ReserveHistory - interface ReserveClosedResponse { + interface ReserveHistory { + // Balance left in the reserve. + balance: Amount; - // Final balance of the account. - closing_amount: Amount; + // If set, gives the maximum age group that the client is required to set + // during withdrawal. + maximum_age_group: number; - // Current time of the exchange, used as part of - // what the exchange signs over. - close_time: Timestamp; + // Transaction history for this reserve. + // May be partial (!). + history: TransactionHistoryItem[]; + } - // Hash of the wire account into which the remaining - // balance will be transferred. Note: may be the - // hash over ``payto://void/`, in which case the - // balance is forfeit to the profit of the exchange. + Objects in the transaction history have the following format: + + .. ts:def:: TransactionHistoryItem + + // Union discriminated by the "type" field. + type TransactionHistoryItem = + | AccountSetupTransaction + | ReserveWithdrawTransaction + | ReserveAgeWithdrawTransaction + | ReserveCreditTransaction + | ReserveClosingTransaction + | ReserveOpenRequestTransaction + | ReserveCloseRequestTransaction + | PurseMergeTransaction; + + .. ts:def:: AccountSetupTransaction + + interface AccountSetupTransaction { + type: "SETUP"; + + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; + + // KYC fee agreed to by the reserve owner. + kyc_fee: Amount; + + // Time when the KYC was triggered. + kyc_timestamp: Timestamp; + + // Hash of the wire details of the account. + // Note that this hash is unsalted and potentially + // private (as it could be inverted), hence access + // to this endpoint must be authorized using the + // private key of the reserve. h_wire: HashCode; - // This is a signature over a - // struct ``TALER_AccountDeleteConfirmationPS`` with purpose - // ``TALER_SIGNATURE_EXCHANGE_RESERVE_CLOSED``. - exchange_sig: EddsaSignature; + // Signature created with the reserve's private key. + // Must be of purpose ``TALER_SIGNATURE_ACCOUNT_SETUP_REQUEST`` over + // a ``TALER_AccountSetupRequestSignaturePS``. + reserve_sig: EddsaSignature; } + .. ts:def:: ReserveWithdrawTransaction + interface ReserveWithdrawTransaction { + type: "WITHDRAW"; -.. _deposit-par: + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; -------- -Deposit -------- + // Amount withdrawn. + amount: Amount; -Deposit operations are requested by a merchant during a transaction. For the -deposit operation, the merchant has to obtain the deposit permission for a coin -from their customer who owns the coin. When depositing a coin, the merchant is -credited an amount specified in the deposit permission, possibly a fraction of -the total coin's value, minus the deposit fee as specified by the coin's -denomination. + // Hash of the denomination public key of the coin. + h_denom_pub: HashCode; -.. _deposit: + // Hash of the blinded coin to be signed. + h_coin_envelope: HashCode; -.. http:POST:: /coins/$COIN_PUB/deposit + // Signature over a `TALER_WithdrawRequestPS` + // with purpose ``TALER_SIGNATURE_WALLET_RESERVE_WITHDRAW`` + // created with the reserve's private key. + reserve_sig: EddsaSignature; - Deposit the given coin and ask the exchange to transfer the given :ref:`amount` - to the merchant's bank account. This API is used by the merchant to redeem - the digital coins. + // Fee that is charged for withdraw. + withdraw_fee: Amount; + } - The base URL for ``/coins/``-requests may differ from the main base URL of the - exchange. The exchange MUST return a 307 or 308 redirection to the correct - base URL if this is the case. + .. ts:def:: ReserveAgeWithdrawTransaction - **Request:** + interface ReserveAgeWithdrawTransaction { + type: "AGEWITHDRAW"; - The request body must be a `DepositRequest` object. + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; - **Response:** + // Total Amount withdrawn. + amount: Amount; - :http:statuscode:`200 OK`: - The operation succeeded, the exchange confirms that no double-spending took - place. The response will include a `DepositSuccess` object. - :http:statuscode:`403 Forbidden`: - One of the signatures is invalid. - This response comes with a standard `ErrorDetail` response. - :http:statuscode:`404 Not found`: - Either the denomination key is not recognized (expired or invalid), - or the wire type is not recognized. - If the denomination key is unknown, the response will be - a `DenominationUnknownMessage`. - :http:statuscode:`409 Conflict`: - The deposit operation has either failed because the coin has insufficient - residual value, or because the same public key of the coin has been - previously used with a different denomination. Which case it is - can be decided by looking at the error code - (``TALER_EC_EXCHANGE_GENERIC_INSUFFICIENT_FUNDS`` or - ``TALER_EC_EXCHANGE_GENERIC_COIN_CONFLICTING_DENOMINATION_KEY``). - The fields of the response are the same in both cases. - The request should not be repeated again with this coin. - In this case, the response is a `DepositDoubleSpendError`. - :http:statuscode:`410 Gone`: - The requested denomination key is not yet or no longer valid. - It either before the validity start, past the expiration or was revoked. The response is a - `DenominationExpiredMessage`. Clients must evaluate - the error code provided to understand which of the - cases this is and handle it accordingly. + // Commitment of all ``n*kappa`` blinded coins. + h_commitment: HashCode; - **Details:** + // Signature over a `TALER_AgeWithdrawRequestPS` + // with purpose ``TALER_SIGNATURE_WALLET_RESERVE_AGE_WITHDRAW`` + // created with the reserve's private key. + reserve_sig: EddsaSignature; - .. ts:def:: DepositRequest + // Fee that is charged for withdraw. + withdraw_fee: Amount; + } - interface DepositRequest { - // Amount to be deposited, can be a fraction of the - // coin's total value. - contribution: Amount; - // The merchant's account details. - merchant_payto_uri: string; + .. ts:def:: ReserveCreditTransaction - // The salt is used to hide the ``payto_uri`` from customers - // when computing the ``h_wire`` of the merchant. - wire_salt: WireSalt; + interface ReserveCreditTransaction { + type: "CREDIT"; - // SHA-512 hash of the contract of the merchant with the customer. Further - // details are never disclosed to the exchange. - h_contract_terms: HashCode; + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; - // Hash of denomination RSA key with which the coin is signed. - denom_pub_hash: HashCode; + // Amount deposited. + amount: Amount; - // Exchange's unblinded RSA signature of the coin. - ub_sig: DenominationSignature; + // Sender account ``payto://`` URL. + sender_account_url: string; - // Timestamp when the contract was finalized. + // Opaque identifier internal to the exchange that + // uniquely identifies the wire transfer that credited the reserve. + wire_reference: Integer; + + // Timestamp of the incoming wire transfer. timestamp: Timestamp; + } - // Indicative time by which the exchange undertakes to transfer the funds to - // the merchant, in case of successful payment. A wire transfer deadline of 'never' - // is not allowed. - wire_transfer_deadline: Timestamp; - // EdDSA `public key of the merchant <merchant-pub>`, so that the client can identify the - // merchant for refund requests. - merchant_pub: EddsaPublicKey; + .. ts:def:: ReserveClosingTransaction - // Date until which the merchant can issue a refund to the customer via the - // exchange, to be omitted if refunds are not allowed. - refund_deadline?: Timestamp; + interface ReserveClosingTransaction { + type: "CLOSING"; - // Signature over `TALER_DepositRequestPS`, made by the customer with the - // `coin's private key <coin-priv>`. - coin_sig: EddsaSignature; + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; + + // Closing balance. + amount: Amount; + + // Closing fee charged by the exchange. + closing_fee: Amount; + + // Wire transfer subject. + wtid: Base32; + + // ``payto://`` URI of the wire account into which the funds were returned to. + receiver_account_details: string; + + // This is a signature over a + // struct `TALER_ReserveCloseConfirmationPS` with purpose + // ``TALER_SIGNATURE_EXCHANGE_RESERVE_CLOSED``. + exchange_sig: EddsaSignature; + + // Public key used to create 'exchange_sig'. + exchange_pub: EddsaPublicKey; + + // Time when the reserve was closed. + timestamp: Timestamp; } - .. ts:def:: DenominationSignature - type DenominationSignature = - | RsaDenominationSignature - | CSDenominationSignature; + .. ts:def:: ReserveOpenRequestTransaction - .. ts:def:: RsaDenominationSignature + interface ReserveOpenRequestTransaction { + type: "OPEN"; - interface RsaDenominationSignature { - cipher: "RSA"; + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; + + // Open fee paid from the reserve. + open_fee: Amount; + + // This is a signature over + // a struct `TALER_ReserveOpenPS` with purpose + // ``TALER_SIGNATURE_WALLET_RESERVE_OPEN``. + reserve_sig: EddsaSignature; + + // Timestamp of the open request. + request_timestamp: Timestamp; + + // Requested expiration. + requested_expiration: Timestamp; + + // Requested number of free open purses. + requested_min_purses: Integer; - // RSA signature - rsa_signature: RsaSignature; } - .. ts:def:: CSDenominationSignature + .. ts:def:: ReserveCloseRequestTransaction - interface CSDenominationSignature { - type: "CS"; + interface ReserveCloseRequestTransaction { + type: "CLOSE"; - // R value component of the signature. - cs_signature_r: Cs25519Point; + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; - // s value component of the signature. - cs_signature_s: Cs25519Scalar: + // This is a signature over + // a struct `TALER_ReserveClosePS` with purpose + // ``TALER_SIGNATURE_WALLET_RESERVE_CLOSE``. + reserve_sig: EddsaSignature; + // Target account ``payto://``, optional. + h_payto?: PaytoHash; + + // Timestamp of the close request. + request_timestamp: Timestamp; } + .. ts:def:: ReserveCreditTransaction - The deposit operation succeeds if the coin is valid for making a deposit and - has enough residual value that has not already been deposited or melted. + interface ReserveCreditTransaction { + type: "CREDIT"; - .. ts:def:: DepositSuccess + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; - interface DepositSuccess { - // Optional base URL of the exchange for looking up wire transfers - // associated with this transaction. If not given, - // the base URL is the same as the one used for this request. - // Can be used if the base URL for ``/transactions/`` differs from that - // for ``/coins/``, i.e. for load balancing. Clients SHOULD - // respect the ``transaction_base_url`` if provided. Any HTTP server - // belonging to an exchange MUST generate a 307 or 308 redirection - // to the correct base URL should a client uses the wrong base - // URL, or if the base URL has changed since the deposit. - transaction_base_url?: string; + // Amount deposited. + amount: Amount; - // Timestamp when the deposit was received by the exchange. - exchange_timestamp: Timestamp; + // Sender account ``payto://`` URL. + sender_account_url: string; - // The EdDSA signature of `TALER_DepositConfirmationPS` using a current - // `signing key of the exchange <sign-key-priv>` affirming the successful - // deposit and that the exchange will transfer the funds after the refund - // deadline, or as soon as possible if the refund deadline is zero. - exchange_sig: EddsaSignature; + // Opaque identifier internal to the exchange that + // uniquely identifies the wire transfer that credited the reserve. + wire_reference: Integer; - // `Public EdDSA key of the exchange <sign-key-pub>` that was used to - // generate the signature. - // Should match one of the exchange's signing keys from ``/keys``. It is given - // explicitly as the client might otherwise be confused by clock skew as to - // which signing key was used. - exchange_pub: EddsaPublicKey; + // Timestamp of the incoming wire transfer. + timestamp: Timestamp; } - .. ts:def:: DepositDoubleSpendError + .. ts:def:: PurseMergeTransaction - interface DepositDoubleSpendError { - // The string constant "insufficient funds". - hint: string; + interface PurseMergeTransaction { + type: "MERGE"; - // Transaction history for the coin that is - // being double-spended. + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; + + // SHA-512 hash of the contact of the purse. + h_contract_terms: HashCode; + + // EdDSA public key used to approve merges of this purse. + merge_pub: EddsaPublicKey; + + // Minimum age required for all coins deposited into the purse. + min_age: Integer; + + // Number that identifies who created the purse + // and how it was paid for. + flags: Integer; + + // Purse public key. + purse_pub: EddsaPublicKey; + + // EdDSA signature of the account/reserve affirming the merge + // over a `TALER_AccountMergeSignaturePS`. + // Must be of purpose ``TALER_SIGNATURE_ACCOUNT_MERGE`` + reserve_sig: EddsaSignature; + + // Client-side timestamp of when the merge request was made. + merge_timestamp: Timestamp; + + // Indicative time by which the purse should expire + // if it has not been merged into an account. At this + // point, all of the deposits made should be + // auto-refunded. + purse_expiration: Timestamp; + + // Purse fee the reserve owner paid for the purse creation. + purse_fee: Amount; + + // Total amount merged into the reserve. + // (excludes fees). + amount: Amount; + + // True if the purse was actually merged. + // If false, only the purse_fee has an impact + // on the reserve balance! + merged: boolean; + } + + +.. _coin-history: + +------------ +Coin History +------------ + +.. http:get:: /coins/$COIN_PUB/history + + Obtain the transaction history of a coin. Used only in special cases, like + when the exchange claims a double-spending error and the wallet does not + believe it. Usually, the wallet knows the transaction history of each coin + and thus has no need to inquire. + + **Request:** + + The GET request should come with the following HTTP headers: + + *If-None-Match*: The client MAY provide an ``If-None-Match`` header with an + Etag. In that case, the server MUST additionally respond with an ``304`` + status code in case the coin history matches the provided Etag. + + *Taler-Coin-History-Signature*: The client MUST provide Base-32 encoded + EdDSA signature over a TALER_SIGNATURE_COIN_HISTORY_REQUEST made with + the respective ``$RESERVE_PRIV``, affirming desire to download the current + coin transaction history. + + :query start=OFFSET: *Optional.* Only return coin history entries with + offsets above the given OFFSET. Allows clients to not + retrieve history entries they already have. + + + **Response:** + + :http:statuscode:`200 OK`: + The operation succeeded, the exchange confirms that no double-spending took + place. The response will include a `CoinHistoryResponse` object. + :http:statuscode:`204 No content`: + The reserve history is known, but at this point from the given starting point it is empty. Can only happen if OFFSET was positive. + :http:statuscode:`304 Not modified`: + The coin history has not changed since the previous query (detected via Etag + in "If-none-match" header). + :http:statuscode:`403 Forbidden`: + The *TALER_SIGNATURE_COIN_HISTORY_REQUEST* is invalid. + This response comes with a standard `ErrorDetail` response. + :http:statuscode:`404 Not found`: + The coin public key is not (yet) known to the exchange. + + .. ts:def:: CoinHistoryResponse + + interface CoinHistoryResponse { + // Current balance of the coin. + balance: Amount; + + // Hash of the coin's denomination. + h_denom_pub: HashCode; + + // Transaction history for the coin. history: CoinSpendHistoryItem[]; } @@ -2203,14 +2547,19 @@ denomination. | CoinOldCoinRecoupTransaction | CoinRecoupRefreshTransaction | CoinPurseDepositTransaction - | CoinPurseRefundTransaction; - + | CoinPurseRefundTransaction + | CoinReserveOpenDepositTransaction; .. ts:def:: CoinDepositTransaction interface CoinDepositTransaction { type: "DEPOSIT"; + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; + // The total amount of the coin's value absorbed (or restored in the // case of a refund) by this transaction. // The amount given includes @@ -2254,6 +2603,11 @@ denomination. interface CoinMeltTransaction { type: "MELT"; + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; + // The total amount of the coin's value absorbed by this transaction. // Note that for melt this means the amount given includes // the melt fee. The current coin value can thus be computed by @@ -2283,6 +2637,11 @@ denomination. interface CoinRefundTransaction { type: "REFUND"; + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; + // The total amount of the coin's value restored // by this transaction. // The amount given excludes the transaction fee. @@ -2313,6 +2672,11 @@ denomination. interface CoinRecoupTransaction { type: "RECOUP"; + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; + // The total amount of the coin's value absorbed // by this transaction. // The current coin value can thus be computed by @@ -2354,6 +2718,11 @@ denomination. interface CoinOldCoinRecoupTransaction { type: "OLD-COIN-RECOUP"; + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; + // The total amount of the coin's value restored // by this transaction. // The current coin value can thus be computed by @@ -2378,6 +2747,11 @@ denomination. interface CoinRecoupRefreshTransaction { type: "RECOUP-REFRESH"; + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; + // The total amount of the coin's value absorbed // by this transaction. // The current coin value can thus be computed by @@ -2418,7 +2792,12 @@ denomination. .. ts:def:: CoinPurseDepositTransaction interface CoinPurseDepositTransaction { - type: "PURSE_DEPOSIT"; + type: "PURSE-DEPOSIT"; + + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; // The total amount of the coin's value absorbed // by this transaction. @@ -2452,7 +2831,12 @@ denomination. .. ts:def:: CoinPurseRefundTransaction interface CoinPurseRefundTransaction { - type: "PURSE_REFUND"; + type: "PURSE-REFUND"; + + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; // The total amount of the coin's value restored // by this transaction. @@ -2465,11 +2849,6 @@ denomination. // fee will be waived. refund_fee: Amount; - // Share of the purse fee charged to this coin. - // The sum of all purse fee shares will match the - // total purse fee. - purse_fee_share: Amount; - // Public key of the purse that expired. purse_pub: EddsaPublicKey; @@ -2478,13 +2857,62 @@ denomination. // of purpose ``TALER_SIGNATURE_EXCHANGE_CONFIRM_PURSE_REFUND``. exchange_sig: EddsaSignature; - // Public key used to sign 'exchange_sig'. + // Public key used to sign 'exchange_sig'. exchange_pub: EddsaPublicKey; } + .. ts:def:: CoinReserveOpenDepositTransaction + + interface CoinReserveOpenDepositTransaction { + type: "RESERVE-OPEN-DEPOSIT"; + + // Offset of this entry in the reserve history. + // Useful to request incremental histories via + // the "start" query parameter. + history_offset: Integer; + + // The total amount of the coin's value absorbed + // by this transaction. + // Note that this means the amount given includes + // the deposit fee. + coin_contribution: Amount; + + // Signature of the reserve open operation being paid for. + reserve_sig: EddsaSignature; + + // Signature by the coin over a + // `TALER_ReserveOpenDepositSignaturePS` of + // purpose ``TALER_SIGNATURE_RESERVE_OPEN_DEPOSIT``. + coin_sig: EddsaSignature; + + } + + +.. _deposit-par: + +------- +Deposit +------- -.. http:POST:: /batch-deposit +Deposit operations are requested f.e. by a merchant during a transaction or a +bidder during an auction. + +For the deposit operation during purchase, the merchant has to obtain the +deposit permission for a coin from their customer who owns the coin. When +depositing a coin, the merchant is credited an amount specified in the deposit +permission, possibly a fraction of the total coin's value, minus the deposit +fee as specified by the coin's denomination. + +For auctions, a bidder performs an deposit operation and provides all relevant +information for the auction policy (such as timeout and public key as bidder) +and can use the ``exchange_sig`` field from the `DepositSuccess` message as a +proof to the seller for the escrow of sufficient fund. + + +.. _deposit: + +.. http:post:: /batch-deposit Deposit multiple coins and ask the exchange to transfer the given :ref:`amount` into the merchant's bank account. This API is used by the merchant to redeem @@ -2498,7 +2926,7 @@ denomination. :http:statuscode:`200 OK`: The operation succeeded, the exchange confirms that no double-spending took - place. The response will include a `BatchDepositSuccess` object. + place. The response will include a `DepositSuccess` object. :http:statuscode:`403 Forbidden`: One of the signatures is invalid. This response comes with a standard `ErrorDetail` response. @@ -2510,15 +2938,17 @@ denomination. :http:statuscode:`409 Conflict`: The deposit operation has either failed because a coin has insufficient residual value, or because the same public key of a coin has been - previously used with a different denomination. Which case it is - can be decided by looking at the error code - (``TALER_EC_EXCHANGE_GENERIC_INSUFFICIENT_FUNDS`` or - ``TALER_EC_EXCHANGE_GENERIC_COIN_CONFLICTING_DENOMINATION_KEY``). - The fields of the response are the same in both cases. - The request should not be repeated again with this coin. - In this case, the response is a `DepositDoubleSpendError` with - an additional ``coin_pub`` field specifying the public key of the - coin that was double-spent. + previously used with a different denomination. + Which case it is can be decided by looking at the error code: + + 1. ``TALER_EC_EXCHANGE_DEPOSIT_CONFLICTING_CONTRACT`` (same coin used in different ways), + 2. ``TALER_EC_EXCHANGE_GENERIC_INSUFFICIENT_FUNDS`` (balance insufficient), + 3. ``TALER_EC_EXCHANGE_GENERIC_COIN_CONFLICTING_DENOMINATION_KEY`` (same coin public key, but different denomination). + 4. ``TALER_EC_EXCHANGE_GENERIC_COIN_CONFLICTING_AGE_HASH`` (same coin public key, but different age commitment). + + The request should not be repeated again with this coin. Instead, the client + can get from the exchange via the ``/coin/$COIN_PUB/history`` endpoint the record + of the transactions known for this coin's public key. :http:statuscode:`410 Gone`: The requested denomination key is not yet or no longer valid. It either before the validity start, past the expiration or was revoked. The response is a @@ -2530,7 +2960,7 @@ denomination. .. ts:def:: BatchDepositRequest - interface DepositRequest { + interface BatchDepositRequest { // The merchant's account details. merchant_payto_uri: string; @@ -2543,6 +2973,9 @@ denomination. // details are never disclosed to the exchange. h_contract_terms: HashCode; + // The list of coins that are going to be deposited with this Request. + coins: BatchDepositRequestCoin[]; + // Timestamp when the contract was finalized. timestamp: Timestamp; @@ -2557,12 +2990,20 @@ denomination. // Date until which the merchant can issue a refund to the customer via the // exchange, to be omitted if refunds are not allowed. + // + // THIS FIELD WILL BE DEPRICATED, once the refund mechanism becomes a + // policy via extension. refund_deadline?: Timestamp; + + // CAVEAT: THIS IS WORK IN PROGRESS + // (Optional) policy for the batch-deposit. + // This might be a refund, auction or escrow policy. + policy?: DepositPolicy; } - .. ts:def:: DepositRequest + .. ts:def:: BatchDepositRequestCoin - interface DepositRequest { + interface BatchDepositRequestCoin { // EdDSA public key of the coin being deposited. coin_pub: EddsaPublicKey; @@ -2581,12 +3022,176 @@ denomination. coin_sig: EddsaSignature; } + .. ts:def:: DenominationSignature + + type DenominationSignature = + | RsaDenominationSignature + | CSDenominationSignature; + + .. ts:def:: RsaDenominationSignature + + interface RsaDenominationSignature { + cipher: "RSA"; + + // RSA signature + rsa_signature: RsaSignature; + } + + .. ts:def:: CSDenominationSignature + + interface CSDenominationSignature { + type: "CS"; + + // R value component of the signature. + cs_signature_r: Cs25519Point; + + // s value component of the signature. + cs_signature_s: Cs25519Scalar: + + } + + .. ts:def:: DepositPolicy + + type DepositPolicy = + | PolicyMerchantRefund + | PolicyBrandtVickreyAuction + | PolicyEscrowedPayment; + + .. ts:def:: PolicyMerchantRefund + + // CAVEAT: THIS IS STILL WORK IN PROGRESS. + // This policy is optional and might not be supported by the exchange. + // If it does, the exchange MUST show support for this policy in the + // ``extensions`` field in the response to ``/keys``. + interface PolicyMerchantRefund { + type: "merchant_refund"; + + // EdDSA `public key of the merchant <merchant-pub>`, so that the client + // can identify the merchant for refund requests. + merchant_pub: EddsaPublicKey; + + // Date until which the merchant can issue a refund to the customer via + // the ``/extensions/policy_refund``-endpoint of the exchange. + deadline: Timestamp; + } + + .. ts:def:: PolicyBrandtVickreyAuction + + // CAVEAT: THIS IS STILL WORK IN PROGRESS. + // This policy is optional and might not be supported by the exchange. + // If it does, the exchange MUST show support for this policy in the + // ``extensions`` field in the response to ``/keys``. + interface PolicyBrandtVickreyAuction { + type: "brandt_vickrey_auction"; + + // Public key of this bidder. + // + // The bidder uses this key to sign the auction information and + // the messages it sends to the seller during the auction. + bidder_pub: EddsaPublicKey; + + // Hash of the auction terms + // + // The hash should be taken over a normalized JSON object of type + // `BrandtVickreyAuction`. + h_auction: HashCode; + + // The amount that this bidder commits to for this auction + // + // This amount can be larger than the contribution of a single coin. + // The bidder can increase funding of this auction policy by using + // sufficiently many coins during the deposit operation (single or batch) + // with the same policy. + commitment: Amount; + + // Date until the auction must have been successfully executed and + // a valid transcript provided to the + // ``/extensions/policy_brandt_vickrey_auction``-endpoint of the + // exchange. + // + // [If the auction has not been executed by then] OR [has been executed + // before then, but this bidder did not win], the coin's value doesn't + // change and the owner can refresh the coin. + // + // If this bidder won the auction, the winning price/amount from the + // outcome will be substracted from the coin and transfered to the + // merchant's ``payout_uri`` from the deposit request (minus a potential + // auction fee). For any remaining value, the bidder can refresh the + // coin to retrieve change. + deadline: Timestamp; + } + + .. ts:def:: BrandtVickreyAuction + + // CAVEAT: THIS IS STILL WORK IN PROGRESS. + // This structure defines an auction of Brandt-Vickory kind. + // It is used for the `PolicyBrandtVickreyAuction`. + interface BrandtVickreyAuction { + // Start date of the auction + time_start: Timestamp; + + // Maximum duration per round. There are four rounds in an auction of + // Brandt-Vickrey kind. + time_round: RelativeTime; + + // This integer m refers to the (m+1)-type of the Brandt-Vickrey-auction. + // - Type 0 refers to an auction with one highest-price winner, + // - Type 1 refers to an auction with one winner, paying the second + // highest price, + // - Type 2 refers to an auction with two winners, paying + // the third-highest price, + // - etc. + auction_type: number; + + // The vector of prices for the Brandt-Vickrey auction. The values MUST + // be in strictly increasing order. + prices: Amount[]; + + // The type of outcome of the auction. + // In case the auction is declared public, each bidder can calculate the + // winning price. This field is not relevant for the replay of a + // transcript, as the transcript must be provided by the seller who sees + // the winner(s) and winning price of the auction. + outcome_public: boolean; + + // The public key of the seller. + pubkey: EddsaPublicKey; + + // The seller's account details. + payto_uri: string; + } + + + .. ts:def:: PolicyEscrowedPayment + + // CAVEAT: THIS IS STILL WORK IN PROGRESS + // This policy is optional and might not be supported by the exchange. + // If it does, the exchange MUST show support for this policy in the + // ``extensions`` field in the response to ``/keys``. + interface PolicyEscrowedPayment { + type: "escrowed_payment"; + + // Public key of this trustor, the owner of the coins. + // + // To claim the deposit, the merchant must provide the valid signature + // of the ``h_contract_terms`` field from the deposit, signed by _this_ + // key, to the ``/extensions/policy_escrow``-endpoint of the exchange, + // after the date specified in ``not_before`` and before the date + // specified in ``not_after``. + trustor_pub: EddsaPublicKey; + + // Latest date by which the deposit must be claimed. If the deposit + // has not been claimed by that date, the deposited coins can be + // refreshed by the (still) owner. + deadline: Timestamp; + } + The deposit operation succeeds if the coin is valid for making a deposit and has enough residual value that has not already been deposited or melted. - .. ts:def:: BatchDepositSuccess + .. ts:def:: DepositSuccess - interface BatchDepositSuccess { + interface DepositSuccess { // Optional base URL of the exchange for looking up wire transfers // associated with this transaction. If not given, // the base URL is the same as the one used for this request. @@ -2608,15 +3213,7 @@ denomination. // which signing key was used. exchange_pub: EddsaPublicKey; - // Array of deposit confirmation signatures from the exchange - // Entries must be in the same order the coins were given - // in the batch deposit request. - exchange_sigs[]: DepositConfirmationSignature; - } - - .. ts:def:: DepositConfirmationSignature - - interface DepositConfirmationSignature { + // Deposit confirmation signature from the exchange. // The EdDSA signature of `TALER_DepositConfirmationPS` using a current // `signing key of the exchange <sign-key-priv>` affirming the successful // deposit and that the exchange will transfer the funds after the refund @@ -2624,6 +3221,27 @@ denomination. exchange_sig: EddsaSignature; } + .. ts:def:: DepositDoubleSpendError + + interface DepositDoubleSpendError { + + // Must be TALER_EC_EXCHANGE_GENERIC_INSUFFICIENT_FUNDS + code: Integer; + + // A string explaining that the user tried to + // double-spend. + hint: string; + + // EdDSA public key of a coin being double-spent. + coin_pub: EddsaPublicKey; + + // Transaction history for the coin that is + // being double-spended. + // DEPRECATED! Will be removed soon. Use + // GET /coins/$COIN_PUB to get the history! + history: CoinSpendHistoryItem[]; + } + ---------- Refreshing @@ -2767,7 +3385,7 @@ the API during normal operation. // Melt commitment. Hash over the various coins to be withdrawn. // See also ``TALER_refresh_get_commitment()``. - rc: TALER_RefreshCommitmentP; + rc: HashCode; // Master seed for the Clause-schnorr R-value // creation. Must match the /csr-melt request. @@ -2776,6 +3394,10 @@ the API during normal operation. // denominations is of type Clause-Schnorr. rms?: RefreshMasterSeed; + // IFF the denomination has age restriction support, the client MUST + // provide the SHA256 hash of the age commitment of the coin. + // MUST be omitted otherwise. + age_commitment_hash?: AgeCommitmentHash; } For details about the HKDF used to derive the new coin private keys and @@ -2898,15 +3520,19 @@ the API during normal operation. // Signs over a `TALER_CoinLinkSignaturePS`. link_sigs: EddsaSignature[]; + // IFF the corresponding denomination has support for age restriction, + // the client MUST provide the original age commitment, i. e. the + // vector of public keys. + // The size of the vector MUST be the number of age groups as defined by the + // Exchange in the field ``.age_groups`` of the extension ``age_restriction``. + old_age_commitment?: Edx25519PublicKey[]; + } .. ts:def:: RevealResponse - interface RevealResponse { - // List of the exchange's blinded RSA signatures on the new coins. - ev_sigs : Array<{ ev_sig: BlindedDenominationSignature }>; - } + type RevealResponse = BatchWithdrawResponse; .. ts:def:: RevealConflictResponse @@ -3252,12 +3878,21 @@ typically also view the balance.) // Coin's public key, both ECDHE and EdDSA. coin_pub: CoinPublicKey; - // The total amount the original deposit was worth. + // The total amount the original deposit was worth, + // including fees and after applicable refunds. deposit_value: Amount; - // Applicable fees for the deposit. + // Applicable fees for the deposit, possibly + // reduced or waived due to refunds. deposit_fee: Amount; + // Refunds that were applied to the value of + // this coin. Optional. + // Since protocol **v19**. Before, refunds were + // incorrectly still included in the + // ``deposit_value`` (!). + refund_total?: Amount; + } .. http:get:: /deposits/$H_WIRE/$MERCHANT_PUB/$H_CONTRACT_TERMS/$COIN_PUB @@ -3269,7 +3904,13 @@ typically also view the balance.) **Request:** - :query merchant_sig: EdDSA signature of the merchant made with purpose ``TALER_SIGNATURE_MERCHANT_TRACK_TRANSACTION`` over a ``TALER_DepositTrackPS``, affirming that it is really the merchant who requires obtaining the wire transfer identifier. + :query merchant_sig: EdDSA signature of the merchant made with purpose + ``TALER_SIGNATURE_MERCHANT_TRACK_TRANSACTION`` over a + ``TALER_DepositTrackPS``, affirming that it is really the merchant who + requires obtaining the wire transfer identifier. + :query timeout_ms=NUMBER: *Optional.* If specified, the exchange will wait + up to ``NUMBER`` milliseconds for completion of a deposit operation before + sending the HTTP response. **Response:** @@ -3302,9 +3943,6 @@ typically also view the balance.) // The contribution of this coin to the total (without fees) coin_contribution: Amount; - // Total amount transferred. - total_amount: Amount; - // Binary-only Signature_ with purpose ``TALER_SIGNATURE_EXCHANGE_CONFIRM_WIRE`` // over a `TALER_ConfirmWirePS` // whereby the exchange affirms the successful wire transfer. @@ -3329,6 +3967,11 @@ typically also view the balance.) // need has been evaluated. requirement_row?: Integer; + // Current AML state for the target account. Non-zero + // values indicate that the transfer is blocked due to + // AML enforcement. + aml_decision: Integer; + // True if the KYC check for the merchant has been // satisfied. False does not mean that KYC // is strictly needed, unless also a @@ -3347,7 +3990,7 @@ typically also view the balance.) Refunds ------- -.. http:POST:: /coins/$COIN_PUB/refund +.. http:post:: /coins/$COIN_PUB/refund Undo deposit of the given coin, restoring its value. @@ -3446,8 +4089,8 @@ Refunds Wallet-to-wallet transfers -------------------------- -.. http:GET:: /purses/$PURSE_PUB/merge -.. http:GET:: /purses/$PURSE_PUB/deposit +.. http:get:: /purses/$PURSE_PUB/merge +.. http:get:: /purses/$PURSE_PUB/deposit Obtain information about a purse. Depending on the suffix, the long-polling (if any) will wait for either a merge or @@ -3488,6 +4131,9 @@ Wallet-to-wallet transfers // purse will (have been) merged with the account. balance: Amount; + // When does the purge expire. + purse_expiration: Timestamp; + // Time of the merge, missing if "never". merge_timestamp?: Timestamp; @@ -3499,6 +4145,13 @@ Wallet-to-wallet transfers // property is that it is either "never" or in the past. deposit_timestamp?: Timestamp; + // Time when the purse expires and + // funds that were not merged are refunded + // on the deposited coins. + // FIXME: Document the exchange protocol version + // in which this field became available. + purse_expiration: Timestamp; + // EdDSA signature of the exchange over a // `TALER_PurseStatusResponseSignaturePS` // with purpose ``TALER_SIGNATURE_PURSE_STATUS_RESPONSE`` @@ -3512,7 +4165,7 @@ Wallet-to-wallet transfers -.. http:POST:: /purses/$PURSE_PUB/create +.. http:post:: /purses/$PURSE_PUB/create Create a purse by depositing money into it. First step of a PUSH payment. @@ -3750,7 +4403,35 @@ Wallet-to-wallet transfers } -.. http:POST:: /purses/$PURSE_PUB/merge + +.. http:delete:: /purses/$PURSE_PUB + + Delete a purse that is unmerged and not yet expired. Refunds any money that + is already in the purse. + + **Request:** + + The request body must be empty, as recommended for HTTP delete in general. + To authorize the request, the header must contain a + ``Taler-Purse-Signature: $PURSE_SIG`` where ``$PURSE_SIG`` is the Crockford base32-encoded + EdDSA signature of purpose TALER_SIGNATURE_WALLET_PURSE_DELETE. + + **Response:** + + :http:statuscode:`204 No Content`: + The operation succeeded, the exchange confirms that the purse + was deleted. + :http:statuscode:`403 Forbidden`: + The signature is invalid. + This response comes with a standard `ErrorDetail` response. + :http:statuscode:`404 Not Found`: + The purse is not known. Might have already been deleted previously. + :http:statuscode:`409 Conflict`: + It is too late to delete the purse, its fate (merge or expiration) + was already decided. + + +.. http:post:: /purses/$PURSE_PUB/merge Merge purse with account, adding the value of the purse into the account. Endpoint to be used by the receiver of a PUSH payment. @@ -3801,7 +4482,7 @@ Wallet-to-wallet transfers // Must be of purpose ``TALER_SIGNATURE_ACCOUNT_MERGE`` reserve_sig: EddsaSignature; - // EdDSA signature of the purse private key affirming the merge + // EdDSA signature of the merge private key affirming the merge // over a `TALER_PurseMergeSignaturePS`. // Must be of purpose ``TALER_SIGNATURE_PURSE_MERGE``. merge_sig: EddsaSignature; @@ -3856,7 +4537,7 @@ Wallet-to-wallet transfers -.. http:POST:: /reserves/$RESERVE_PUB/purse +.. http:post:: /reserves/$RESERVE_PUB/purse Create purse for an account. First step of a PULL payment. @@ -3958,7 +4639,7 @@ Wallet-to-wallet transfers } -.. http:POST:: /purses/$PURSE_PUB/deposit +.. http:post:: /purses/$PURSE_PUB/deposit Deposit money into a purse. Used by the buyer for a PULL payment. @@ -4070,7 +4751,7 @@ Wallet-to-wallet transfers // AgeCommitment is an array of public keys, one for each age group of the // age-restricted denomination. - type AgeCommitment = []Edx25519PublicKey; + type AgeCommitment = Edx25519PublicKey[]; .. ts:def:: Attestation @@ -4081,8 +4762,9 @@ Wallet-to-wallet transfers .. _exchange_wads: +---- Wads -^^^^ +---- .. note:: @@ -4093,7 +4775,7 @@ These endpoints are used to manage exchange-to-exchange payments in support of wallet-to-wallet payments. Only another exchange should access this endpoint. -.. http:GET:: /wads/$WAD_ID +.. http:get:: /wads/$WAD_ID Obtain information about a wad. @@ -4181,9 +4863,18 @@ wallet-to-wallet payments. Only another exchange should access this endpoint. KYC status updates ------------------ -.. http:POST:: /kyc-wallet +This section describes endpoints used to set up, complete and +inquire about KYC operations performed by an exchange for +regulatory compliance. + +.. http:post:: /kyc-wallet Setup KYC identification for a wallet. Returns the KYC UUID. + This endpoint is used by compliant Taler wallets when they + are about to hit the balance threshold and thus need to have + the customer provide their personal details to the exchange. + The wallet is identified by its long-lived reserve public key + (which is used for P2P payments, not for withdrawals). **Request:** @@ -4238,17 +4929,20 @@ KYC status updates } -.. http:GET:: /kyc-check/$REQUIREMENT_ROW/$H_PAYTO/$USERTYPE +.. http:get:: /kyc-check/$REQUIREMENT_ROW/$H_PAYTO/$USERTYPE + + Checks the KYC status of a particular payment target and possibly begins the + KYC process. This endpoint is used by wallets or merchants that have been + told about a KYC requirement and now want to check if the KYC requirement + has been fulfilled. Long-polling may be used to instantly observe a change + in the KYC requirement status. - Check or update KYC status of a particular payment target. - Returns the current KYC status of the account and, if - negative, returns the URL where the KYC process can be - initiated. The ``$REQUIREMENT_ROW`` must have been - returned previously from an exchange API endpoint that - determined that KYC was needed. The ``$H_PATYO`` must be - the hash of the payto:// URI of the payment target. - The ``$USERTYPE`` states whether the entity to perform - the KYC is an "individual" or "business". + Returns the current KYC status of the requirement process and, if negative, + returns the URL where the KYC process can be initiated. The + ``$REQUIREMENT_ROW`` must have been returned previously from an exchange API + endpoint that determined that KYC was needed. The ``$H_PATYO`` must be the + hash of the "payto://" URI of the payment target. The ``$USERTYPE`` states + whether the entity to perform the KYC is an "individual" or a "business". **Request:** @@ -4267,12 +4961,13 @@ KYC status updates The response will be an `AccountKycStatus` object. :http:statuscode:`202 Accepted`: The user should be redirected to the provided location to perform - the required KYC checks to open the account. Afterwards, the - ``/kyc/`` request should be repeated. + the required KYC checks to satisfy the legal requirements. Afterwards, the + ``/kyc-check/`` request should be repeated to check whether the + user has completed the process. The response will be an `AccountKycRedirect` object. :http:statuscode:`204 No content`: The exchange is not configured to perform KYC and thus - generally all accounts are simply considered legitimate. + the legal requirements are already satisfied. :http:statuscode:`402 Payment Required`: The client must pay the KYC fee for the KYC process. **This is currently not implemented, see #7365.** @@ -4280,12 +4975,23 @@ KYC status updates The provided hash does not match the payment target. :http:statuscode:`404 Not found`: The payment target is unknown. + :http:statuscode:`451 Unavailable for Legal Reasons`: + The transaction cannot be completed due to AML rules. + Thus, the operation is currently not stuck on KYC, but + on exchange staff performing their AML review. The user + should be told to wait and/or contact the exchange operator + if the situation persists. + The response will be a `AccountAmlBlocked` object. **Details:** .. ts:def:: AccountKycStatus - interface AccountKycStatus { + interface AccountKycStatus { + + // Details about the KYC check that the user + // passed. + kyc_details: KycDetails; // Current time of the exchange, used as part of // what the exchange signs over. @@ -4299,43 +5005,86 @@ KYC status updates // public key used to create the signature. exchange_pub: EddsaPublicKey; + + // Current AML state for the target account. Non-zero + // values indicate that the transfer is blocked due to + // AML enforcement. + aml_status: Integer; + } .. ts:def:: AccountKycRedirect - interface AccountKycRedirect { + interface AccountKycRedirect { // URL that the user should open in a browser to // proceed with the KYC process. kyc_url: string; + // Current AML state for the target account. Non-zero + // values indicate that the transfer is blocked due to + // AML enforcement. + aml_status: Integer; + } + .. ts:def:: AccountAmlBlocked -.. http:GET:: /kyc-proof/$H_PAYTO/$PROVIDER_SECTION + interface AccountAmlBlocked { + + // Current AML state for the target account. Non-zero + // values indicate that the transfer is blocked due to + // AML enforcement. + aml_status: Integer; + + } + + .. ts:def:: KycDetails + + // Object that specifies which KYC checks are satisfied. + interface KycDetails { + + // Keys are the names of the check(s). + // The values are for now always empty objects. + + } - Update KYC status of a particular payment target. Provides +.. http:get:: /kyc-proof/$PROVIDER_SECTION?state=$H_PAYTO + + Endpoint accessed from the user's browser at the *end* of a + KYC process, possibly providing the exchange with additional + credentials to obtain the results of the KYC process. + Specifically, the URL arguments should provide information to the exchange that allows it to verify that the user has completed the KYC process. The details depend on - the logic, which is selected by the $PROVIDER_SECTION. + the logic, which is selected by the "$PROVIDER_SECTION". + + While this is a GET (and thus safe, and idempotent), the operation + may actually trigger significant changes in the exchange's state. + In particular, it may update the KYC status of a particular + payment target. **Request:** Details on the request depend on the specific KYC logic that was used. - If $LOGIC is "oauth2.0", the query parameters are: + If the KYC plugin logic is OAuth 2.0, the query parameters are: :query code=CODE: OAuth 2.0 code argument. - :query state=CODE: OAuth 2.0 state argument. + :query state=STATE: OAuth 2.0 state argument with the H_PAYTO. - .. note:: + .. note:: - Depending on the OAuth variant used, additional - query parameters may need to be passed here. + Depending on the OAuth variant used, additional + query parameters may need to be passed here. **Response:** + Given that the response is returned to a user using a browser and **not** to + a Taler wallet, the response format is in human-readable HTML and not in + machine-readable JSON. + :http:statuscode:`302 Found`: The KYC operation succeeded and the payment target is now authorized to transact. @@ -4353,16 +5102,16 @@ KYC status updates service within a reasonable time period. -.. http:GET:: /kyc-webhook/$PROVIDER_SECTION/* -.. http:POST:: /kyc-webhook/$PROVIDER_SECTION/* -.. http:GET:: /kyc-webhook/$LOGIC/* -.. http:POST:: /kyc-webhook/$LOGIC/* +.. http:get:: /kyc-webhook/$PROVIDER_SECTION/* +.. http:post:: /kyc-webhook/$PROVIDER_SECTION/* +.. http:get:: /kyc-webhook/$LOGIC/* +.. http:post:: /kyc-webhook/$LOGIC/* - Update KYC status of a particular payment target. Provides - information to the KYC logic of the exchange that allows - it to verify that the user has completed the KYC process. - May be a GET or a POST request, depending on $LOGIC or - $PROVIDER_SECTION. + All of the above endpoints can be used to update KYC status of a particular + payment target. They provide information to the KYC logic of the exchange + that allows it to verify that the user has completed the KYC process. May + be a GET or a POST request, depending on the specific "$LOGIC" and/or the + "$PROVIDER_SECTION". **Request:** @@ -4372,7 +5121,7 @@ KYC status updates **Response:** :http:statuscode:`204 No content`: - The webhook succeeded. + The operation succeeded. :http:statuscode:`404 Not found`: The specified logic is unknown. @@ -4382,12 +5131,12 @@ Reserve control --------------- This section describes the reserve control API which can be used to (1) -prevent a reserve from expiring (which is useful if the reserve is used for -tipping), to (2) pay an annual fee to allow a number of purses to be created -for the respective reserve without paying a purse fee each time, to (3) obtain -KYC information associated with a reserve to prove the identity of the person -sending an invoice to the payer, and to (4) close a reserve before it would -naturally expire and possibly (5) wire the funds to a designated account. +prevent a reserve from expiring, to (2) pay an annual fee to allow a number of +purses to be created for the respective reserve without paying a purse fee +each time, to (3) obtain KYC information associated with a reserve to prove +the identity of the person sending an invoice to the payer, and to (4) close a +reserve before it would naturally expire and possibly (5) wire the funds to a +designated account. .. note:: @@ -4395,7 +5144,7 @@ naturally expire and possibly (5) wire the funds to a designated account. .. http:post:: /reserves/$RESERVE_PUB/open - Request keeping a reserve open for tipping or invoicing. + Request keeping a reserve open for invoicing. **Request:** @@ -4406,12 +5155,24 @@ naturally expire and possibly (5) wire the funds to a designated account. :http:statuscode:`200 OK`: The exchange responds with a `ReserveOpenResponse` object. :http:statuscode:`402 Payment Required`: - The exchange responds with a `ReserveOpenFailure` object. + The exchange responds with a `ReserveOpenFailure` object when + the payment offered is insufficient for the requested operation. :http:statuscode:`403 Forbidden`: The *TALER_SIGNATURE_WALLET_RESERVE_OPEN* signature is invalid. This response comes with a standard `ErrorDetail` response. :http:statuscode:`404 Not found`: The reserve key does not belong to a reserve known to the exchange. + :http:statuscode:`409 Conflict`: + The balance of the reserve or of a coin was insufficient. + Which case it is can be decided by looking at the error code + (``TALER_EC_EXCHANGE_GENERIC_INSUFFICIENT_FUNDS`` or + ``TALER_EC_EXCHANGE_GENERIC_COIN_CONFLICTING_DENOMINATION_KEY`` or + ``TALER_EC_EXCHANGE_OPEN_INSUFFICIENT_FUNDS``). + The specific fields of the response depend on the error code + and include the signatures (and what was signed over) proving the + conflict. + The response is `WithdrawError` object or a `DepositDoubleSpendError` + depending on the error type. :http:statuscode:`451 Unavailable For Legal Reasons`: This account has not yet passed the KYC checks. The client must pass KYC checks before the reserve can be opened. @@ -4424,7 +5185,7 @@ naturally expire and possibly (5) wire the funds to a designated account. interface ReserveOpenRequest { // Signature of purpose // ``TALER_SIGNATURE_WALLET_RESERVE_OPEN`` over - // a `TALER_ReserveOpenRequestSignaturePS`. + // a `TALER_ReserveOpenPS`. reserve_sig: EddsaSignature; // Array of payments made towards the cost of the @@ -4487,7 +5248,7 @@ naturally expire and possibly (5) wire the funds to a designated account. // Contribution of this coin to the overall amount. // Can be a fraciton of the coin's total value. - contribution: Amount; + amount: Amount; // Hash of denomination RSA key with which the coin is signed. denom_pub_hash: HashCode; @@ -4511,7 +5272,7 @@ naturally expire and possibly (5) wire the funds to a designated account. } -.. http:get:: /reserves/$RESERVE_PUB/attest +.. http:get:: /reserves-attest/$RESERVE_PUB Request list of available KYC attributes about the owner of a reserve. Used as a preliminary step to find out which subsets of attributes the @@ -4534,11 +5295,11 @@ naturally expire and possibly (5) wire the funds to a designated account. // Array of KYC attributes available. The attribute names // listed are expected to be from the respective GANA // registry. - details: String[]; + details: string[]; } -.. http:post:: /reserves/$RESERVE_PUB/attest +.. http:post:: /reserves-attest/$RESERVE_PUB Request signed KYC information about the owner of a reserve. This can be used by a reserve owner to include a proof @@ -4570,8 +5331,11 @@ naturally expire and possibly (5) wire the funds to a designated account. // a `TALER_WalletReserveAttestRequestSignaturePS`. reserve_sig: EddsaSignature; + // Client's time for the request. + request_timestamp: Timestamp; + // Array of KYC attributes requested. - details: String[]; + details: string[]; } .. ts:def:: ReserveAttestResponse @@ -4579,8 +5343,12 @@ naturally expire and possibly (5) wire the funds to a designated account. interface ReserveAttestResponse { // Signature of purpose // ``TALER_SIGNATURE_EXCHANGE_RESERVE_ATTEST_DETAILS`` over - // a `TALER_ExchangeReserveAttestDetailsSignaturePS`. - reserve_sig: EddsaSignature; + // a `TALER_ExchangeAttestPS`. + exchange_sig: EddsaSignature; + + // Exchange public key used to create the + // signature. + exchange_pub: EddsaPublicKey; // Time when the exchange created the signature. exchange_timestamp: Timestamp; @@ -4661,3 +5429,61 @@ naturally expire and possibly (5) wire the funds to a designated account. wire_amount: Amount; } + + +.. _delete-reserve: + +.. http:DELETE:: /reserves/$RESERVE_PUB + + Forcefully closes a reserve. + The request header must contain an *Account-Request-Signature*. + Note: this endpoint is not currently implemented! + + **Request:** + + *Account-Request-Signature*: The client must provide Base-32 encoded EdDSA signature made with ``$ACCOUNT_PRIV``, affirming its authorization to delete the account. The purpose used MUST be ``TALER_SIGNATURE_RESERVE_CLOSE``. + + :query force=BOOLEAN: *Optional.* If set to 'true' specified, the exchange + will delete the account even if there is a balance remaining. + + **Response:** + + :http:statuscode:`200 OK`: + The operation succeeded, the exchange provides details + about the account deletion. + The response will include a `ReserveDeletedResponse` object. + :http:statuscode:`403 Forbidden`: + The *Account-Request-Signature* is invalid. + This response comes with a standard `ErrorDetail` response. + :http:statuscode:`404 Not found`: + The account is unknown to the exchange. + :http:statuscode:`409 Conflict`: + The account is still has digital cash in it, the associated + wire method is ``void`` and the *force* option was not provided. + This response comes with a standard `ErrorDetail` response. + + **Details:** + + .. ts:def:: ReserveDeletedResponse + + interface ReserveDeletedResponse { + + // Final balance of the account. + closing_amount: Amount; + + // Current time of the exchange, used as part of + // what the exchange signs over. + close_time: Timestamp; + + // Hash of the wire account into which the remaining + // balance will be transferred. Note: may be the + // hash over ``payto://void/`, in which case the + // balance is forfeit to the profit of the exchange. + h_wire: HashCode; + + // This is a signature over a + // struct ``TALER_AccountDeleteConfirmationPS`` with purpose + // ``TALER_SIGNATURE_EXCHANGE_RESERVE_DELETED``. + exchange_sig: EddsaSignature; + + } |