taler-docs

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

post-accounts-USERNAME-withdrawals-WITHDRAWAL_ID-confirm.rst (1702B)

      1 .. http:post:: /accounts/$USERNAME/withdrawals/$WITHDRAWAL_ID/confirm
      2 
      3   Confirms ``WITHDRAWAL_ID`` operation.  Has no effect on an already confirmed
      4   withdrawal operation.  This call is responsible for wiring the funds to the
      5   exchange.
      6 
      7   **Request:**
      8 
      9   .. ts:def:: BankAccountConfirmWithdrawalRequest
     10 
     11     interface BankAccountConfirmWithdrawalRequest {
     12 
     13       // Selected amount to be transferred. Optional if the
     14       // backend already knows the amount.
     15       // @since **v6**
     16       amount?: Amount;
     17     }
     18 
     19 
     20   **Response:**
     21 
     22   :http:statuscode:`202 Accepted`:
     23     2FA is required for this operation. This returns the `ChallengeResponse` response. @since **v10**
     24   :http:statuscode:`204 No content`:
     25     The withdrawal operation has been confirmed.
     26   :http:statuscode:`401 Unauthorized`:
     27     Invalid or missing credentials.
     28   :http:statuscode:`403 Forbidden`:
     29     Missing rights.
     30   :http:statuscode:`404 Not found`:
     31     The operation was not found.
     32   :http:statuscode:`409 Conflict`:
     33     * ``TALER_EC_BANK_CONFIRM_ABORT_CONFLICT`` : the withdrawal has been aborted previously and can't be confirmed.
     34     * ``TALER_EC_BANK_CONFIRM_INCOMPLETE`` : the withdraw operation cannot be confirmed because no exchange and reserve public key selection happened before.
     35     * ``TALER_EC_BANK_DUPLICATE_RESERVE_PUB_SUBJECT``: the reserve public key is already used.
     36     * ``TALER_EC_BANK_UNALLOWED_DEBIT`` : the account does not have sufficient funds or the amount is too low or too high
     37     * ``TALER_EC_BANK_AMOUNT_DIFFERS`` : the specified amount will not work for this withdrawal (since **v6**).
     38     * ``TALER_EC_BANK_AMOUNT_REQUIRED`` : the backend requires an amount to be specified  (since **v6**).