Contents

POST /accounts/$USERNAME/withdrawals#

Create a withdrawal operation, resulting in a taler://withdraw URI.

Request:

The request must be a BankAccountCreateWithdrawalRequest.

Response:

200 Ok:

The bank responds with an BankAccountCreateWithdrawalResponse object.

401 Unauthorized:

Invalid or missing credentials.

403 Forbidden:

Missing rights.

404 Not found:

The account pointed by $USERNAME was not found.

409 Conflict:

The account does not have sufficient funds.

Details:

interface BankAccountCreateWithdrawalRequest {
  // Amount to withdraw.  If given, the wallet
  // cannot change the amount.
  // Optional since **v6**.
  amount?: Amount;

  // Suggested amount to withdraw. The wallet can
  // still change the suggestion.
  // @since **v6**
  suggested_amount?: Amount;

  // If true, tell the wallet not to allow the user to
  // specify an amount to withdraw and to not provide
  // any amount when registering with the withdrawal
  // operation. The amount to withdraw will be set
  // by the final /withdrawals/$WITHDRAWAL_ID/confirm step.
  // @since **v8**
  no_amount_to_wallet?: boolean;
}
interface BankAccountCreateWithdrawalResponse {
  // ID identifying the operation being created
  withdrawal_id: string;

  // URI that can be passed to the wallet to initiate the withdrawal
  taler_withdraw_uri: string;
}