Funding Wallets

Retrieve funding wallet transfer by ID

Returns a single funding wallet transfer for the specified account by transfer_id. Responds with 404 if no matching transfer exists for the account.

get/v1beta/accounts/{account_id}/funding_wallet/transfers/{transfer_id}

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/transfers/{transfer_id}
  • Auth
    HTTP basic

Path parameters

account_idstring required

Alpaca account UUID

transfer_idstring required

transfer UUID

Response

transfer response if found

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.