taler-docs

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

get-wads-WAD_ID.rst (2257B)

      1 .. http:get:: /wads/$WAD_ID
      2 
      3   Obtain information about a wad.
      4 
      5   **Request:**
      6 
      7   **Response:**
      8 
      9   :http:statuscode:`200 OK`:
     10     The operation succeeded, the exchange provides details
     11     about the wad.
     12     The response will include a `WadDetails` object.
     13   :http:statuscode:`404 Not found`:
     14     The wad is unknown to the exchange.
     15 
     16   **Details:**
     17 
     18   .. ts:def:: WadDetails
     19 
     20      interface WadDetails {
     21 
     22       // Total transfer amount claimed by the exchange.
     23       total: Amount;
     24 
     25       // Indicative time by which the wad was given to the
     26       // bank to execute the wire transfer.
     27       wad_execution_time: Timestamp;
     28 
     29       // Transfers aggregated in the wad.
     30       items: WadItem[];
     31 
     32       // EdDSA signature of the exchange affirming the wad
     33       // data is correct, must be over `TALER_WadDataSignaturePS`
     34       // and of purpose ``TALER_SIGNATURE_WAD_DATA``.
     35       exchange_sig: EddsaSignature;
     36 
     37       // public key used to create the signature.
     38       exchange_pub: EddsaPublicKey;
     39      }
     40 
     41   Objects in the wad item list have the following format:
     42 
     43   .. ts:def:: WadItem
     44 
     45     interface WadItem {
     46 
     47       // Amount in the purse.
     48       amount: Amount;
     49 
     50       // Normalized payto URI of the account the purse is to be merged into.
     51       // Must be of the form: 'payto://taler/EXCHANGE_URL/RESERVE_PUB'.
     52       payto_uri: string;
     53 
     54       // Purse public key.
     55       purse_pub: EddsaPublicKey;
     56 
     57       // Hash of the contract.
     58       h_contract: HashCode;
     59 
     60       // Indicative time by which the purse should expire
     61       // if it has not been paid.
     62       purse_expiration: Timestamp;
     63 
     64       // Client-side timestamp of when the merge request was made.
     65       merge_timestamp: Timestamp;
     66 
     67       // Signature created with the reserve's private key.
     68       // Must be of purpose ``TALER_SIGNATURE_ACCOUNT_MERGE``
     69       // and over `TALER_AccountMergeSignaturePS`.
     70       reserve_sig: EddsaSignature;
     71 
     72       // Signature created with the purse's private key.
     73       // Must be of purpose ``TALER_SIGNATURE_PURSE_MERGE``
     74       // and over `TALER_PurseMergeSignaturePS`.
     75       purse_sig: EddsaSignature;
     76 
     77       // Deposit fees that were charged to the purse.
     78       deposit_fees: Amount;
     79 
     80       // Wad fees that was charged to the purse.
     81       wad_fees: Amount;
     82     }