Skip to content

Get FOP Transfers

GET
/fop-transfers

Retrieve FOP transfers for an account on a given settlement date. Set pending_only=true to return only pending transfers.

Parameters

Header Parameters

X-API-KEY
Type
string

Query Parameters

account_number*

Account number to query.

Type
string
Required
settlement_date*

Settlement date in YYYY-MM-DD format.

Type
string
Required
Format
"date"
pending_only

If true, only returns transfers that are not submitted to the custodian.

Type
boolean
Default
false

Responses

OK

application/json
JSON
[
  
{
  
  
"direction": "inbound",
  
  
"symbol": "AMD",
  
  
"cusip": "007903107",
  
  
"account_number": "MOCK_OMNI_AVSUAT_RQD_001",
  
  
"counterparty_dtc_number": "1234",
  
  
"counterparty_account_number": "CP-ACCOUNT-1",
  
  
"quantity": "10",
  
  
"memo_1": "memo-a",
  
  
"memo_2": "memo-b",
  
  
"memo_3": "memo-c",
  
  
"settlement_date": "2026-06-30",
  
  
"id": "256b6877-f097-4905-ad41-33a8b3b653c2",
  
  
"client_transfer_id": "CLIENT-TRANSFER-001",
  
  
"created_at": "2026-06-26T13:00:42Z"
  
}
]

Playground

Headers
Variables
Key
Value

Samples

Powered by VitePress OpenAPI