ALalpacahq
Funding Wallets

Create a withdrawal

Creates a withdrawal

post/v1beta/accounts/{account_id}/funding_wallet/withdrawal

Request

  • Base URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets
  • URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets/v1beta/accounts/{account_id}/funding_wallet/withdrawal
  • Auth
    HTTP basic

Path parameters

account_idstring required

UUID alpaca account ID

Request body

desired_currencystring
fee_inclusiveboolean

When true, fees are deducted from usd_amount instead of being added on top, so the total amount debited from the account equals usd_amount exactly (the beneficiary receives usd_amount minus fees). This lets the account be drained to zero: pass the account's full available cash as usd_amount. The request is rejected if usd_amount is less than or equal to the fees. Defaults to false (fees added on top of usd_amount).

payment_type'swift_wire' | 'local_rails'

Status:

  • swift_wire: SWIFT wire
  • local_rails: Local scheme
usd_amountstring decimal

Response

Transfer

account_idstring uuid
created_atstring date-time
direction'incoming' | 'outgoing'

Status:

  • incoming: incoming amount
  • outgoing: outgoing amount
idstring uuid
original_amountstring decimal

Deprecation notice: Use total_amount for the actual amount debited from the account.

Since: 2026-09-22 Sunset: 2026-12-21

The amount you should expect to receive, calculated as requested amount - fees.

original_currencystring

The currency of the withdrawn amount, 3-letter ISO code

payment_type'swift_wire' | 'local_rails'

Status:

  • swift_wire: SWIFT wire
  • local_rails: Local scheme
requested_amountstring decimal

The amount requested when the transfer was created.

status'PENDING' | 'CANCELED' | 'EXECUTED' | 'FAILED' | 'COMPLETE'

Status:

  • PENDING: Created and waiting to be processed
  • CANCELED: Canceled
  • FAILED: Failed mostly due to technical reasons
  • COMPLETE: Transfer has settled
total_amountstring decimal

The total amount moved for the transfer. For outgoing transfers with fees added on top, this is the requested amount plus fees (the total debited from the account). For fee-inclusive outgoing withdrawals, fees are taken out of the requested amount, so this equals requested_amount. For incoming transfers, this is the requested amount credited to the account.

updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.