ACATS

Get transfer details

Includes the same information returned by the list transfers endpoints, but for just one transfer.

get/v1beta1/acats/{account_id}/{acats_id}

Request

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

Path parameters

account_idstring uuid required

Account ID associated with the ACATS transfer

acats_idstring uuid required

The ID of the ACATS transfer

Response

OK

acats_idstring uuid required

The ID of the ACATS transfer

account_idstring uuid required

Account ID associated with the ACATS transfer

account_namestring

Name on the Alpaca account associated with the transfer

account_numberstring required

Account number at Alpaca

account_type'AGENCY' | 'BANK_CUSTODY' | 'BENEFICIARY' | 'BENEFICIARY_ROTH_IRA' | 'CORPORATE' | 'CO_TRUSTEE' | 'COVERDELL_IRA' | 'CUSTODIAN_UGMA' | 'DIRECT_ROLLOVER' | 'ESTATE' | 'HSA' | 'IRA' | 'JOINT' | 'MEDICAL_SAVINGS_ACCOUNT' | 'OTHER' | 'QUALIFIED_OR_PROFIT_SHARING_OR_PENSION' | 'ROTH_401K' | 'ROTH_IRA' | 'ROTH_SEP' | 'ROTH_SIMPLE' | 'ROTH_SOLO_401K' | 'SARSEP' | 'SEP_IRA' | 'SIMPLE_IRA' | 'SINGLE' | 'SOLO_401K' | 'TRUST' | 'TYPE_401K' | 'TYPE_403B' | 'TYPE_457_PLAN' | 'TYPE_529_PLAN'

Account type, as represented by DTCC

contra_account_numberstring required

Account number at the contra broker

contra_broker_namestring

Name of the contra broker

contra_broker_numberstring required

DTCC account number for the contra broker

contra_broker_type'BANK' | 'BROKER'

ACATS participant type

created_atstring date-time required

Timestamp in RFC-3339 format with microsecond precision

direction'INCOMING' | 'OUTGOING' required

Transfer direction

ip_addressstring

User's IP address (IPv4 or IPv6) at time of submission

original_transfer_identifierstring

DTCC transfer identifier for a previous, related transfer

settlement_datestring date-time

Timestamp in RFC-3339 format with microsecond precision

total_transfer_valuestring decimal

Total transfer value is the sum of the market value of all assets and securities in an ACAT at the time of settlement, plus any cash balance.

transfer_identifierstring

DTCC transfer identifier, also known as the control number

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

ACATS transfer type

Example response

{
  "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.