diff options
Diffstat (limited to 'core/api-exchange.rst')
-rw-r--r-- | core/api-exchange.rst | 48 |
1 files changed, 47 insertions, 1 deletions
diff --git a/core/api-exchange.rst b/core/api-exchange.rst index 65c35575..0f966f03 100644 --- a/core/api-exchange.rst +++ b/core/api-exchange.rst @@ -1100,6 +1100,52 @@ Management operations authorized by master key } +.. http:post:: /management/drain + + This request is used to drain profits from the + exchange's escrow account to another regular + bank account of the exchange. The actual drain + requires running the ``taler-exchange-drain`` tool. + + **Request:** + + The request must be a `DrainProfitsMessage`. + + **Response:** + + :http:statuscode:`204 No content`: + The profit drain was scheduled. + :http:statuscode:`403 Forbidden`: + The master signature is invalid. + + **Details:** + + .. ts:def:: DrainProfitsMessage + + interface DrainProfitsMessage { + + // Configuration section of the account to debit. + debit_account_section: string; + + // Credit payto URI + credit_payto_uri: string; + + // Wire transfer identifier to use. + wtid: Base32; + + // Signature by the exchange master key over a + // `TALER_MasterDrainProfitPS`. + // Must have purpose ``TALER_SIGNATURE_MASTER_DRAIN_PROFITS``. + master_sig: EddsaSignature; + + // When was the message created. + date: Timestamp; + + // Amount to be drained. + amount: Amount; + + } + .. http:post:: /management/partners @@ -1500,7 +1546,7 @@ exchange. closing_fee: Amount; // Wire transfer subject. - wtid: string; + wtid: Base32; // ``payto://`` URI of the wire account into which the funds were returned to. receiver_account_details: string; |