Sign in

v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB
Funding Wallets

Create a withdrawal

Creates a withdrawal

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

Path parameters

account_idstring required

UUID alpaca account ID

Request body

desired_currencystring
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

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 sent as part of the withdrawal creation

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
updated_atstring date-time