get-withdrawals-WITHDRAWAL_ID.rst (2453B)
1 .. http:get:: /withdrawals/$WITHDRAWAL_ID 2 3 Retrieve public information about ``WITHDRAWAL_ID`` withdrawal operation. 4 Does not require further authentication as knowledge of ``WITHDRAWAL_ID`` 5 serves as an authenticator. 6 7 **Request:** 8 9 :query old_state: 10 *Optional.* Defaults to "pending". 11 :query timeout_ms: *Optional.* 12 Timeout in milliseconds, for :ref:`long-polling <long-polling>`, to wait for the operation state to be different from *old_state*. Since **v5**. 13 :query long_poll_ms: *Optional.* 14 Deprecated since **v5.** Use *timeout_ms* instead. 15 16 **Response:** 17 18 :http:statuscode:`200 Ok`: 19 The bank responds with an `WithdrawalPublicInfo` object. 20 :http:statuscode:`404 Not found`: 21 The operation was not found. 22 23 **Details:** 24 25 .. ts:def:: WithdrawalPublicInfo 26 27 interface WithdrawalPublicInfo { 28 // Current status of the operation 29 // pending: the operation is pending parameters selection (exchange and reserve public key) 30 // selected: the operations has been selected and is pending confirmation 31 // aborted: the operation has been aborted 32 // confirmed: the transfer has been confirmed and registered by the bank 33 status: "pending" | "selected" | "aborted" | "confirmed"; 34 35 // Amount that will be withdrawn with this operation 36 // (raw amount without fee considerations). Only 37 // given once the amount is fixed and cannot be changed. 38 // Optional since **v6**. 39 amount?: Amount; 40 41 // Suggestion for the amount to be withdrawn with this 42 // operation. Given if a suggestion was made but the 43 // user may still change the amount. 44 // Optional since **v6**. 45 suggested_amount?: Amount; 46 47 // If true, the wallet must not allow the user to 48 // specify an amount to withdraw and to not provide 49 // any amount when registering with the withdrawal 50 // operation. The amount to withdraw will be set 51 // by the final ``/withdrawals/$WITHDRAWAL_ID/confirm`` step. 52 // @since **v8** 53 no_amount_to_wallet?: boolean; 54 55 // Account username 56 username: string; 57 58 // Reserve public key selected by the exchange, 59 // only non-null if ``status`` is ``selected`` or ``confirmed``. 60 selected_reserve_pub?: string; 61 62 // Exchange account selected by the wallet 63 // only non-null if ``status`` is ``selected`` or ``confirmed``. 64 selected_exchange_account?: string; 65 }