taler-docs

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

post-management-drain.rst (1109B)

      1 .. http:post:: /management/drain
      2 
      3   This request is used to drain profits from the
      4   exchange's escrow account to another regular
      5   bank account of the exchange.  The actual drain
      6   requires running the ``taler-exchange-drain`` tool.
      7 
      8   **Request:**
      9 
     10   The request must be a `DrainProfitsMessage`.
     11 
     12   **Response:**
     13 
     14   :http:statuscode:`204 No content`:
     15     The profit drain was scheduled.
     16   :http:statuscode:`403 Forbidden`:
     17     The master signature is invalid.
     18 
     19   **Details:**
     20 
     21   .. ts:def:: DrainProfitsMessage
     22 
     23     interface DrainProfitsMessage {
     24 
     25       // Configuration section of the account to debit.
     26       debit_account_section: string;
     27 
     28       // Full payto URI of the account to credit.
     29       credit_payto_uri: string;
     30 
     31       // Wire transfer identifier to use.
     32       wtid: Base32;
     33 
     34       // Signature by the exchange master key over a
     35       // `TALER_MasterDrainProfitPS`.
     36       // Must have purpose ``TALER_SIGNATURE_MASTER_DRAIN_PROFITS``.
     37       master_sig: EddsaSignature;
     38 
     39       // When was the message created.
     40       date: Timestamp;
     41 
     42       // Amount to be drained.
     43       amount: Amount;
     44 
     45     }