ALalpacahq
ACATS

List transfers

List all incoming and outgoing transfers, for all accounts. The list may include transfers not initiated using this API. The list is paginated: use the page_token query parameter with the value returned in the response to continue listing transfers.

get/v1beta1/acats

Request

  • Base URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets
  • URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets/v1beta1/acats
  • Auth
    HTTP basic

Query parameters

account_numberstring

Filter by the account number associated with the transfer

transfer_type'FUL' | 'FRV' | 'MFC' | 'PTD' | 'PTR' | 'RCL' | 'RCR' | 'PTF'

ACATS transfer type

Filter by the type of the transfer

transfer_direction'INCOMING' | 'OUTGOING'

Transfer direction

Filter by the direction of the transfer

transfer_status'PENDING' | 'IN_PROGRESS' | 'REJECTED' | 'SETTLED'

Transfer status as tracked by Alpaca

Filter by the current status of the transfer

dtcc_status'REQUEST' | 'REQUEST_ADJUST' | 'REQUEST_ADJUST_PAST' | 'REQUEST_PAST' | 'REQUEST_REJECT' | 'REVIEW' | 'REVIEW_ADJUST_DELIVERER' | 'REVIEW_ERROR' | 'REVIEW_ACCELERATE' | 'REVIEW_ADJUST_RECEIVER_ACCELERATE' | 'SETTLE_PREP' | 'SETTLE_CLOSE' | 'CLOSE_PURGE' | 'REQUEST_PTR' | 'MEMO_PURGE_PARTIAL_TRANSFER_REQUEST_RECEIVER' | 'REJECT' | 'SYSTEM_REJECTED'

Transfer status as tracked by DTCC

Filter by the current DTCC status of the transfer

contra_broker_numberstring

Filter by the contra broker number of the transfer

sincestring date-time

Timestamp in RFC-3339 format with microsecond precision

Example:2026-01-01T00:00:00Z

List transfers created at or after this RFC-3339 timestamp (e.g. 2026-01-01T00:00:00Z).

untilstring date-time

Timestamp in RFC-3339 format with microsecond precision

Example:2026-01-01T00:00:00Z

List transfers created strictly before this RFC-3339 timestamp (exclusive -- e.g. 2026-01-01T00:00:00Z excludes transfers created exactly at that instant).

sort_direction'ASC' | 'DESC'

Sort direction for list results.

Specify whether transfers should be sorted by creation time in ascending or descending order

sort_by'account_number' | 'total_transfer_value' | 'created_at' | 'contra_account_number' | 'contra_broker_number' | 'external_transfer_id' | 'settled_at' | 'status' | 'transfer_type' | 'updated_at'

Specify the field to sort by. Defaults to created_at.

limitinteger

Maximum number of transfers to return on one page

page_tokenstring

Page token, pass it back unchanged in the page_token query parameter to fetch the next or previous page.

Example:eyJjcmVhdGVkX2F0IjoiMjAyNi0wNC0yOFQxNDozMDowMFoiLCJpZCI6IjAxQUJDIn0=

Page token for the next or previous page, used to continue listing transfers

Response

OK

page_token_nextstring

Page token, pass it back unchanged in the page_token query parameter to fetch the next or previous page.

page_token_previousstring

Page token, pass it back unchanged in the page_token query parameter to fetch the next or previous page.

pending_transfersinteger

The count of ACATS transfers pending review

Example response

{
  "page_token_next": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNC0yOFQxNDozMDowMFoiLCJpZCI6IjAxQUJDIn0=",
  "pending_transfers": 37,
  "transfers": [
    {
      "acats_id": "2c827687-ddd3-4ad9-bee8-0a3cdad35301",
      "account_id": "9ac16d7d-1f6e-445b-8e51-807e77ba2902",
      "account_name": "John Doe",
      "account_number": "12345678",
      "account_type": "SINGLE",
      "contra_account_number": "A00000123",
      "contra_broker_name": "Alpaca Clearing",
      "contra_broker_number": "00001234",
      "contra_broker_type": "BANK",
      "created_at": "2026-04-21T12:41:03.505862Z",
      "direction": "INCOMING",
      "ip_address": "203.0.113.42",
      "rejection_details": {
        "rejection_message": "SS# Tax ID Mismatch",
        "rejection_reason": "SS_TAX_ID_MISMATCH"
      },
      "status": {
        "dtcc_status": "REJECT",
        "transfer_status": "REJECTED"
      },
      "total_transfer_value": "24223.62",
      "transfer_identifier": "03251237654321",
      "transfer_type": "FUL"
    }
  ]
}

Changes

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