ALalpacahq
Funding

Retrieve List of Transfers for an Account.

You can query a list of transfers for an account.

You can filter requested transfers by values such as direction and status.

Returns a list of transfer entities ordered by created_at

get/v1/accounts/{account_id}/transfers

Request

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

Query parameters

direction'INCOMING' | 'OUTGOING'

INCOMING or OUTGOING

limitinteger
offsetinteger

Response

Success.

account_idstring uuid required

The account ID

additional_informationstring nullable

Additional information. Only applies when type = "wire".

amountstring decimal required

Must be > 0.00

bank_idstring uuid

The ID of the Bank, only present if type = "wire"

created_atstring date-time required

Timestamp when transfer was created

direction'INCOMING' | 'OUTGOING' required
  • INCOMING Funds incoming to user's account (deposit).
  • OUTGOING Funds outgoing from user's account (withdrawal).
expires_atstring date-time

Timestamp when transfer expires

feestring decimal nullable

Fee amount to be collected. Only applies when type = "wire".

fee_payment_methodstring nullable

Either "user" or "invoice". Only applies when type = "wire".

hold_untilstring date-time
idstring uuid required

The transfer ID

instant_amountstring
reasonstring nullable

Cause of the status

relationship_idstring uuid

The ACH relationship ID only present if type = "ach"

requested_amountstring decimal nullable

Must be > 0.00. Only applies when type = "wire".

status'QUEUED' | 'APPROVAL_PENDING' | 'PENDING' | 'SENT_TO_CLEARING' | 'REJECTED' | 'CANCELED' | 'APPROVED' | 'COMPLETE' | 'RETURNED' required
  • QUEUED Transfer is in queue to be processed.
  • APPROVAL_PENDING Transfer is pending approval.
  • PENDING Transfer is pending processing.
  • SENT_TO_CLEARING Transfer is being processed by the clearing firm.
  • REJECTED Transfer is rejected.
  • CANCELED Client initiated transfer cancellation.
  • APPROVED Transfer is approved.
  • COMPLETE Transfer is completed.
  • RETURNED The bank issued an ACH return for the transfer.
type'ach' | 'wire' required
  • ach Transfer via ACH (US Only). Supports both INCOMING (deposit) and OUTGOING (withdrawal) directions.
  • wire Transfer via wire. OUTGOING (withdrawal) only.
updated_atstring date-time

Timestamp when transfer was updated

Example response

[
  {
    "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
    "additional_information": "string",
    "amount": "string",
    "bank_id": "f1ae96de-94c1-468e-93a3-6b7213930ca8",
    "created_at": "2019-08-24T14:15:22Z",
    "direction": "INCOMING",
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "ira": {
      "distribution_reason": "normal",
      "fed_withholding_amount": "102.5",
      "fed_withholding_pct": "10.25",
      "state_withholding_amount": "97.5",
      "state_withholding_pct": "9.75",
      "tax_year": "2024"
    },
    "reason": "string",
    "relationship_id": "81412018-ffa2-43f9-a3eb-d39f1c5e0f87",
    "status": "QUEUED",
    "type": "ach",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

Changes

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