delete-reserves-RESERVE_PUB.rst (2034B)
1 .. http:DELETE:: /reserves/$RESERVE_PUB 2 3 Forcefully closes a reserve. 4 The request header must contain an *Account-Request-Signature*. 5 Note: this endpoint is not currently implemented! 6 7 **Request:** 8 9 *Account-Request-Signature*: 10 The client must provide Base-32 encoded EdDSA signature made with 11 ``$ACCOUNT_PRIV``, affirming its authorization to delete the account. 12 The purpose used MUST be ``TALER_SIGNATURE_RESERVE_CLOSE``. 13 14 :query force=BOOLEAN: *Optional.* If set to 'true' specified, the exchange 15 will delete the account even if there is a balance remaining. 16 17 **Response:** 18 19 :http:statuscode:`200 OK`: 20 The operation succeeded, the exchange provides details 21 about the account deletion. 22 The response will include a `ReserveDeletedResponse` object. 23 :http:statuscode:`403 Forbidden`: 24 The *Account-Request-Signature* is invalid. 25 This response comes with a standard `ErrorDetail` response. 26 :http:statuscode:`404 Not found`: 27 The account is unknown to the exchange. 28 :http:statuscode:`409 Conflict`: 29 The account is still has digital cash in it, the associated 30 wire method is ``void`` and the *force* option was not provided. 31 This response comes with a standard `ErrorDetail` response. 32 33 **Details:** 34 35 .. ts:def:: ReserveDeletedResponse 36 37 interface ReserveDeletedResponse { 38 39 // Final balance of the account. 40 closing_amount: Amount; 41 42 // Current time of the exchange, used as part of 43 // what the exchange signs over. 44 close_time: Timestamp; 45 46 // Hash of the full payto URI of the wire account 47 // into which the remaining balance will be transferred. 48 // Note: may be the hash over ``payto://void/`, 49 // in which case the balance is forfeit 50 // to the profit of the exchange. 51 h_wire: FullPaytoHash; 52 53 // This is a signature over a 54 // struct ``TALER_AccountDeleteConfirmationPS`` with purpose 55 // ``TALER_SIGNATURE_EXCHANGE_RESERVE_DELETED``. 56 exchange_sig: EddsaSignature; 57 58 }