openapi: 3.2.0
info:
title: Citi Services API
version: '1.0'
description: 'Operations tagged Services across 8 of this provider''s published API definitions: cash-balances.yaml, cash-transactions.yaml, citi-custody-fx-transactions-openapi.yaml, citi-custody-penalties-openapi.yaml, citi-safekeeping-accounts-openapi.yaml, citi-safekeeping-positions-openapi.yaml, citi-securitytransactionsaccounts-openapi.yaml, citi-tax-reclaims-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://sandbox.api.citivelocity.com/markets/dod
description: Sandbox server (uses test data)
- url: https://api.citivelocity.com/markets/dod
description: Production server
security:
- client-Credential-Oauth-Security-Schema: []
tags:
- name: Services
paths:
/api/services/e0b62396-5920-4270-96b1-26dddee0c242/filter:
get:
summary: Cash Balances
description: Provides Custody Cash Balances by currency for a particular date and cash account
parameters:
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/select'
- $ref: '#/components/parameters/parameter-18785'
- $ref: '#/components/parameters/parameter-18787'
- $ref: '#/components/parameters/parameter-18788'
- $ref: '#/components/parameters/parameter-18791'
- $ref: '#/components/parameters/parameter-18793'
- $ref: '#/components/parameters/parameter-18796'
- $ref: '#/components/parameters/parameter-18799'
- $ref: '#/components/parameters/parameter-18800'
- $ref: '#/components/parameters/parameter-18802'
- $ref: '#/components/parameters/parameter-18803'
- $ref: '#/components/parameters/parameter-18804'
- $ref: '#/components/parameters/parameter-18805'
- $ref: '#/components/parameters/parameter-18806'
- $ref: '#/components/parameters/parameter-18813'
- $ref: '#/components/parameters/parameter-18815'
- $ref: '#/components/parameters/parameter-18816'
- $ref: '#/components/parameters/parameter-18817'
- $ref: '#/components/parameters/parameter-18818'
- $ref: '#/components/parameters/parameter-18820'
- $ref: '#/components/parameters/parameter-18821'
- $ref: '#/components/parameters/parameter-18824'
- $ref: '#/components/parameters/parameter-18826'
- $ref: '#/components/parameters/parameter-18829'
- $ref: '#/components/parameters/parameter-18832'
- $ref: '#/components/parameters/parameter-18833'
- $ref: '#/components/parameters/parameter-42407'
responses:
'200':
description: Success
headers:
X-DoD-Request-ID:
$ref: '#/components/headers/dod-request-id'
X-Paging-PageNumber:
$ref: '#/components/headers/paging-page-number'
X-Paging-TotalPageCount:
$ref: '#/components/headers/paging-total-page-count'
X-Paging-TotalRecordCount:
$ref: '#/components/headers/paging-total-record-count'
content:
application/json:
schema:
$ref: '#/components/schemas/e0b62396-5920-4270-96b1-26dddee0c242-json-response-schema'
application/xml:
schema:
$ref: '#/components/schemas/e0b62396-5920-4270-96b1-26dddee0c242-xml-response-schema'
example: 8-DEMOCSH53JPY C CASH DEMOSK02US Demo - SK - US DCC Equity Open JPY 2019-08-26 00:00:00 6136188.61 POSTED 484 NEW YORK SECURITIES CB 1 2019-08-26 2 1000123456 JPY 6136188.61 2019-08-26 00:00:00 2019-08-26 00:00:00 6136188.61 P Y 46050312345 2019-08-26 00:00:00 1234567
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'500':
$ref: '#/components/responses/Internal-Server-Error'
tags:
- Services
operationId: getApiServicesE0b623965920427096b126dddee0c242Filter
x-operation-id-source: derived
servers:
- url: https://sandbox.api.citivelocity.com/markets/dod
description: Sandbox server (uses test data)
- url: https://api.citivelocity.com/markets/dod
description: Production server
/api/services/1bcf00be-b782-4f9f-a814-0752b0326ae6/filter:
get:
summary: Current Cash Balances
description: Current Cash Balances provides the current cash balance for each cash account.
parameters:
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/select'
- $ref: '#/components/parameters/parameter-13535'
- $ref: '#/components/parameters/parameter-13562'
- $ref: '#/components/parameters/parameter-13536'
- $ref: '#/components/parameters/parameter-28702'
- $ref: '#/components/parameters/parameter-13553'
- $ref: '#/components/parameters/parameter-13574'
- $ref: '#/components/parameters/parameter-13539'
- $ref: '#/components/parameters/parameter-28709'
- $ref: '#/components/parameters/parameter-28696'
- $ref: '#/components/parameters/parameter-28699'
- $ref: '#/components/parameters/parameter-28700'
- $ref: '#/components/parameters/parameter-13554'
- $ref: '#/components/parameters/parameter-13572'
- $ref: '#/components/parameters/parameter-28711'
- $ref: '#/components/parameters/parameter-28701'
- $ref: '#/components/parameters/parameter-13544'
- $ref: '#/components/parameters/parameter-28710'
- $ref: '#/components/parameters/parameter-28704'
- $ref: '#/components/parameters/parameter-28694'
- $ref: '#/components/parameters/parameter-28707'
- $ref: '#/components/parameters/parameter-28708'
- $ref: '#/components/parameters/parameter-28693'
- $ref: '#/components/parameters/parameter-28705'
- $ref: '#/components/parameters/parameter-28698'
responses:
'200':
description: Success
headers:
X-DoD-Request-ID:
$ref: '#/components/headers/dod-request-id'
X-Paging-PageNumber:
$ref: '#/components/headers/paging-page-number'
X-Paging-TotalPageCount:
$ref: '#/components/headers/paging-total-page-count'
X-Paging-TotalRecordCount:
$ref: '#/components/headers/paging-total-record-count'
content:
application/json:
schema:
$ref: '#/components/schemas/1bcf00be-b782-4f9f-a814-0752b0326ae6-json-response-schema'
application/xml:
schema:
$ref: '#/components/schemas/1bcf00be-b782-4f9f-a814-0752b0326ae6-xml-response-schema'
example: 8-DEMOCSH53JPY C CASH DEMOSK02US Demo - SK - US DCC Equity Open JPY 2019-08-26 00:00:00 6136188.61 POSTED 484 NEW YORK SECURITIES CB 1 2019-08-26 2 1000123456 2019-08-26 00:00:00 JPY 6136188.61 2019-08-26 00:00:00 2019-08-26 00:00:00 6136188.61 P 46050312345
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'500':
$ref: '#/components/responses/Internal-Server-Error'
tags:
- Services
operationId: getApiServices1bcf00beB7824f9fA8140752b0326ae6Filter
x-operation-id-source: derived
servers:
- url: https://sandbox.api.citivelocity.com/markets/dod
description: Sandbox server (uses test data)
- url: https://api.citivelocity.com/markets/dod
description: Production server
/api/services/f5471486-3c48-45bc-9b1f-05a7d57bdc71/filter:
get:
summary: Cash Transactions
description: Provides Custody Cash Transactions details for a particular date and cash account
parameters:
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/select_2'
- $ref: '#/components/parameters/parameter-18839'
- $ref: '#/components/parameters/parameter-18841'
- $ref: '#/components/parameters/parameter-18842'
- $ref: '#/components/parameters/parameter-18843'
- $ref: '#/components/parameters/parameter-18844'
- $ref: '#/components/parameters/parameter-18846'
- $ref: '#/components/parameters/parameter-18847'
- $ref: '#/components/parameters/parameter-18849'
- $ref: '#/components/parameters/parameter-18850'
- $ref: '#/components/parameters/parameter-18851'
- $ref: '#/components/parameters/parameter-18852'
- $ref: '#/components/parameters/parameter-18853'
- $ref: '#/components/parameters/parameter-18855'
- $ref: '#/components/parameters/parameter-18856'
- $ref: '#/components/parameters/parameter-18858'
- $ref: '#/components/parameters/parameter-18859'
- $ref: '#/components/parameters/parameter-18860'
- $ref: '#/components/parameters/parameter-18861'
- $ref: '#/components/parameters/parameter-18862'
- $ref: '#/components/parameters/parameter-18863'
- $ref: '#/components/parameters/parameter-18864'
- $ref: '#/components/parameters/parameter-18873'
- $ref: '#/components/parameters/parameter-18878'
- $ref: '#/components/parameters/parameter-18880'
- $ref: '#/components/parameters/parameter-18881'
- $ref: '#/components/parameters/parameter-18882'
- $ref: '#/components/parameters/parameter-18883'
- $ref: '#/components/parameters/parameter-18886'
- $ref: '#/components/parameters/parameter-18887'
- $ref: '#/components/parameters/parameter-18888'
- $ref: '#/components/parameters/parameter-18889'
- $ref: '#/components/parameters/parameter-18890'
- $ref: '#/components/parameters/parameter-18891'
- $ref: '#/components/parameters/parameter-18892'
- $ref: '#/components/parameters/parameter-18893'
- $ref: '#/components/parameters/parameter-18894'
- $ref: '#/components/parameters/parameter-18896'
- $ref: '#/components/parameters/parameter-18897'
- $ref: '#/components/parameters/parameter-18898'
- $ref: '#/components/parameters/parameter-18900'
- $ref: '#/components/parameters/parameter-18901'
- $ref: '#/components/parameters/parameter-18902'
- $ref: '#/components/parameters/parameter-18905'
- $ref: '#/components/parameters/parameter-18906'
- $ref: '#/components/parameters/parameter-18908'
- $ref: '#/components/parameters/parameter-18909'
- $ref: '#/components/parameters/parameter-18910'
- $ref: '#/components/parameters/parameter-18911'
- $ref: '#/components/parameters/parameter-18912'
- $ref: '#/components/parameters/parameter-18913'
- $ref: '#/components/parameters/parameter-18915'
- $ref: '#/components/parameters/parameter-18921'
- $ref: '#/components/parameters/parameter-18922'
- $ref: '#/components/parameters/parameter-18923'
- $ref: '#/components/parameters/parameter-18925'
- $ref: '#/components/parameters/parameter-18926'
- $ref: '#/components/parameters/parameter-18928'
- $ref: '#/components/parameters/parameter-18929'
- $ref: '#/components/parameters/parameter-18931'
- $ref: '#/components/parameters/parameter-18933'
- $ref: '#/components/parameters/parameter-18935'
- $ref: '#/components/parameters/parameter-18938'
- $ref: '#/components/parameters/parameter-18939'
- $ref: '#/components/parameters/parameter-18941'
- $ref: '#/components/parameters/parameter-18942'
- $ref: '#/components/parameters/parameter-18943'
- $ref: '#/components/parameters/parameter-18944'
- $ref: '#/components/parameters/parameter-18945'
- $ref: '#/components/parameters/parameter-18946'
- $ref: '#/components/parameters/parameter-18947'
- $ref: '#/components/parameters/parameter-18948'
- $ref: '#/components/parameters/parameter-18949'
- $ref: '#/components/parameters/parameter-18950'
- $ref: '#/components/parameters/parameter-18951'
- $ref: '#/components/parameters/parameter-18952'
- $ref: '#/components/parameters/parameter-18953'
- $ref: '#/components/parameters/parameter-18954'
- $ref: '#/components/parameters/parameter-18959'
- $ref: '#/components/parameters/parameter-18960'
- $ref: '#/components/parameters/parameter-18961'
- $ref: '#/components/parameters/parameter-18962'
- $ref: '#/components/parameters/parameter-18963'
- $ref: '#/components/parameters/parameter-18965'
- $ref: '#/components/parameters/parameter-18966'
- $ref: '#/components/parameters/parameter-18967'
- $ref: '#/components/parameters/parameter-18969'
- $ref: '#/components/parameters/parameter-18971'
- $ref: '#/components/parameters/parameter-18972'
- $ref: '#/components/parameters/parameter-18973'
- $ref: '#/components/parameters/parameter-18974'
- $ref: '#/components/parameters/parameter-18975'
- $ref: '#/components/parameters/parameter-18976'
- $ref: '#/components/parameters/parameter-18977'
- $ref: '#/components/parameters/parameter-18978'
- $ref: '#/components/parameters/parameter-18981'
- $ref: '#/components/parameters/parameter-18983'
- $ref: '#/components/parameters/parameter-18985'
- $ref: '#/components/parameters/parameter-18986'
- $ref: '#/components/parameters/parameter-18987'
- $ref: '#/components/parameters/parameter-18988'
- $ref: '#/components/parameters/parameter-18989'
- $ref: '#/components/parameters/parameter-18990'
- $ref: '#/components/parameters/parameter-18993'
- $ref: '#/components/parameters/parameter-18998'
- $ref: '#/components/parameters/parameter-18999'
- $ref: '#/components/parameters/parameter-19000'
- $ref: '#/components/parameters/parameter-19001'
- $ref: '#/components/parameters/parameter-19002'
- $ref: '#/components/parameters/parameter-19003'
- $ref: '#/components/parameters/parameter-19004'
- $ref: '#/components/parameters/parameter-19005'
- $ref: '#/components/parameters/parameter-19007'
- $ref: '#/components/parameters/parameter-19008'
- $ref: '#/components/parameters/parameter-19009'
- $ref: '#/components/parameters/parameter-19010'
- $ref: '#/components/parameters/parameter-19014'
- $ref: '#/components/parameters/parameter-19018'
- $ref: '#/components/parameters/parameter-19019'
- $ref: '#/components/parameters/parameter-19020'
- $ref: '#/components/parameters/parameter-19021'
- $ref: '#/components/parameters/parameter-19022'
- $ref: '#/components/parameters/parameter-19023'
- $ref: '#/components/parameters/parameter-19024'
- $ref: '#/components/parameters/parameter-19025'
- $ref: '#/components/parameters/parameter-19026'
- $ref: '#/components/parameters/parameter-19027'
- $ref: '#/components/parameters/parameter-19028'
- $ref: '#/components/parameters/parameter-19031'
- $ref: '#/components/parameters/parameter-19032'
- $ref: '#/components/parameters/parameter-19039'
- $ref: '#/components/parameters/parameter-19043'
- $ref: '#/components/parameters/parameter-19045'
- $ref: '#/components/parameters/parameter-19047'
- $ref: '#/components/parameters/parameter-19051'
- $ref: '#/components/parameters/parameter-19053'
- $ref: '#/components/parameters/parameter-19056'
- $ref: '#/components/parameters/parameter-19059'
- $ref: '#/components/parameters/parameter-19060'
- $ref: '#/components/parameters/parameter-19062'
- $ref: '#/components/parameters/parameter-19063'
- $ref: '#/components/parameters/parameter-19064'
- $ref: '#/components/parameters/parameter-19065'
- $ref: '#/components/parameters/parameter-19067'
- $ref: '#/components/parameters/parameter-19068'
- $ref: '#/components/parameters/parameter-19069'
- $ref: '#/components/parameters/parameter-19070'
- $ref: '#/components/parameters/parameter-19071'
- $ref: '#/components/parameters/parameter-19072'
- $ref: '#/components/parameters/parameter-19075'
- $ref: '#/components/parameters/parameter-19083'
- $ref: '#/components/parameters/parameter-19084'
- $ref: '#/components/parameters/parameter-19085'
- $ref: '#/components/parameters/parameter-19086'
- $ref: '#/components/parameters/parameter-19087'
- $ref: '#/components/parameters/parameter-19089'
- $ref: '#/components/parameters/parameter-19093'
- $ref: '#/components/parameters/parameter-19094'
- $ref: '#/components/parameters/parameter-19095'
- $ref: '#/components/parameters/parameter-19096'
- $ref: '#/components/parameters/parameter-19097'
- $ref: '#/components/parameters/parameter-19099'
- $ref: '#/components/parameters/parameter-19100'
- $ref: '#/components/parameters/parameter-19101'
- $ref: '#/components/parameters/parameter-19103'
- $ref: '#/components/parameters/parameter-19104'
- $ref: '#/components/parameters/parameter-19107'
- $ref: '#/components/parameters/parameter-19108'
- $ref: '#/components/parameters/parameter-19110'
- $ref: '#/components/parameters/parameter-19113'
- $ref: '#/components/parameters/parameter-42408'
- $ref: '#/components/parameters/parameter-54430'
responses:
'200':
description: Success
headers:
X-DoD-Request-ID:
$ref: '#/components/headers/dod-request-id_2'
X-Paging-PageNumber:
$ref: '#/components/headers/paging-page-number'
X-Paging-TotalPageCount:
$ref: '#/components/headers/paging-total-page-count'
X-Paging-TotalRecordCount:
$ref: '#/components/headers/paging-total-record-count'
content:
application/json:
schema:
$ref: '#/components/schemas/f5471486-3c48-45bc-9b1f-05a7d57bdc71-json-response-schema'
application/xml:
schema:
$ref: '#/components/schemas/f5471486-3c48-45bc-9b1f-05a7d57bdc71-xml-response-schema'
example: 8-DEMOCSH53JPY DEMOSK02US DEMOCH1234 NEW YORK SECURITIES CB JPY FI ACTU YOUR/OUR PAYMENT VALUE OUR/YOUR REPAYMENT VALUE USD BENEFICIARY NAME CITIBANK N.A DEMOSG123456 484 BROKER NAME 1234 2019-08-26 P 6136188.61 6136188.61 6136188.61 CITIBANK N.A 2019-08-26 BONU BONUS ISSUE 123456789 CITIBANK N.A 6136188.61 371889 0.01580556 2019-08-26 00:00:00 0.452071 81338 PARTIALLY PAID 40 DIV 2021-06-09 C-12345678 SGD 1.076 INR 3147 150676.24 G SGD SINGAPORE DOLLAR 836509.21 63099.87 N 124755 130325 PLN 89,74 GOLD STRIP 2019-11-26 00:00:00 TEMPORARY SECURITY 003263100 12 BOND CA CANADA HONG KONG DOLLAR 2041-10-10 00:00:00 242116.38 88 DEMO-1234567 200 DEMOC12345 STANDARD STREET WILMINGTON MAURITIUS AE NEW YORK DEMO ASSET MGMT DEMO12345678 1/WMHHIKPBST 429-433 PINNER ROAD VKTBI POTOMAC,MD LNIXSHUS YDUBTY DEMOGB2LXXX KI BWCPYHTDROAZK CITY XITUN DIST NEW YORK US Payment for services 0000023634 AB1234 BFXCMX4 0.84824716 836509.21 1041002 113911.25 SECURITY SETTLEMENT ADVICE SC 2606.56 HKD 2025-01-30 CITI2L6777USBK44 N BJ18KB6 614442644 T5379P105 JP3049040003 Demo - SK - Japan 2 ON MATURITY WE WILL CREDIT YOUR ACCOUNT CITIBANK, N.A. 3095.25 EUR 2889.12 EUR 2203.13 DARK 2023-12-26 DIV 874 DIVIDEND 0080 2023-04-24 2024-07-03 00:00:00 ISIN JP3783050002 FN BS6982 CASH DIVIDEND , QTY C SGD 15416.98 5516313912 143720728 2 C ON MATURITY WE WILL DEBIT YOUR ACCOUNT 156943580 FN CB4658 HKD ISIN 109.9 13 JE 2023-12-10 00:00:00 Annual 00043 360 / 365 2026-04-22 00001 0.18340964 EQTY EQUITIES 0.4515268 3.0946 2024-05-21 000BMG6KT4 FR QN4224 2024-07-04 2024-08-22 C 15396821 CATX 1068 3355 P 2022-06-30 2022-01-05 0.032757 0059663300 Y ACH PYMT TAX PAYMENT 2024-07-10 2024-11-12 19:30:08 1234567 PAYMENT
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'500':
$ref: '#/components/responses/Internal-Server-Error'
tags:
- Services
operationId: getApiServicesF54714863c4845bc9b1f05a7d57bdc71Filter
x-operation-id-source: derived
servers:
- url: https://sandbox.api.citivelocity.com/markets/dod
description: Sandbox server (uses test data)
- url: https://api.citivelocity.com/markets/dod
description: Production server
/api/services/0687f793-b687-4ac0-9337-e6a0c8445918/filter:
get:
summary: Current Cash Transactions
description: Current Cash Transactions provides the cash transactions for the current business day for each cash account.
parameters:
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/select_2'
- $ref: '#/components/parameters/parameter-13835'
- $ref: '#/components/parameters/parameter-29833'
- $ref: '#/components/parameters/parameter-13837'
- $ref: '#/components/parameters/parameter-13838'
- $ref: '#/components/parameters/parameter-13839'
- $ref: '#/components/parameters/parameter-13842'
- $ref: '#/components/parameters/parameter-28897'
- $ref: '#/components/parameters/parameter-28751'
- $ref: '#/components/parameters/parameter-28808'
- $ref: '#/components/parameters/parameter-28809'
- $ref: '#/components/parameters/parameter-28811'
- $ref: '#/components/parameters/parameter-28812'
- $ref: '#/components/parameters/parameter-28813'
- $ref: '#/components/parameters/parameter-28814'
- $ref: '#/components/parameters/parameter-28752'
- $ref: '#/components/parameters/parameter-28753'
- $ref: '#/components/parameters/parameter-28754'
- $ref: '#/components/parameters/parameter-28898'
- $ref: '#/components/parameters/parameter-28799'
- $ref: '#/components/parameters/parameter-28800'
- $ref: '#/components/parameters/parameter-28801'
- $ref: '#/components/parameters/parameter-28790'
- $ref: '#/components/parameters/parameter-28742'
- $ref: '#/components/parameters/parameter-28743'
- $ref: '#/components/parameters/parameter-28744'
- $ref: '#/components/parameters/parameter-28825'
- $ref: '#/components/parameters/parameter-28826'
- $ref: '#/components/parameters/parameter-28746'
- $ref: '#/components/parameters/parameter-28894'
- $ref: '#/components/parameters/parameter-28821'
- $ref: '#/components/parameters/parameter-28782'
- $ref: '#/components/parameters/parameter-28831'
- $ref: '#/components/parameters/parameter-28727'
- $ref: '#/components/parameters/parameter-28853'
- $ref: '#/components/parameters/parameter-28854'
- $ref: '#/components/parameters/parameter-28728'
- $ref: '#/components/parameters/parameter-28867'
- $ref: '#/components/parameters/parameter-28731'
- $ref: '#/components/parameters/parameter-28855'
- $ref: '#/components/parameters/parameter-28859'
- $ref: '#/components/parameters/parameter-28860'
- $ref: '#/components/parameters/parameter-28861'
- $ref: '#/components/parameters/parameter-28862'
- $ref: '#/components/parameters/parameter-28863'
- $ref: '#/components/parameters/parameter-28864'
- $ref: '#/components/parameters/parameter-28865'
- $ref: '#/components/parameters/parameter-28846'
- $ref: '#/components/parameters/parameter-28847'
- $ref: '#/components/parameters/parameter-28848'
- $ref: '#/components/parameters/parameter-28849'
- $ref: '#/components/parameters/parameter-28850'
- $ref: '#/components/parameters/parameter-28879'
- $ref: '#/components/parameters/parameter-28883'
- $ref: '#/components/parameters/parameter-28889'
- $ref: '#/components/parameters/parameter-28890'
- $ref: '#/components/parameters/parameter-28785'
- $ref: '#/components/parameters/parameter-28786'
- $ref: '#/components/parameters/parameter-28787'
- $ref: '#/components/parameters/parameter-28765'
- $ref: '#/components/parameters/parameter-28768'
- $ref: '#/components/parameters/parameter-28761'
- $ref: '#/components/parameters/parameter-28773'
- $ref: '#/components/parameters/parameter-28775'
- $ref: '#/components/parameters/parameter-28764'
- $ref: '#/components/parameters/parameter-28769'
- $ref: '#/components/parameters/parameter-28770'
- $ref: '#/components/parameters/parameter-28724'
- $ref: '#/components/parameters/parameter-28836'
- $ref: '#/components/parameters/parameter-28844'
- $ref: '#/components/parameters/parameter-28856'
- $ref: '#/components/parameters/parameter-28857'
- $ref: '#/components/parameters/parameter-28858'
- $ref: '#/components/parameters/parameter-28842'
- $ref: '#/components/parameters/parameter-28900'
- $ref: '#/components/parameters/parameter-28736'
- $ref: '#/components/parameters/parameter-28834'
- $ref: '#/components/parameters/parameter-28738'
- $ref: '#/components/parameters/parameter-28819'
- $ref: '#/components/parameters/parameter-28840'
- $ref: '#/components/parameters/parameter-28776'
- $ref: '#/components/parameters/parameter-28845'
- $ref: '#/components/parameters/parameter-13978'
- $ref: '#/components/parameters/parameter-13979'
- $ref: '#/components/parameters/parameter-13980'
- $ref: '#/components/parameters/parameter-13982'
- $ref: '#/components/parameters/parameter-13983'
- $ref: '#/components/parameters/parameter-13984'
- $ref: '#/components/parameters/parameter-13987'
- $ref: '#/components/parameters/parameter-13988'
- $ref: '#/components/parameters/parameter-13989'
- $ref: '#/components/parameters/parameter-13992'
- $ref: '#/components/parameters/parameter-13993'
- $ref: '#/components/parameters/parameter-13994'
- $ref: '#/components/parameters/parameter-13995'
- $ref: '#/components/parameters/parameter-13998'
- $ref: '#/components/parameters/parameter-13999'
- $ref: '#/components/parameters/parameter-14004'
- $ref: '#/components/parameters/parameter-14007'
- $ref: '#/components/parameters/parameter-14008'
- $ref: '#/components/parameters/parameter-14009'
- $ref: '#/components/parameters/parameter-14010'
- $ref: '#/components/parameters/parameter-14011'
- $ref: '#/components/parameters/parameter-14012'
- $ref: '#/components/parameters/parameter-14013'
- $ref: '#/components/parameters/parameter-14014'
- $ref: '#/components/parameters/parameter-14016'
- $ref: '#/components/parameters/parameter-14017'
- $ref: '#/components/parameters/parameter-14019'
- $ref: '#/components/parameters/parameter-14020'
- $ref: '#/components/parameters/parameter-14023'
- $ref: '#/components/parameters/parameter-28771'
- $ref: '#/components/parameters/parameter-28820'
- $ref: '#/components/parameters/parameter-28745'
- $ref: '#/components/parameters/parameter-28747'
- $ref: '#/components/parameters/parameter-28722'
- $ref: '#/components/parameters/parameter-28872'
- $ref: '#/components/parameters/parameter-28723'
- $ref: '#/components/parameters/parameter-28779'
- $ref: '#/components/parameters/parameter-28906'
- $ref: '#/components/parameters/parameter-28749'
- $ref: '#/components/parameters/parameter-28726'
- $ref: '#/components/parameters/parameter-28837'
- $ref: '#/components/parameters/parameter-28886'
- $ref: '#/components/parameters/parameter-28719'
- $ref: '#/components/parameters/parameter-28740'
- $ref: '#/components/parameters/parameter-14049'
- $ref: '#/components/parameters/parameter-14050'
- $ref: '#/components/parameters/parameter-14052'
- $ref: '#/components/parameters/parameter-14053'
- $ref: '#/components/parameters/parameter-28835'
- $ref: '#/components/parameters/parameter-28866'
- $ref: '#/components/parameters/parameter-14060'
- $ref: '#/components/parameters/parameter-14061'
- $ref: '#/components/parameters/parameter-14062'
- $ref: '#/components/parameters/parameter-28902'
- $ref: '#/components/parameters/parameter-28827'
- $ref: '#/components/parameters/parameter-28806'
- $ref: '#/components/parameters/parameter-28833'
- $ref: '#/components/parameters/parameter-28817'
- $ref: '#/components/parameters/parameter-28829'
- $ref: '#/components/parameters/parameter-28777'
- $ref: '#/components/parameters/parameter-28788'
- $ref: '#/components/parameters/parameter-28789'
- $ref: '#/components/parameters/parameter-28818'
- $ref: '#/components/parameters/parameter-28748'
- $ref: '#/components/parameters/parameter-14088'
- $ref: '#/components/parameters/parameter-14090'
- $ref: '#/components/parameters/parameter-28882'
- $ref: '#/components/parameters/parameter-28893'
- $ref: '#/components/parameters/parameter-28804'
- $ref: '#/components/parameters/parameter-28869'
- $ref: '#/components/parameters/parameter-54318'
responses:
'200':
description: Success
headers:
X-DoD-Request-ID:
$ref: '#/components/headers/dod-request-id_2'
X-Paging-PageNumber:
$ref: '#/components/headers/paging-page-number'
X-Paging-TotalPageCount:
$ref: '#/components/headers/paging-total-page-count'
X-Paging-TotalRecordCount:
$ref: '#/components/headers/paging-total-record-count'
content:
application/json:
schema:
$ref: '#/components/schemas/0687f793-b687-4ac0-9337-e6a0c8445918-json-response-schema'
application/xml:
schema:
$ref: '#/components/schemas/0687f793-b687-4ac0-9337-e6a0c8445918-xml-response-schema'
example: 484 DEMOSK02US C CITI Demo - SK - Japan 2 JPY 2019-08-26 15416.98 BENEFICIARY NAME CITIBANK N.A DEMOSG123456 ON MATURITY WE WILL DEBIT YOUR ACCOUNT YOUR/OUR PAYMENT VALUE OUR/YOUR REPAYMENT VALUE 6136188.61 6136188.61 6136188.61 2023-04-2 5516313912 CITIBANK N.A FN BS6982 123456789 6136188.61 371889 1.076 C JP3783050002 150676.24 2024-07-03 00:00:00 DIV DIVIDEND 130325 PLN 89,74 2889.12 SGD HONG KONG DOLLAR 242116.38 88 200 DEMOC12345 NEW YORK DEMO ASSET MGMT DEMO12345678 1/WMHHIKPBST 429-433 PINNER ROAD VKTBI POTOMAC,MD DEMOGB2LXXX KI BWCPYHTDROAZK CITY XITUN DIST NEW YORK US CITI2L6777USBK44 INR 614442644 ON MATURITY WE WILL CREDIT YOUR ACCOUNT CITIBANK, N.A. N EUR 3095.25 EUR 156943580 874 2203.13 DEMOCH1234 0080 836509.21 SECURITY SETTLEMENT ADVICE Payment for services STANDARD STREET WILMINGTON MAURITIUS AE SGD 2019-08-26 113911.25 N 3147 40 ISIN CATX FN CB4658 TEMPORARY SECURITY 003263100 2019-08-26 00:00:00 HKD SGD SINGAPORE DOLLAR 2019-11-26 00:00:00 CA CANADA FI 2041-10-10 00:00:00 AB1234 ISIN BFXCMX4 109.9 DARK 13 JE 2023-12-10 00:00:00 Annual JP3049040003 BJ18KB6 00043 360 / 365 2026-04-22 00001 EQTY EQUITIES 3.0946 CASH DIVIDEND , QTY 2 0.01580556 0.452071 0.84824716 P 1041002 CITIBANK N.A 2023-12-26 836509.21 63099.87 SC HKD 2606.56 124755 T5379P105 NEW YORK SECURITIES CB 12 BOND C-12345678 LNIXSHUS YDUBTY 000BMG6KT4 FR QN4224 2024-07-04 2024-08-22 DEMO-1234567 ACTU G C 15396821 CATX BONU BONUS ISSUE PARTIALLY PAID 81338 2022-01-05 0059663300 Y 2024-10-01 05:30:10 ACH PYMT TAX PAYMENT T135177509
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'500':
$ref: '#/components/responses/Internal-Server-Error'
tags:
- Services
operationId: getApiServices0687f793B6874ac09337E6a0c8445918Filter
x-operation-id-source: derived
servers:
- url: https://sandbox.api.citivelocity.com/markets/dod
description: Sandbox server (uses test data)
- url: https://api.citivelocity.com/markets/dod
description: Production server
/api/services/e31d9564-2523-4b96-8144-1bc9579a7f85/filter:
get:
summary: FX Transaction Data
description: FX trade data from CR which covers both internal and external FX
parameters:
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/select_3'
- $ref: '#/components/parameters/parameter-53531'
- $ref: '#/components/parameters/parameter-53477'
- $ref: '#/components/parameters/parameter-53519'
- $ref: '#/components/parameters/parameter-53475'
- $ref: '#/components/parameters/parameter-53517'
- $ref: '#/components/parameters/parameter-53528'
- $ref: '#/components/parameters/parameter-53529'
- $ref: '#/components/parameters/parameter-53472'
- $ref: '#/components/parameters/parameter-53468'
- $ref: '#/components/parameters/parameter-53492'
- $ref: '#/components/parameters/parameter-53521'
- $ref: '#/components/parameters/parameter-53479'
- $ref: '#/components/parameters/parameter-53494'
- $ref: '#/components/parameters/parameter-53490'
- $ref: '#/components/parameters/parameter-53491'
responses:
'200':
description: Success
headers:
X-DoD-Request-ID:
$ref: '#/components/headers/dod-request-id_3'
X-Paging-PageNumber:
$ref: '#/components/headers/paging-page-number'
X-Paging-TotalPageCount:
$ref: '#/components/headers/paging-total-page-count'
X-Paging-TotalRecordCount:
$ref: '#/components/headers/paging-total-record-count'
content:
application/json:
schema:
$ref: '#/components/schemas/e31d9564-2523-4b96-8144-1bc9579a7f85-json-response-schema'
application/xml:
schema:
$ref: '#/components/schemas/e31d9564-2523-4b96-8144-1bc9579a7f85-xml-response-schema'
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'500':
$ref: '#/components/responses/Internal-Server-Error'
tags:
- Services
operationId: getApiServicesE31d956425234b9681441bc9579a7f85Filter
x-operation-id-source: derived
servers:
- url: https://sandbox.api.citivelocity.com/markets/dod
description: Sandbox server (uses test data)
- url: https://api.citivelocity.com/markets/dod
description: Production server
/api/services/3de83cae-f7b8-4ba6-8f2f-4869ce6284e2/filter:
get:
summary: Daily Settlement Discipline Penalties
description: Daily Penalties Report
parameters:
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/select_4'
- $ref: '#/components/parameters/parameter-53373'
- $ref: '#/components/parameters/parameter-53374'
- $ref: '#/components/parameters/parameter-53375'
- $ref: '#/components/parameters/parameter-53376'
- $ref: '#/components/parameters/parameter-53377'
- $ref: '#/components/parameters/parameter-53378'
- $ref: '#/components/parameters/parameter-53379'
- $ref: '#/components/parameters/parameter-53380'
- $ref: '#/components/parameters/parameter-53381'
- $ref: '#/components/parameters/parameter-53382'
- $ref: '#/components/parameters/parameter-53383'
- $ref: '#/components/parameters/parameter-53384'
- $ref: '#/components/parameters/parameter-53385'
- $ref: '#/components/parameters/parameter-53386'
- $ref: '#/components/parameters/parameter-53387'
- $ref: '#/components/parameters/parameter-53388'
- $ref: '#/components/parameters/parameter-53389'
- $ref: '#/components/parameters/parameter-53390'
- $ref: '#/components/parameters/parameter-53391'
- $ref: '#/components/parameters/parameter-53392'
- $ref: '#/components/parameters/parameter-53393'
- $ref: '#/components/parameters/parameter-53394'
- $ref: '#/components/parameters/parameter-53395'
responses:
'200':
description: Success
headers:
X-DoD-Request-ID:
$ref: '#/components/headers/dod-request-id_4'
X-Paging-PageNumber:
$ref: '#/components/headers/paging-page-number'
X-Paging-TotalPageCount:
$ref: '#/components/headers/paging-total-page-count'
X-Paging-TotalRecordCount:
$ref: '#/components/headers/paging-total-record-count'
content:
application/json:
schema:
$ref: '#/components/schemas/3de83cae-f7b8-4ba6-8f2f-4869ce6284e2-json-response-schema'
application/xml:
schema:
$ref: '#/components/schemas/3de83cae-f7b8-4ba6-8f2f-4869ce6284e2-xml-response-schema'
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'500':
$ref: '#/components/responses/Internal-Server-Error'
tags:
- Services
operationId: getApiServices3de83caeF7b84ba68f2f4869ce6284e2Filter
x-operation-id-source: derived
servers:
- url: https://sandbox.api.citivelocity.com/markets/dod
description: Sandbox server (uses test data)
- url: https://api.citivelocity.com/markets/dod
description: Production server
/api/services/4b1404f9-e30e-434d-aca0-151861edacf1/filter:
get:
summary: Monthly Settlement Discipline Penalties Breakdown
description: Monthly Penalties Breakdown Report
parameters:
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/select_4'
- $ref: '#/components/parameters/parameter-53424'
- $ref: '#/components/parameters/parameter-53425'
- $ref: '#/components/parameters/parameter-53426'
- $ref: '#/components/parameters/parameter-53427'
- $ref: '#/components/parameters/parameter-53428'
- $ref: '#/components/parameters/parameter-53429'
- $ref: '#/components/parameters/parameter-53430'
- $ref: '#/components/parameters/parameter-53431'
- $ref: '#/components/parameters/parameter-53432'
- $ref: '#/components/parameters/parameter-53433'
- $ref: '#/components/parameters/parameter-53434'
- $ref: '#/components/parameters/parameter-53435'
- $ref: '#/components/parameters/parameter-53436'
- $ref: '#/components/parameters/parameter-53437'
- $ref: '#/components/parameters/parameter-53438'
- $ref: '#/components/parameters/parameter-53439'
- $ref: '#/components/parameters/parameter-53440'
- $ref: '#/components/parameters/parameter-53441'
- $ref: '#/components/parameters/parameter-53442'
- $ref: '#/components/parameters/parameter-53443'
- $ref: '#/components/parameters/parameter-53444'
- $ref: '#/components/parameters/parameter-53445'
- $ref: '#/components/parameters/parameter-53446'
- $ref: '#/components/parameters/parameter-53447'
- $ref: '#/components/parameters/parameter-53448'
- $ref: '#/components/parameters/parameter-53449'
- $ref: '#/components/parameters/parameter-53450'
- $ref: '#/components/parameters/parameter-53451'
- $ref: '#/components/parameters/parameter-53452'
- $ref: '#/components/parameters/parameter-53453'
- $ref: '#/components/parameters/parameter-53454'
- $ref: '#/components/parameters/parameter-53455'
- $ref: '#/components/parameters/parameter-53456'
- $ref: '#/components/parameters/parameter-53457'
responses:
'200':
description: Success
headers:
X-DoD-Request-ID:
$ref: '#/components/headers/dod-request-id_4'
X-Paging-PageNumber:
$ref: '#/components/headers/paging-page-number'
X-Paging-TotalPageCount:
$ref: '#/components/headers/paging-total-page-count'
X-Paging-TotalRecordCount:
$ref: '#/components/headers/paging-total-record-count'
content:
application/json:
schema:
$ref: '#/components/schemas/4b1404f9-e30e-434d-aca0-151861edacf1-json-response-schema'
application/xml:
schema:
$ref: '#/components/schemas/4b1404f9-e30e-434d-aca0-151861edacf1-xml-response-schema'
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'500':
$ref: '#/components/responses/Internal-Server-Error'
tags:
- Services
operationId: getApiServices4b1404f9E30e434dAca0151861edacf1Filter
x-operation-id-source: derived
servers:
- url: https://sandbox.api.citivelocity.com/markets/dod
description: Sandbox server (uses test data)
- url: https://api.citivelocity.com/markets/dod
description: Production server
/api/services/56e333ad-6934-4a26-9924-4c74d60397f2/filter:
get:
summary: Account Master
description: All safekeeping and cash accounts are identified here, with attributes such as the Account ID, the account name, the status of the account etc.
parameters:
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/select_5'
- $ref: '#/components/parameters/parameter-36548'
- $ref: '#/components/parameters/parameter-36545'
- $ref: '#/components/parameters/parameter-36544'
- $ref: '#/components/parameters/parameter-36539'
- $ref: '#/components/parameters/parameter-36535'
- $ref: '#/components/parameters/parameter-36533'
- $ref: '#/components/parameters/parameter-36528'
- $ref: '#/components/parameters/parameter-36524'
- $ref: '#/components/parameters/parameter-36522'
- $ref: '#/components/parameters/parameter-36519'
- $ref: '#/components/parameters/parameter-36518'
- $ref: '#/components/parameters/parameter-36505'
- $ref: '#/components/parameters/parameter-36502'
- $ref: '#/components/parameters/parameter-36551'
- $ref: '#/components/parameters/parameter-47704'
responses:
'200':
description: Success
headers:
X-DoD-Request-ID:
$ref: '#/components/headers/dod-request-id_5'
X-Paging-PageNumber:
$ref: '#/components/headers/paging-page-number'
X-Paging-TotalPageCount:
$ref: '#/components/headers/paging-total-page-count'
X-Paging-TotalRecordCount:
$ref: '#/components/headers/paging-total-record-count'
content:
application/json:
schema:
$ref: '#/components/schemas/56e333ad-6934-4a26-9924-4c74d60397f2-json-response-schema'
application/xml:
schema:
$ref: '#/components/schemas/56e333ad-6934-4a26-9924-4c74d60397f2-xml-response-schema'
example: 8-DEMOCSH53JPY C 2025-08-02 DEMOCSH53JPY Demo - Cash - Japan JPY 11 2025-08-02 Open Demo - Cash - Japan JPY 11 JPY CITIBANK JAPAN LTD 1 1000123456
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'500':
$ref: '#/components/responses/Internal-Server-Error'
tags:
- Services
operationId: getApiServices56e333ad69344a2699244c74d60397f2Filter
x-operation-id-source: derived
servers:
- url: https://sandbox.api.citivelocity.com/markets/dod
description: Sandbox server (uses test data)
- url: https://api.citivelocity.com/markets/dod
description: Production server
/api/services/1040640e-125f-41e2-a262-88dea5f338bd/filter:
get:
summary: Security Positions
description: Provides Custody Security positions , market values for a particular date and safekeeping account
parameters:
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/select_6'
- $ref: '#/components/parameters/parameter-19114'
- $ref: '#/components/parameters/parameter-19115'
- $ref: '#/components/parameters/parameter-19116'
- $ref: '#/components/parameters/parameter-19119'
- $ref: '#/components/parameters/parameter-19120'
- $ref: '#/components/parameters/parameter-19121'
- $ref: '#/components/parameters/parameter-19122'
- $ref: '#/components/parameters/parameter-19124'
- $ref: '#/components/parameters/parameter-19126'
- $ref: '#/components/parameters/parameter-19127'
- $ref: '#/components/parameters/parameter-19130'
- $ref: '#/components/parameters/parameter-19133'
- $ref: '#/components/parameters/parameter-19135'
- $ref: '#/components/parameters/parameter-19136'
- $ref: '#/components/parameters/parameter-19137'
- $ref: '#/components/parameters/parameter-19138'
- $ref: '#/components/parameters/parameter-19145'
- $ref: '#/components/parameters/parameter-19151'
- $ref: '#/components/parameters/parameter-19152'
- $ref: '#/components/parameters/parameter-19153'
- $ref: '#/components/parameters/parameter-19154'
- $ref: '#/components/parameters/parameter-19156'
- $ref: '#/components/parameters/parameter-19157'
- $ref: '#/components/parameters/parameter-19160'
- $ref: '#/components/parameters/parameter-19162'
- $ref: '#/components/parameters/parameter-19163'
- $ref: '#/components/parameters/parameter-19164'
- $ref: '#/components/parameters/parameter-19165'
- $ref: '#/components/parameters/parameter-19167'
- $ref: '#/components/parameters/parameter-19168'
- $ref: '#/components/parameters/parameter-19169'
- $ref: '#/components/parameters/parameter-19170'
- $ref: '#/components/parameters/parameter-19174'
- $ref: '#/components/parameters/parameter-19175'
- $ref: '#/components/parameters/parameter-19181'
- $ref: '#/components/parameters/parameter-19182'
- $ref: '#/components/parameters/parameter-19183'
- $ref: '#/components/parameters/parameter-19185'
- $ref: '#/components/parameters/parameter-19186'
- $ref: '#/components/parameters/parameter-19190'
- $ref: '#/components/parameters/parameter-19191'
- $ref: '#/components/parameters/parameter-19192'
- $ref: '#/components/parameters/parameter-19193'
- $ref: '#/components/parameters/parameter-19194'
- $ref: '#/components/parameters/parameter-19195'
- $ref: '#/components/parameters/parameter-19196'
- $ref: '#/components/parameters/parameter-19197'
- $ref: '#/components/parameters/parameter-19198'
- $ref: '#/components/parameters/parameter-19199'
- $ref: '#/components/parameters/parameter-19200'
- $ref: '#/components/parameters/parameter-19201'
- $ref: '#/components/parameters/parameter-19202'
- $ref: '#/components/parameters/parameter-19205'
- $ref: '#/components/parameters/parameter-19206'
- $ref: '#/components/parameters/parameter-19226'
- $ref: '#/components/parameters/parameter-19228'
- $ref: '#/components/parameters/parameter-19229'
- $ref: '#/components/parameters/parameter-19230'
- $ref: '#/components/parameters/parameter-19231'
- $ref: '#/components/parameters/parameter-19235'
- $ref: '#/components/parameters/parameter-19237'
- $ref: '#/components/parameters/parameter-19245'
- $ref: '#/components/parameters/parameter-48549'
- $ref: '#/components/parameters/parameter-48550'
- $ref: '#/components/parameters/parameter-48551'
- $ref: '#/components/parameters/parameter-19247'
- $ref: '#/components/parameters/parameter-19248'
- $ref: '#/components/parameters/parameter-19250'
responses:
'200':
description: Success
headers:
X-DoD-Request-ID:
$ref: '#/components/headers/dod-request-id_6'
X-Paging-PageNumber:
$ref: '#/components/headers/paging-page-number'
X-Paging-TotalPageCount:
$ref: '#/components/headers/paging-total-page-count'
X-Paging-TotalRecordCount:
$ref: '#/components/headers/paging-total-record-count'
content:
application/json:
schema:
$ref: '#/components/schemas/1040640e-125f-41e2-a262-88dea5f338bd-json-response-schema'
application/xml:
schema:
$ref: '#/components/schemas/1040640e-125f-41e2-a262-88dea5f338bd-xml-response-schema'
example: 484 JPY 8-DEMOCSH53JPY 8.9076 138923711.7 EQUITIES FI NEW YORK SECURITIES CB RSA NORTHFIELD LLC 0.01580556 1000012345 2019-08-26 00:00:00 13 HKD JE LE TEMPORARY SECURITY 003263100 35.811 12 BOND CA CANADA 927444.82 VIDACOS NOMINEES LIMITED Annual -34891 353400 AB1234 2019-08-27 00:00:00 0.84824716 POUND STERLING BJ18KB6 T5379P105 CALIFORNIA CA 109.9 DARK 755435 GBP DEMOSK02US Demo - SK - Japan 2 2041-10-10 00:00:00 ISIN BFXCMX JP3049040003 FR QN4224 3.0946 165502 HELD AT DEPOSITORY 6053 2019-12-30 00:00:00 2 C 000BMG6KT4 2019-11-26 00:00:00 EQTY 3544 00001 2023-12-10 00:00:00 0059663300 2024-07-10 123456 12345 2024-11-12 MOSCOW N 2024-11-12 19:30:08
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'500':
$ref: '#/components/responses/Internal-Server-Error'
tags:
- Services
operationId: getApiServices1040640e125f41e2A26288dea5f338bdFilter
x-operation-id-source: derived
servers:
- url: https://sandbox.api.citivelocity.com/markets/dod
description: Sandbox server (uses test data)
- url: https://api.citivelocity.com/markets/dod
description: Production server
/api/services/bbe2a729-c02f-4e5c-8c56-8001d04e5933/filter:
get:
summary: Current Asset Positions
description: Current Asset Positions provides the current settled and traded quantities held for each security in each safekeeping account.
parameters:
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/select_6'
- $ref: '#/components/parameters/parameter-13407'
- $ref: '#/components/parameters/parameter-13497'
- $ref: '#/components/parameters/parameter-29101'
- $ref: '#/components/parameters/parameter-13483'
- $ref: '#/components/parameters/parameter-29079'
- $ref: '#/components/parameters/parameter-13406'
- $ref: '#/components/parameters/parameter-29080'
- $ref: '#/components/parameters/parameter-29115'
- $ref: '#/components/parameters/parameter-13405'
- $ref: '#/components/parameters/parameter-13415'
- $ref: '#/components/parameters/parameter-29095'
- $ref: '#/components/parameters/parameter-29096'
- $ref: '#/components/parameters/parameter-29098'
- $ref: '#/components/parameters/parameter-29120'
- $ref: '#/components/parameters/parameter-29077'
- $ref: '#/components/parameters/parameter-13427'
- $ref: '#/components/parameters/parameter-13428'
- $ref: '#/components/parameters/parameter-13426'
- $ref: '#/components/parameters/parameter-29104'
- $ref: '#/components/parameters/parameter-29118'
- $ref: '#/components/parameters/parameter-13424'
- $ref: '#/components/parameters/parameter-29117'
- $ref: '#/components/parameters/parameter-29094'
- $ref: '#/components/parameters/parameter-13489'
- $ref: '#/components/parameters/parameter-29116'
- $ref: '#/components/parameters/parameter-13412'
- $ref: '#/components/parameters/parameter-13518'
- $ref: '#/components/parameters/parameter-29084'
- $ref: '#/components/parameters/parameter-13517'
- $ref: '#/components/parameters/parameter-13447'
- $ref: '#/components/parameters/parameter-13448'
- $ref: '#/components/parameters/parameter-13484'
- $ref: '#/components/parameters/parameter-29105'
- $ref: '#/components/parameters/parameter-29086'
- $ref: '#/components/parameters/parameter-13485'
- $ref: '#/components/parameters/parameter-13486'
- $ref: '#/components/parameters/parameter-29106'
- $ref: '#/components/parameters/parameter-13520'
- $ref: '#/components/parameters/parameter-13454'
- $ref: '#/components/parameters/parameter-29087'
- $ref: '#/components/parameters/parameter-29088'
- $ref: '#/components/parameters/parameter-13458'
- $ref: '#/components/parameters/parameter-29089'
- $ref: '#/components/parameters/parameter-29076'
- $ref: '#/components/parameters/parameter-13442'
- $ref: '#/components/parameters/parameter-13413'
- $ref: '#/components/parameters/parameter-13515'
- $ref: '#/components/parameters/parameter-13488'
- $ref: '#/components/parameters/parameter-13444'
- $ref: '#/components/parameters/parameter-13445'
- $ref: '#/components/parameters/parameter-29107'
- $ref: '#/components/parameters/parameter-29075'
- $ref: '#/components/parameters/parameter-13466'
- $ref: '#/components/parameters/parameter-13487'
- $ref: '#/components/parameters/parameter-13526'
- $ref: '#/components/parameters/parameter-13465'
- $ref: '#/components/parameters/parameter-13476'
- $ref: '#/components/parameters/parameter-29111'
- $ref: '#/components/parameters/parameter-29112'
- $ref: '#/components/parameters/parameter-29113'
- $ref: '#/components/parameters/parameter-13474'
- $ref: '#/components/parameters/parameter-29073'
- $ref: '#/components/parameters/parameter-13519'
- $ref: '#/components/parameters/parameter-48543'
- $ref: '#/components/parameters/parameter-48544'
- $ref: '#/components/parameters/parameter-48545'
responses:
'200':
description: Success
headers:
X-DoD-Request-ID:
$ref: '#/components/headers/dod-request-id_6'
X-Paging-PageNumber:
$ref: '#/components/headers/paging-page-number'
X-Paging-TotalPageCount:
$ref: '#/components/headers/paging-total-page-count'
X-Paging-TotalRecordCount:
$ref: '#/components/headers/paging-total-record-count'
content:
application/json:
schema:
$ref: '#/components/schemas/bbe2a729-c02f-4e5c-8c56-8001d04e5933-json-response-schema'
application/xml:
schema:
$ref: '#/components/schemas/bbe2a729-c02f-4e5c-8c56-8001d04e5933-xml-response-schema'
example: 8-DEMOCSH53JPY C DEMOSK02US Demo - SK - Japan 2 8.9076 JPY 138923711.7 2019-12-30 00:00:00 484 NEW YORK SECURITIES CB RSA NORTHFIELD LLC JE 2024-07-10 0.01580556 13 HKD 2019-08-26 00:00:00 2 2023-12-10 00:00:00 1000012345 2019-08-27 00:00:00 HELD AT DEPOSITORY 3.0946 2020-06-12 16:01:15 EQUITIES EQTY 35.811 2019-11-26 00:00:00 CA CANADA 2041-10-10 00:00:00 GBP 6053 ISIN BFXCMX MOSCOW 00001 Annual -34891 353400 AB1234 POUND STERLING 0.84824716 TEMPORARY SECURITY 003263100 FI 000BMG6KT4 FR QN4224 12 BOND LE 165502 T5379P105 JP3049040003 0059663300 BJ18KB6 DARK CA CALIFORNIA VIDACOS NOMINEES LIMITED 109.9 755435 3544 123456 12345 2024-11-12
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'500':
$ref: '#/components/responses/Internal-Server-Error'
tags:
- Services
operationId: getApiServicesBbe2a729C02f4e5c8c568001d04e5933Filter
x-operation-id-source: derived
servers:
- url: https://sandbox.api.citivelocity.com/markets/dod
description: Sandbox server (uses test data)
- url: https://api.citivelocity.com/markets/dod
description: Production server
/api/services/27d18376-6358-40f1-9f63-23a72d40196f/filter:
get:
summary: EOD Security Transactions Expanded Dataset
description: Provides Custody Security transactional details and current status for a particular date and safekeeping account with an extended volume of data.
parameters:
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/select_7'
- $ref: '#/components/parameters/parameter-41553'
- $ref: '#/components/parameters/parameter-41554'
- $ref: '#/components/parameters/parameter-41555'
- $ref: '#/components/parameters/parameter-41556'
- $ref: '#/components/parameters/parameter-41557'
- $ref: '#/components/parameters/parameter-41558'
- $ref: '#/components/parameters/parameter-41559'
- $ref: '#/components/parameters/parameter-41562'
- $ref: '#/components/parameters/parameter-41563'
- $ref: '#/components/parameters/parameter-41564'
- $ref: '#/components/parameters/parameter-41565'
- $ref: '#/components/parameters/parameter-41566'
- $ref: '#/components/parameters/parameter-41567'
- $ref: '#/components/parameters/parameter-41568'
- $ref: '#/components/parameters/parameter-41569'
- $ref: '#/components/parameters/parameter-41570'
- $ref: '#/components/parameters/parameter-41571'
- $ref: '#/components/parameters/parameter-41572'
- $ref: '#/components/parameters/parameter-41577'
- $ref: '#/components/parameters/parameter-41578'
- $ref: '#/components/parameters/parameter-41579'
- $ref: '#/components/parameters/parameter-41580'
- $ref: '#/components/parameters/parameter-41581'
- $ref: '#/components/parameters/parameter-41582'
- $ref: '#/components/parameters/parameter-41583'
- $ref: '#/components/parameters/parameter-41584'
- $ref: '#/components/parameters/parameter-41585'
- $ref: '#/components/parameters/parameter-41586'
- $ref: '#/components/parameters/parameter-41587'
- $ref: '#/components/parameters/parameter-41588'
- $ref: '#/components/parameters/parameter-41589'
- $ref: '#/components/parameters/parameter-41590'
- $ref: '#/components/parameters/parameter-41591'
- $ref: '#/components/parameters/parameter-41592'
- $ref: '#/components/parameters/parameter-41593'
- $ref: '#/components/parameters/parameter-41595'
- $ref: '#/components/parameters/parameter-41596'
- $ref: '#/components/parameters/parameter-41597'
- $ref: '#/components/parameters/parameter-41598'
- $ref: '#/components/parameters/parameter-41599'
- $ref: '#/components/parameters/parameter-41600'
- $ref: '#/components/parameters/parameter-41601'
- $ref: '#/components/parameters/parameter-41602'
- $ref: '#/components/parameters/parameter-41603'
- $ref: '#/components/parameters/parameter-41604'
- $ref: '#/components/parameters/parameter-41605'
- $ref: '#/components/parameters/parameter-41606'
- $ref: '#/components/parameters/parameter-41607'
- $ref: '#/components/parameters/parameter-41608'
- $ref: '#/components/parameters/parameter-41609'
- $ref: '#/components/parameters/parameter-41610'
- $ref: '#/components/parameters/parameter-41611'
- $ref: '#/components/parameters/parameter-41612'
- $ref: '#/components/parameters/parameter-41613'
- $ref: '#/components/parameters/parameter-41614'
- $ref: '#/components/parameters/parameter-41615'
- $ref: '#/components/parameters/parameter-41616'
- $ref: '#/components/parameters/parameter-41617'
- $ref: '#/components/parameters/parameter-41618'
- $ref: '#/components/parameters/parameter-41619'
- $ref: '#/components/parameters/parameter-41620'
- $ref: '#/components/parameters/parameter-41621'
- $ref: '#/components/parameters/parameter-41622'
- $ref: '#/components/parameters/parameter-41623'
- $ref: '#/components/parameters/parameter-41624'
- $ref: '#/components/parameters/parameter-41625'
- $ref: '#/components/parameters/parameter-41626'
- $ref: '#/components/parameters/parameter-41627'
- $ref: '#/components/parameters/parameter-41628'
- $ref: '#/components/parameters/parameter-41629'
- $ref: '#/components/parameters/parameter-41561'
- $ref: '#/components/parameters/parameter-41560'
- $ref: '#/components/parameters/parameter-41594'
- $ref: '#/components/parameters/parameter-42176'
- $ref: '#/components/parameters/parameter-42372'
- $ref: '#/components/parameters/parameter-49549'
- $ref: '#/components/parameters/parameter-49550'
- $ref: '#/components/parameters/parameter-49548'
- $ref: '#/components/parameters/parameter-49559'
- $ref: '#/components/parameters/parameter-49560'
- $ref: '#/components/parameters/parameter-55003'
- $ref: '#/components/parameters/parameter-55291'
responses:
'200':
description: Success
headers:
X-DoD-Request-ID:
$ref: '#/components/headers/dod-request-id_7'
X-Paging-PageNumber:
$ref: '#/components/headers/paging-page-number'
X-Paging-TotalPageCount:
$ref: '#/components/headers/paging-total-page-count'
X-Paging-TotalRecordCount:
$ref: '#/components/headers/paging-total-record-count'
content:
application/json:
schema:
$ref: '#/components/schemas/27d18376-6358-40f1-9f63-23a72d40196f-json-response-schema'
application/xml:
schema:
$ref: '#/components/schemas/27d18376-6358-40f1-9f63-23a72d40196f-xml-response-schema'
example: 8-DEMOCSH53JPY DEMOSK02US Demo - SK - US DCC Equity 2025-08-26 484 NEW YORK SECURITIES CB RELA123456 123456 0050 TEST & CO INC 2025-06-17T00:00:00Z US Microsoft Corporation Y 0.975432 OTM987654321 Held At Depot USD 2025-06-15T00:00:00Z 5 Counterparty securities unavailable 2025-05-01T00:00:00Z 2025-06-13 2020-01-15T00:00:00Z US United States 1250000.75 USD US Dollar 2025-04-01 COLL Collateral Management 100123456 2030-12-31T00:00:00Z 2500.00 0901 ISIN US5949181045 TOKYO, JAPAN CITI Bank 021000021 PLDG123456 0.978910 156602418 TEMPORARY SECURITY 003263100 EQTY Y 10000.00 N Microsoft Corporation 12 Bond 7500.00 HD 594918104 US5949181045 2588173 MSFT PEND-LACK Receive Versus Payment CUST987654321 CP001 Goldman Sachs 2025-06-13T10:15:00Z RVP BUY MARKET TRADES 10000.00 DTC 2025-06-17 SETTLED Awaiting counterparty confirmation Y Matched and Settled 2025-06-15 MITI987654321 MATCH123456 MKT654321 2025-06-15T14:45:00Z Settlement completed without exception DEP001 DTC
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'500':
$ref: '#/components/responses/Internal-Server-Error'
tags:
- Services
operationId: getApiServices27d18376635840f19f6323a72d40196fFilter
x-operation-id-source: derived
servers:
- url: https://sandbox.api.citivelocity.com/markets/dod
description: Sandbox server (uses test data)
- url: https://api.citivelocity.com/markets/dod
description: Production server
/api/services/c5da44dd-2c3c-42cc-8125-711c2aadbe4f/filter:
get:
summary: Current Security Transactions Expanded Dataset
description: Current Securities Transactions provides recent transactional activity for each safekeeping account with an extended volume of data.
parameters:
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/select_7'
- $ref: '#/components/parameters/parameter-41729'
- $ref: '#/components/parameters/parameter-41679'
- $ref: '#/components/parameters/parameter-41731'
- $ref: '#/components/parameters/parameter-41680'
- $ref: '#/components/parameters/parameter-41732'
- $ref: '#/components/parameters/parameter-41733'
- $ref: '#/components/parameters/parameter-41681'
- $ref: '#/components/parameters/parameter-41683'
- $ref: '#/components/parameters/parameter-41685'
- $ref: '#/components/parameters/parameter-41686'
- $ref: '#/components/parameters/parameter-41687'
- $ref: '#/components/parameters/parameter-41735'
- $ref: '#/components/parameters/parameter-41688'
- $ref: '#/components/parameters/parameter-41689'
- $ref: '#/components/parameters/parameter-41736'
- $ref: '#/components/parameters/parameter-41690'
- $ref: '#/components/parameters/parameter-41691'
- $ref: '#/components/parameters/parameter-41737'
- $ref: '#/components/parameters/parameter-41692'
- $ref: '#/components/parameters/parameter-41693'
- $ref: '#/components/parameters/parameter-41694'
- $ref: '#/components/parameters/parameter-41738'
- $ref: '#/components/parameters/parameter-41695'
- $ref: '#/components/parameters/parameter-41739'
- $ref: '#/components/parameters/parameter-41740'
- $ref: '#/components/parameters/parameter-41741'
- $ref: '#/components/parameters/parameter-41697'
- $ref: '#/components/parameters/parameter-41698'
- $ref: '#/components/parameters/parameter-41699'
- $ref: '#/components/parameters/parameter-41700'
- $ref: '#/components/parameters/parameter-41701'
- $ref: '#/components/parameters/parameter-41702'
- $ref: '#/components/parameters/parameter-41703'
- $ref: '#/components/parameters/parameter-41742'
- $ref: '#/components/parameters/parameter-41704'
- $ref: '#/components/parameters/parameter-41734'
- $ref: '#/components/parameters/parameter-41743'
- $ref: '#/components/parameters/parameter-41744'
- $ref: '#/components/parameters/parameter-41706'
- $ref: '#/components/parameters/parameter-41707'
- $ref: '#/components/parameters/parameter-41708'
- $ref: '#/components/parameters/parameter-41709'
- $ref: '#/components/parameters/parameter-41745'
- $ref: '#/components/parameters/parameter-41710'
- $ref: '#/components/parameters/parameter-41746'
- $ref: '#/components/parameters/parameter-41747'
- $ref: '#/components/parameters/parameter-41711'
- $ref: '#/components/parameters/parameter-41712'
- $ref: '#/components/parameters/parameter-41713'
- $ref: '#/components/parameters/parameter-41748'
- $ref: '#/components/parameters/parameter-41749'
- $ref: '#/components/parameters/parameter-41750'
- $ref: '#/components/parameters/parameter-41714'
- $ref: '#/components/parameters/parameter-41715'
- $ref: '#/components/parameters/parameter-41751'
- $ref: '#/components/parameters/parameter-41752'
- $ref: '#/components/parameters/parameter-41753'
- $ref: '#/components/parameters/parameter-41754'
- $ref: '#/components/parameters/parameter-41716'
- $ref: '#/components/parameters/parameter-41717'
- $ref: '#/components/parameters/parameter-41718'
- $ref: '#/components/parameters/parameter-41719'
- $ref: '#/components/parameters/parameter-41720'
- $ref: '#/components/parameters/parameter-41721'
- $ref: '#/components/parameters/parameter-41722'
- $ref: '#/components/parameters/parameter-41723'
- $ref: '#/components/parameters/parameter-41724'
- $ref: '#/components/parameters/parameter-41725'
- $ref: '#/components/parameters/parameter-41726'
- $ref: '#/components/parameters/parameter-41727'
- $ref: '#/components/parameters/parameter-41728'
- $ref: '#/components/parameters/parameter-41682'
- $ref: '#/components/parameters/parameter-41705'
- $ref: '#/components/parameters/parameter-42167'
- $ref: '#/components/parameters/parameter-42371'
- $ref: '#/components/parameters/parameter-49542'
- $ref: '#/components/parameters/parameter-49543'
- $ref: '#/components/parameters/parameter-49544'
- $ref: '#/components/parameters/parameter-49563'
- $ref: '#/components/parameters/parameter-49564'
- $ref: '#/components/parameters/parameter-55295'
- $ref: '#/components/parameters/parameter-55414'
- $ref: '#/components/parameters/parameter-55415'
responses:
'200':
description: Success
headers:
X-DoD-Request-ID:
$ref: '#/components/headers/dod-request-id_7'
X-Paging-PageNumber:
$ref: '#/components/headers/paging-page-number'
X-Paging-TotalPageCount:
$ref: '#/components/headers/paging-total-page-count'
X-Paging-TotalRecordCount:
$ref: '#/components/headers/paging-total-record-count'
content:
application/json:
schema:
$ref: '#/components/schemas/c5da44dd-2c3c-42cc-8125-711c2aadbe4f-json-response-schema'
application/xml:
schema:
$ref: '#/components/schemas/c5da44dd-2c3c-42cc-8125-711c2aadbe4f-xml-response-schema'
example: 8-DEMOCSH53JPY DEMOSK02US Demo - SK - US DCC Equity 2024-06-15 484 NEW YORK SECURITIES CB RELA123456 12345678 B Goldman Sachs 2024-06-15T10:30:00Z US Microsoft Corporation Y 0.9875 OTM123456789 Held At Depot USD 5 Insufficient Securities Counterparty has not delivered securities. 2024-06-01T00:00:00Z 2024-06-10 2020-01-01T00:00:00Z US United States 150000.25 USD US Dollar 2024-01-15 COLL Collateral Management LN123456789 2030-12-31T00:00:00Z 2500 0901 ISIN US0378331005 TOKYO, JAPAN Citibank N.A. 021000089 PLG987654321 0.9850 156602418 Apple Inc. Common Stock EQTY Y 10000 N Apple Inc. 12 Bond 7500 HD 037833100 US0378331005 2046251 AAPL 2024-06-15T12:30:45Z MATCH Receive Versus Payment TRX20240615001 CP001 JP Morgan Chase 2024-06-12T14:30:00Z SLS BUY MARKET TRADES 10000 DTC 2024-06-17 SETTLED Y Settled 2024-06-15T15:20:10Z MKT123456789 MITI987654321 MATCH123456 2024-06-15T09:00:00Z Partial settlement due to insufficient position. DTC 7500 250000.75
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'500':
$ref: '#/components/responses/Internal-Server-Error'
tags:
- Services
operationId: getApiServicesC5da44dd2c3c42cc8125711c2aadbe4fFilter
x-operation-id-source: derived
servers:
- url: https://sandbox.api.citivelocity.com/markets/dod
description: Sandbox server (uses test data)
- url: https://api.citivelocity.com/markets/dod
description: Production server
/api/services/ba848120-2d1f-4ec0-9f5c-2aa51b5d1634/filter:
get:
summary: Open Tax Reclaims
description: Open Tax Reclaims provides the full list of tax reclaims which are yet to be paid.
parameters:
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/select_8'
- $ref: '#/components/parameters/parameter-29387'
- $ref: '#/components/parameters/parameter-29368'
- $ref: '#/components/parameters/parameter-29367'
- $ref: '#/components/parameters/parameter-29385'
- $ref: '#/components/parameters/parameter-29363'
- $ref: '#/components/parameters/parameter-29362'
- $ref: '#/components/parameters/parameter-29371'
- $ref: '#/components/parameters/parameter-29395'
- $ref: '#/components/parameters/parameter-29396'
- $ref: '#/components/parameters/parameter-29377'
- $ref: '#/components/parameters/parameter-29373'
- $ref: '#/components/parameters/parameter-29374'
- $ref: '#/components/parameters/parameter-29366'
- $ref: '#/components/parameters/parameter-29398'
- $ref: '#/components/parameters/parameter-29410'
- $ref: '#/components/parameters/parameter-29407'
- $ref: '#/components/parameters/parameter-29415'
- $ref: '#/components/parameters/parameter-29434'
- $ref: '#/components/parameters/parameter-29425'
- $ref: '#/components/parameters/parameter-29402'
- $ref: '#/components/parameters/parameter-29411'
- $ref: '#/components/parameters/parameter-29408'
- $ref: '#/components/parameters/parameter-29416'
- $ref: '#/components/parameters/parameter-29435'
- $ref: '#/components/parameters/parameter-29426'
- $ref: '#/components/parameters/parameter-29403'
- $ref: '#/components/parameters/parameter-29413'
- $ref: '#/components/parameters/parameter-29406'
- $ref: '#/components/parameters/parameter-29414'
- $ref: '#/components/parameters/parameter-29433'
- $ref: '#/components/parameters/parameter-29427'
- $ref: '#/components/parameters/parameter-29401'
- $ref: '#/components/parameters/parameter-29412'
- $ref: '#/components/parameters/parameter-29409'
- $ref: '#/components/parameters/parameter-29417'
- $ref: '#/components/parameters/parameter-29436'
- $ref: '#/components/parameters/parameter-29428'
- $ref: '#/components/parameters/parameter-29404'
- $ref: '#/components/parameters/parameter-29388'
- $ref: '#/components/parameters/parameter-29392'
- $ref: '#/components/parameters/parameter-29381'
- $ref: '#/components/parameters/parameter-29380'
- $ref: '#/components/parameters/parameter-29386'
- $ref: '#/components/parameters/parameter-29382'
- $ref: '#/components/parameters/parameter-29422'
- $ref: '#/components/parameters/parameter-29397'
- $ref: '#/components/parameters/parameter-29400'
- $ref: '#/components/parameters/parameter-29364'
- $ref: '#/components/parameters/parameter-29375'
- $ref: '#/components/parameters/parameter-29390'
- $ref: '#/components/parameters/parameter-29423'
- $ref: '#/components/parameters/parameter-29389'
- $ref: '#/components/parameters/parameter-29394'
- $ref: '#/components/parameters/parameter-29424'
- $ref: '#/components/parameters/parameter-29393'
- $ref: '#/components/parameters/parameter-29378'
- $ref: '#/components/parameters/parameter-29365'
- $ref: '#/components/parameters/parameter-29384'
- $ref: '#/components/parameters/parameter-29376'
- $ref: '#/components/parameters/parameter-29391'
- $ref: '#/components/parameters/parameter-29405'
- $ref: '#/components/parameters/parameter-29429'
- $ref: '#/components/parameters/parameter-29431'
- $ref: '#/components/parameters/parameter-29430'
- $ref: '#/components/parameters/parameter-29432'
- $ref: '#/components/parameters/parameter-29438'
- $ref: '#/components/parameters/parameter-29383'
- $ref: '#/components/parameters/parameter-29418'
- $ref: '#/components/parameters/parameter-29419'
- $ref: '#/components/parameters/parameter-29420'
- $ref: '#/components/parameters/parameter-29421'
- $ref: '#/components/parameters/parameter-14980'
- $ref: '#/components/parameters/parameter-14981'
- $ref: '#/components/parameters/parameter-14982'
- $ref: '#/components/parameters/parameter-14983'
- $ref: '#/components/parameters/parameter-14984'
- $ref: '#/components/parameters/parameter-14985'
- $ref: '#/components/parameters/parameter-14986'
- $ref: '#/components/parameters/parameter-14987'
- $ref: '#/components/parameters/parameter-14988'
- $ref: '#/components/parameters/parameter-14758'
- $ref: '#/components/parameters/parameter-14989'
- $ref: '#/components/parameters/parameter-14990'
- $ref: '#/components/parameters/parameter-14991'
- $ref: '#/components/parameters/parameter-14992'
- $ref: '#/components/parameters/parameter-14996'
- $ref: '#/components/parameters/parameter-14997'
- $ref: '#/components/parameters/parameter-14998'
- $ref: '#/components/parameters/parameter-14999'
- $ref: '#/components/parameters/parameter-15001'
- $ref: '#/components/parameters/parameter-15002'
- $ref: '#/components/parameters/parameter-15004'
- $ref: '#/components/parameters/parameter-15006'
- $ref: '#/components/parameters/parameter-15007'
- $ref: '#/components/parameters/parameter-15008'
- $ref: '#/components/parameters/parameter-15009'
- $ref: '#/components/parameters/parameter-15010'
- $ref: '#/components/parameters/parameter-15011'
- $ref: '#/components/parameters/parameter-15012'
- $ref: '#/components/parameters/parameter-15013'
- $ref: '#/components/parameters/parameter-15014'
- $ref: '#/components/parameters/parameter-15015'
- $ref: '#/components/parameters/parameter-15016'
- $ref: '#/components/parameters/parameter-15017'
- $ref: '#/components/parameters/parameter-15018'
- $ref: '#/components/parameters/parameter-15019'
- $ref: '#/components/parameters/parameter-15020'
- $ref: '#/components/parameters/parameter-15021'
- $ref: '#/components/parameters/parameter-15022'
- $ref: '#/components/parameters/parameter-15023'
- $ref: '#/components/parameters/parameter-15024'
- $ref: '#/components/parameters/parameter-15025'
- $ref: '#/components/parameters/parameter-15026'
- $ref: '#/components/parameters/parameter-15027'
- $ref: '#/components/parameters/parameter-15028'
- $ref: '#/components/parameters/parameter-15029'
- $ref: '#/components/parameters/parameter-15030'
- $ref: '#/components/parameters/parameter-15031'
- $ref: '#/components/parameters/parameter-15032'
- $ref: '#/components/parameters/parameter-15033'
- $ref: '#/components/parameters/parameter-15088'
- $ref: '#/components/parameters/parameter-31457'
responses:
'200':
description: Success
headers:
X-DoD-Request-ID:
$ref: '#/components/headers/dod-request-id_8'
X-Paging-PageNumber:
$ref: '#/components/headers/paging-page-number'
X-Paging-TotalPageCount:
$ref: '#/components/headers/paging-total-page-count'
X-Paging-TotalRecordCount:
$ref: '#/components/headers/paging-total-record-count'
content:
application/json:
schema:
$ref: '#/components/schemas/ba848120-2d1f-4ec0-9f5c-2aa51b5d1634-json-response-schema'
application/xml:
schema:
$ref: '#/components/schemas/ba848120-2d1f-4ec0-9f5c-2aa51b5d1634-xml-response-schema'
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'500':
$ref: '#/components/responses/Internal-Server-Error'
tags:
- Services
operationId: getApiServicesBa8481202d1f4ec09f5c2aa51b5d1634Filter
x-operation-id-source: derived
servers:
- url: https://sandbox.api.citivelocity.com/markets/dod
description: Sandbox server (uses test data)
- url: https://api.citivelocity.com/markets/dod
description: Production server
/api/services/f631ab51-6333-4183-9ef7-144f5fadc9b5/filter:
get:
summary: Closed Tax Reclaims
description: Closed Tax Reclaims provides the full list of tax reclaims which have been paid.
parameters:
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/take'
- $ref: '#/components/parameters/select_8'
- $ref: '#/components/parameters/parameter-29387'
- $ref: '#/components/parameters/parameter-29368'
- $ref: '#/components/parameters/parameter-29367'
- $ref: '#/components/parameters/parameter-29385'
- $ref: '#/components/parameters/parameter-29363'
- $ref: '#/components/parameters/parameter-29362'
- $ref: '#/components/parameters/parameter-29371'
- $ref: '#/components/parameters/parameter-29395'
- $ref: '#/components/parameters/parameter-29396'
- $ref: '#/components/parameters/parameter-29377'
- $ref: '#/components/parameters/parameter-29373'
- $ref: '#/components/parameters/parameter-29374'
- $ref: '#/components/parameters/parameter-29366'
- $ref: '#/components/parameters/parameter-29398'
- $ref: '#/components/parameters/parameter-29410'
- $ref: '#/components/parameters/parameter-29407'
- $ref: '#/components/parameters/parameter-29415'
- $ref: '#/components/parameters/parameter-29434'
- $ref: '#/components/parameters/parameter-29425'
- $ref: '#/components/parameters/parameter-29402'
- $ref: '#/components/parameters/parameter-29411'
- $ref: '#/components/parameters/parameter-29408'
- $ref: '#/components/parameters/parameter-29416'
- $ref: '#/components/parameters/parameter-29435'
- $ref: '#/components/parameters/parameter-29426'
- $ref: '#/components/parameters/parameter-29403'
- $ref: '#/components/parameters/parameter-29413'
- $ref: '#/components/parameters/parameter-29406'
- $ref: '#/components/parameters/parameter-29414'
- $ref: '#/components/parameters/parameter-29433'
- $ref: '#/components/parameters/parameter-29427'
- $ref: '#/components/parameters/parameter-29401'
- $ref: '#/components/parameters/parameter-29412'
- $ref: '#/components/parameters/parameter-29409'
- $ref: '#/components/parameters/parameter-29417'
- $ref: '#/components/parameters/parameter-29436'
- $ref: '#/components/parameters/parameter-29428'
- $ref: '#/components/parameters/parameter-29404'
- $ref: '#/components/parameters/parameter-29388'
- $ref: '#/components/parameters/parameter-29392'
- $ref: '#/components/parameters/parameter-29381'
- $ref: '#/components/parameters/parameter-29380'
- $ref: '#/components/parameters/parameter-29386'
- $ref: '#/components/parameters/parameter-29382'
- $ref: '#/components/parameters/parameter-29422'
- $ref: '#/components/parameters/parameter-29397'
- $ref: '#/components/parameters/parameter-29400'
- $ref: '#/components/parameters/parameter-29364'
- $ref: '#/components/parameters/parameter-29375'
- $ref: '#/components/parameters/parameter-29390'
- $ref: '#/components/parameters/parameter-29423'
- $ref: '#/components/parameters/parameter-29389'
- $ref: '#/components/parameters/parameter-29394'
- $ref: '#/components/parameters/parameter-29424'
- $ref: '#/components/parameters/parameter-29393'
- $ref: '#/components/parameters/parameter-29378'
- $ref: '#/components/parameters/parameter-29365'
- $ref: '#/components/parameters/parameter-29384'
- $ref: '#/components/parameters/parameter-29376'
- $ref: '#/components/parameters/parameter-29391'
- $ref: '#/components/parameters/parameter-29405'
- $ref: '#/components/parameters/parameter-29429'
- $ref: '#/components/parameters/parameter-29431'
- $ref: '#/components/parameters/parameter-29430'
- $ref: '#/components/parameters/parameter-29432'
- $ref: '#/components/parameters/parameter-29438'
- $ref: '#/components/parameters/parameter-29383'
- $ref: '#/components/parameters/parameter-29418'
- $ref: '#/components/parameters/parameter-29419'
- $ref: '#/components/parameters/parameter-29420'
- $ref: '#/components/parameters/parameter-29421'
- $ref: '#/components/parameters/parameter-14980'
- $ref: '#/components/parameters/parameter-14981'
- $ref: '#/components/parameters/parameter-14982'
- $ref: '#/components/parameters/parameter-14983'
- $ref: '#/components/parameters/parameter-14984'
- $ref: '#/components/parameters/parameter-14985'
- $ref: '#/components/parameters/parameter-14986'
- $ref: '#/components/parameters/parameter-14987'
- $ref: '#/components/parameters/parameter-14988'
- $ref: '#/components/parameters/parameter-14758'
- $ref: '#/components/parameters/parameter-14989'
- $ref: '#/components/parameters/parameter-14990'
- $ref: '#/components/parameters/parameter-14991'
- $ref: '#/components/parameters/parameter-14992'
- $ref: '#/components/parameters/parameter-14996'
- $ref: '#/components/parameters/parameter-14997'
- $ref: '#/components/parameters/parameter-14998'
- $ref: '#/components/parameters/parameter-14999'
- $ref: '#/components/parameters/parameter-15001'
- $ref: '#/components/parameters/parameter-15002'
- $ref: '#/components/parameters/parameter-15004'
- $ref: '#/components/parameters/parameter-15006'
- $ref: '#/components/parameters/parameter-15007'
- $ref: '#/components/parameters/parameter-15008'
- $ref: '#/components/parameters/parameter-15009'
- $ref: '#/components/parameters/parameter-15010'
- $ref: '#/components/parameters/parameter-15011'
- $ref: '#/components/parameters/parameter-15012'
- $ref: '#/components/parameters/parameter-15013'
- $ref: '#/components/parameters/parameter-15014'
- $ref: '#/components/parameters/parameter-15015'
- $ref: '#/components/parameters/parameter-15016'
- $ref: '#/components/parameters/parameter-15017'
- $ref: '#/components/parameters/parameter-15018'
- $ref: '#/components/parameters/parameter-15019'
- $ref: '#/components/parameters/parameter-15020'
- $ref: '#/components/parameters/parameter-15021'
- $ref: '#/components/parameters/parameter-15022'
- $ref: '#/components/parameters/parameter-15023'
- $ref: '#/components/parameters/parameter-15024'
- $ref: '#/components/parameters/parameter-15025'
- $ref: '#/components/parameters/parameter-15026'
- $ref: '#/components/parameters/parameter-15027'
- $ref: '#/components/parameters/parameter-15028'
- $ref: '#/components/parameters/parameter-15029'
- $ref: '#/components/parameters/parameter-15030'
- $ref: '#/components/parameters/parameter-15031'
- $ref: '#/components/parameters/parameter-15032'
- $ref: '#/components/parameters/parameter-15033'
- $ref: '#/components/parameters/parameter-15088'
- $ref: '#/components/parameters/parameter-31457'
responses:
'200':
description: Success
headers:
X-DoD-Request-ID:
$ref: '#/components/headers/dod-request-id_8'
X-Paging-PageNumber:
$ref: '#/components/headers/paging-page-number'
X-Paging-TotalPageCount:
$ref: '#/components/headers/paging-total-page-count'
X-Paging-TotalRecordCount:
$ref: '#/components/headers/paging-total-record-count'
content:
application/json:
schema:
$ref: '#/components/schemas/f631ab51-6333-4183-9ef7-144f5fadc9b5-json-response-schema'
application/xml:
schema:
$ref: '#/components/schemas/f631ab51-6333-4183-9ef7-144f5fadc9b5-xml-response-schema'
'400':
$ref: '#/components/responses/Bad-Request'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/Not-Found'
'405':
$ref: '#/components/responses/Method-Not-Allowed'
'415':
$ref: '#/components/responses/Unsupported-Media-Type'
'500':
$ref: '#/components/responses/Internal-Server-Error'
tags:
- Services
operationId: getApiServicesF631ab51633341839ef7144f5fadc9b5Filter
x-operation-id-source: derived
servers:
- url: https://sandbox.api.citivelocity.com/markets/dod
description: Sandbox server (uses test data)
- url: https://api.citivelocity.com/markets/dod
description: Production server
components:
examples:
Method-Not-Allowed-Example:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
errorDetails:
- issue: Method not supported
action: please use valid http verb
code: CC00001
Not-Found-Example:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
errorDetails:
- issue: Resource that you are searching is not found
action: Please use valid resource details
code: CC00006
Unauthorized-Example:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
errorDetails:
- issue: You not authorized for this functionality
action: please use valid credentials to access this functionality
code: CC00007
Unsupported-Media-Type-Example:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
errorDetails:
- issue: Media type not supported
action: please use valid content-type in header
code: CC00002
Bad-Request-Example:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
errorDetails:
- issue: path-param servicePortableId is mandatory and it cannot be empty
action: please provide valid parameter values
code: VC00010
Internal-Server-Error-Example:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
errorDetails:
- issue: unable to serve your request at this moment
action: Please refer to documentation provided or contact support team
code: CC00004
Unauthorized-Example_2:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
errorDetails:
- issue: User not authorized for this functionality
action: please use valid credentials to access this functionality
code: CC00007
Unauthorized-Example_3:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
errorDetails:
- issue: User not authorized for this functionality
action: please use valid credentials to access this functionality
code: CC00007
Unauthorized-Example_4:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
errorDetails:
- issue: User not authorized for this functionality
action: please use valid credentials to access this functionality
code: CC00007
Unauthorized-Example_5:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
errorDetails:
- issue: User not authorized for this functionality
action: please use valid credentials to access this functionality
code: CC00007
Unauthorized-Example_6:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
errorDetails:
- issue: User not authorized for this functionality
action: please use valid credentials to access this functionality
code: CC00007
Unauthorized-Example_7:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
errorDetails:
- issue: User not authorized for this functionality
action: please use valid credentials to access this functionality
code: CC00007
Unauthorized-Example_8:
value:
ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
errorDetails:
- issue: User not authorized for this functionality
action: please use valid credentials to access this functionality
code: CC00007
parameters:
parameter-13535:
name: ACCT_BASE_NBR
description: Account Base Number is an internal Citi client identifier that is associated to a safekeeping or cash account.
in: query
required: false
schema:
type: string
parameter-28700:
name: BR_ID
description: Branch Code is the identifier of the branch for the account. For the cash account the branch code is a numeric value and for the safekeeping account it is the ISO Country code.
in: query
required: false
schema:
type: string
skip:
name: skip
in: query
description: The number of records to skip before returning the results
required: false
schema:
type: integer
format: int32
minimum: 0
default: 0
parameter-13574:
name: ACCT_STS_TYP
description: Account status provides the current status of the cash account and/or the safekeeping account. Values are:
Open
Closed
Frozen
in: query
required: false
schema:
type: string
parameter-28699:
name: BAL_STS_TYP
description: Cash Balance Type will be Posted for all cash accounts except for US Direct cash accounts where the balance type can be either Posted or Sweep.
in: query
required: false
schema:
type: string
parameter-18804:
name: BR_ID
description: Branch Code is the identifier of the branch for the account. For the cash account the branch code is a numeric value and for the safekeeping account it is the ISO Country code.
in: query
required: false
schema:
type: string
parameter-18824:
name: OPNG_BAL
description: Opening balance is the opening ledger balance (previous days closing balance) for the cash account. Ledger Balance includes all posted transactions including future value dated transactions.
in: query
required: false
schema:
type: number
format: double
parameter-13572:
name: CASH_TYPE
description: Cash Type Code pertains to US Direct cash accounts and indicates whether the cash account has a split income and principal balance.
in: query
required: false
schema:
type: number
format: double
parameter-28709:
name: ASOF_TMS
description: The As Of Date is the date of the information being reported.
in: query
required: false
schema:
type: string
format: date-time
select:
name: $select
in: query
description: The `$select` parameter in an API allows you to specify which data parameters (properties or columns) you want to receive in the API response. This helps improve efficiency by reducing the amount of data transferred and simplifying client-side processing.
required: false
schema:
type: string
parameter-18815:
name: EOD_INTRA_IND
description: EOD/intraday Indicator advises if the balance is an end-of-day reported balance or if the balance is an Intraday reported balance. Values are:
- 1 (Intraday)
- 2 (End of Day)
in: query
required: false
schema:
type: string
take:
name: take
in: query
description: The maximum number of records to return
required: false
schema:
type: integer
format: int32
minimum: 1
default: 5000
parameter-18833:
name: IOD_TIMESTAMP
description: Provides the Timestamp when data is loaded in the Data Lake
in: query
required: false
schema:
type: string
format: date-time
client_id:
description: Your unique ID. This is the same as the ID you used for OAuth token generation. Citi shared this ID with you during your Data On Demand API onboarding
name: client_id
in: header
required: true
schema:
type: string
parameter-18787:
name: ACCT_BUS_TYP_CD
description: Account Type Code indicates the type of the account. Values are:
- C (cash account)
- S (Safekeeping Account).
in: query
required: false
schema:
type: string
parameter-13544:
name: GFC_ID
description: Client ID is an identifier that is available on a cash account and/or a safekeeping account. This Client ID is referred to, internally at Citi, as a GFCID.
in: query
required: false
schema:
type: string
parameter-28710:
name: IOD_UPDATE_TMS
description: IOD Timestamp
in: query
required: false
schema:
type: string
format: date-time
parameter-18800:
name: ASOF_TMS
description: The As Of Date is the date of the information being reported.
in: query
required: false
schema:
type: string
format: date-time
parameter-28711:
name: COB_DATE
description: Close of Business Date
in: query
required: false
schema:
type: string
format: date
parameter-18826:
name: PRNCPL_INC_IND
description: Principal / Income Indicator advises if the balance is for principal or income. Values include:
P (Principal)
I (Income)
in: query
required: false
schema:
type: string
parameter-18805:
name: BR_NME
description: Branch Name is the name of the branch for the cash account and/or safekeeping account.
in: query
required: false
schema:
type: string
parameter-18818:
name: LED_BAL
description: Ledger Balance is the balance for the cash account that includes all posted transactions including future value dated transactions.
in: query
required: false
schema:
type: number
format: double
parameter-28707:
name: LST_ENTRY_TMS
description: Balance change date displays the date of the last change to the balance based on transactions that have been posted to the cash account.
in: query
required: false
schema:
type: string
format: date-time
parameter-18803:
name: BAL_STS_TYP
description: Cash Balance Type will be Posted for all cash accounts except for US Direct cash accounts where the balance type can be either Posted or Sweep.
in: query
required: false
schema:
type: string
parameter-18816:
name: GFC_ID
description: Client ID is an identifier that is available on a cash account and/or a safekeeping account. This Client ID is referred to, internally at Citi, as a GFCID.
in: query
required: false
schema:
type: string
parameter-28704:
name: LCL_CUR_CD
description: Currency code is the ISO currency code for the amount.
in: query
required: false
schema:
type: string
parameter-18806:
name: CASH_TYPE
description: Cash Type Code pertains to US Direct cash accounts and indicates whether the cash account has a split income and principal balance.
in: query
required: false
schema:
type: number
format: double
parameter-18813:
name: COB_DATE
description: Close of Business Date
in: query
required: false
schema:
type: string
format: date
parameter-28705:
name: PRNCPL_INC_IND
description: Principal / Income Indicator advises if the balance is for principal or income. Values include:
P (Principal)
I (Income)
in: query
required: false
schema:
type: string
parameter-18796:
name: ACCT_STS_TYP
description: 'Account status provides the current status of the cash account and/or the safekeeping account. Values are:
- Open
- Closed
- Frozen'
in: query
required: false
schema:
type: string
parameter-18829:
name: ROLLED_FWD
description: Rolled Forward indicator parameter is used to flag if position valuation has been rolled forward from last close of business.
in: query
required: false
schema:
type: string
parameter-13539:
name: ALTV_CUR_CD
description: Account Base Currency Code is the ISO Currency Code for the account.
in: query
required: false
schema:
type: string
parameter-18820:
name: LST_ENTRY_TMS
description: Balance change date displays the date of the last change to the balance based on transactions that have been posted to the cash account.
in: query
required: false
schema:
type: string
format: date-time
parameter-18821:
name: LST_UPD_TMS
description: Balance Update Timestamp displays the date/time of the last update to the balance due to transactions that have posted to the cash account (Intraday) or due to reporting database updates (end-of-day).
in: query
required: false
schema:
type: string
format: date-time
parameter-18788:
name: ACCT_BUS_TYP_NME
description: Account type description indicates the type of the account. Values are:
- CASH (C)
- S/K (S)
in: query
required: false
schema:
type: string
parameter-18791:
name: ACCT_ID
description: Account ID is an identifier for both a cash account and/or a safekeeping account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-28698:
name: TRANS_REF_NBR
description: Custodian Reference is the unique reference assigned by the custodian to the record. The reference number is unique within a branch.
in: query
required: false
schema:
type: string
parameter-28694:
name: LED_BAL
description: Ledger Balance is the balance for the cash account that includes all posted transactions including future value dated transactions.
in: query
required: false
schema:
type: number
format: double
parameter-28693:
name: OPNG_BAL
description: Opening balance is the opening ledger balance (previous days closing balance) for the cash account. Ledger Balance includes all posted transactions including future value dated transactions.
in: query
required: false
schema:
type: number
format: double
parameter-28708:
name: LST_UPD_TMS
description: Balance Update Timestamp displays the date/time of the last update to the balance due to transactions that have posted to the cash account (Intraday) or due to reporting database updates (end-of-day).
in: query
required: false
schema:
type: string
format: date-time
parameter-28696:
name: AVAL_BAL
description: Available Balance is the cash account balance for all posted transactions, except for future value dated transactions.
in: query
required: false
schema:
type: number
format: double
parameter-18793:
name: ACCT_NME
description: Account Name is the name that is assigned to the cash account and/or the safekeeping account. If an alternate account name has been specified for an account it will be displayed as the Account Name.
in: query
required: false
schema:
type: string
parameter-18785:
name: ACCT_BASE_NBR
description: Account Base Number is an internal Citi client identifier that is associated to a safekeeping or cash account.
in: query
required: false
schema:
type: string
parameter-13562:
name: ACCT_BUS_TYP_CD
description: Account Type Code indicates the type of the account. Values are:
C (cash account)
S (Safekeeping Account).
in: query
required: false
schema:
type: string
parameter-42407:
name: HEAD_ACCOUNT
description: SCAR Head Account Number
in: query
required: false
schema:
type: string
parameter-18799:
name: ALTV_CUR_CD
description: Account Base Currency Code is the ISO Currency Code for the account.
in: query
required: false
schema:
type: string
parameter-18817:
name: LCL_CUR_CD
description: Currency code is the ISO currency code for the amount.
in: query
required: false
schema:
type: string
parameter-13536:
name: ACCT_BUS_TYP_NME
description: Account type description indicates the type of the account. Values are:
CASH (C)
S/K (S)
in: query
required: false
schema:
type: string
parameter-18802:
name: AVAL_BAL
description: Available Balance is the cash account balance for all posted transactions, except for future value dated transactions.
in: query
required: false
schema:
type: number
format: double
parameter-13553:
name: ACCT_NME
description: Account Name is the name that is assigned to the cash account and/or the safekeeping account. If an alternate account name has been specified for an account it will be displayed as the Account Name.
in: query
required: false
schema:
type: string
parameter-28701:
name: EOD_INTRA_IND
description: EOD/intraday Indicator advises if the information is as of end-of-day or as of Intraday. Values are:
- 1 (Intraday)
- 2 (End of Day)
in: query
required: false
schema:
type: string
parameter-28702:
name: ACCT_ID
description: Account ID is an identifier for both a cash account and/or a safekeeping account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-13554:
name: BR_NME
description: Branch Name is the name of the branch for the cash account and/or safekeeping account.
in: query
required: false
schema:
type: string
parameter-18832:
name: TRANS_REF_NBR
description: Custodian Reference is the unique reference assigned by the custodian to the record. The reference number is unique within a branch.
in: query
required: false
schema:
type: string
parameter-13980:
name: DNOMD_CUR_CD
description: Denomination Currency Code is the ISO currency code in which the security is denominated, in the local market.
in: query
required: false
schema:
type: string
parameter-18843:
name: BR_NME
description: Branch Name is the name of the branch for the cash account and/or safekeeping account.
in: query
required: false
schema:
type: string
parameter-28790:
name: CORR_BNK_ACCT_NBR
description: The Corresponding Bank Account Number is the account established by a banking institution to receive deposits from, make payments on behalf of, or handle other financial transactions for another financial institution.
in: query
required: false
schema:
type: string
parameter-19059:
name: CNTRY_CD
description: The Country Code (location) of the security custodian. Not applicable to the US domestic positions.
in: query
required: false
schema:
type: string
parameter-28835:
name: FED_REF_NBR
description: The FED/CHIPS Reference Number is a unique number that is assigned by the Federal Reserve Bank (FED) or the Clearing House Interbank Payments System (CHIPS) for the transaction.
in: query
required: false
schema:
type: string
parameter-28860:
name: ORD_BANK_NME
description: Ordering Bank Name is the name of the institution that has been authorized to act on the payment of funds.
in: query
required: false
schema:
type: string
parameter-28817:
name: CA_INCM_IND
description: 'The CA/Income Indicator advises if the cash transaction is related to corporate actions or income. Values are: C for Corporate Action, I for Income.'
in: query
required: false
schema:
type: string
parameter-28850:
name: ORIG_BANK_ADR_LNE4
description: Originating Bank Address Line 4 is the fourth line of (4 of 4) address for the Originating Bank
in: query
required: false
schema:
type: string
parameter-19014:
name: US_TAX_CD
description: US Tax Codes indicates the US tax code that is applicable to the transaction.
in: query
required: false
schema:
type: string
parameter-18921:
name: ISS_CLF_NME
description: Issue Classification Name is a description for the Issue Classification Code parameter. This is for US ASTRA only and values include Stripped, UIT, Sealed-Envlp, etc.
in: query
required: false
schema:
type: string
parameter-19008:
name: TRN_CL_CD
description: 'Transaction Class is the transaction type code for securities transactions. Values include: ADJ (Adjustment), BIDS, BOE, BUY, CAPD, CAPG, CAPGL, DF (Deliver Free), DIV (Dividend), DRAW, DRIP, DVCA, etc.'
in: query
required: false
schema:
type: string
parameter-28804:
name: CASH_TRANS_TYPE
description: Cash Transaction Type
in: query
required: false
schema:
type: string
parameter-28754:
name: CASH_NET_AMT
description: Cash Net Amount is the signed amount that will be credited or debited from the cash account.
in: query
required: false
schema:
type: number
format: double
parameter-18935:
name: NET_DIV
description: The Net Dividend is the net amount of the transaction.
in: query
required: false
schema:
type: number
format: double
parameter-18965:
name: PMT_DTL_DESC
description: Payment Details provides descriptive information regarding the transaction.
in: query
required: false
schema:
type: string
parameter-18906:
name: GROSS_NET_IND
description: The Gross/Net is an indicator that advises if the amount for the transaction is Gross or Net. Values include G (Gross), N (Net) and (null).
in: query
required: false
schema:
type: string
parameter-18959:
name: ORIG_BANK_ACCT_NO
description: The Originating Bank Account Number is the account at the originating bank from which the transfer originated.
in: query
required: false
schema:
type: string
parameter-19094:
name: TRN_CL_CD_CA
description: Transaction Class Code (CA) is the transaction type code for corporate action transactions. The parameter values are CATX and (null).
in: query
required: false
schema:
type: string
parameter-14049:
name: SID_CUSIP
description: CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.
in: query
required: false
schema:
type: string
parameter-19002:
name: TAX_DEDD_IND
description: Tax Deducted Indicator advises if taxes have been deducted.
in: query
required: false
schema:
type: string
parameter-19056:
name: DLAY_DAYS
description: Delay Days is the number of days from the issuance of an MBS pool (or from the beginning of the interest accrual period) until the first payment is remitted/paid to the holders.
in: query
required: false
schema:
type: string
parameter-14023:
name: INCM_PROJN_RATE
description: Interest Rate is the coupon rate of the security.
in: query
required: false
schema:
type: number
format: double
parameter-18891:
name: ENTLMT_QTY
description: Entitlement Quantity is the associated security holding quantity on which the entitlement has been calculated.
in: query
required: false
schema:
type: number
format: double
parameter-13994:
name: PFD_ID_CTXT_CD
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID parameter. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
in: query
required: false
schema:
type: string
parameter-28826:
name: DEAL_ID
description: 'Security Code is the Contract # or Security Number.'
in: query
required: false
schema:
type: string
parameter-28883:
name: SALE_CUR_CD
description: The FX Sale Currency is the ISO Currency Code for the currency that is being sold as part of the foreign exchange transaction.
in: query
required: false
schema:
type: string
parameter-28906:
name: TRD_EXCUTD_EF_DT
description: Trade Date is the date a transaction is effected or executed.
in: query
required: false
schema:
type: string
format: date
parameter-18926:
name: SEC_SUB_TYP_NME
description: 'Issue Type is a description of the type of the security instrument. Values include: ADR Convertible (1), Bond (12) , Bond Convertible (19), etc.'
in: query
required: false
schema:
type: string
parameter-18928:
name: ISSR_LOC_CD
description: 'Issuer Location Code is the ISO country code where the issuer of the security is based. Values include: AR (Argentina), CA (Canada), IE (Ireland), etc.'
in: query
required: false
schema:
type: string
parameter-18971:
name: PREV_FCTR
description: The factor which applies for the previous accrual period to determine payments and balances for principal paying securities. Currently applicable to the US intraday cash transactions.
in: query
required: false
schema:
type: number
format: double
parameter-19062:
name: FCTR_DTE
description: Factor Date is the date the current factor is applicable from for principal paying securities.
in: query
required: false
schema:
type: string
format: date-time
parameter-28831:
name: INT_PMT_COND
description: Interest Payment Conditions provides details for income transactions.
in: query
required: false
schema:
type: string
parameter-14007:
name: CNTRY_CD
description: The Country Code (location) of the security custodian. Not applicable to the US domestic positions.
in: query
required: false
schema:
type: string
parameter-13835:
name: BR_ID
description: Branch Code is the identifier of the branch for the account. For the cash account the branch code is a numeric value and for the safekeeping account it is the ISO Country code.
in: query
required: false
schema:
type: string
parameter-18846:
name: SEC_GROUP
description: 'Asset Type is a code representing the Asset Type of the security. Values include: EQTY (Equity), FI (Fixed Income), etc.'
in: query
required: false
schema:
type: string
parameter-18883:
name: TRAD_BRKR_NME
description: Counterparty is the other party to the trade. The person or entity (e.g. institution, agent, broker) with whom a transaction is conducted).
in: query
required: false
schema:
type: string
parameter-28821:
name: EVENT_CLAS_CD
description: 'Event Class are codes that identify the type of Income transaction. Values include: BOT, DELD, DIV (Dividend), INT (Interest), MBSD, PAID, RECD, SOLD, TSFD, (null).'
in: query
required: false
schema:
type: string
parameter-19113:
name: IOD_TIMESTAMP
description: Provides the Timestamp when data is loaded in the Data Lake
in: query
required: false
schema:
type: string
format: date-time
parameter-18942:
name: ONE_DAY_FLO
description: One Day Float is the time period between when a deposit is made and when funds become available in an account.
in: query
required: false
schema:
type: number
format: double
parameter-18998:
name: TAX_EXT_AMT
description: Tax Amount is the tax amount of the transaction.
in: query
required: false
schema:
type: number
format: double
parameter-28856:
name: ORD_BANK_ADR_LNE_1
description: Ordering Bank Address1 is the first line of (1 of 4) address for the Ordering Bank
in: query
required: false
schema:
type: string
parameter-19070:
name: ISS_CATG_CD
description: 'Issue Category Code is a specific category for the security. Values include: CSTK (Common Stock), DERIV (Derivatives), MBS (Mortgage Backed Securities), etc.'
in: query
required: false
schema:
type: string
parameter-18993:
name: SOLD_REMIT_INSTRS
description: Sold Remit Instruction is text that describes the sell activity for the transaction.
in: query
required: false
schema:
type: string
parameter-28773:
name: TRANS_REF_NBR
description: Custodian Reference is the unique reference assigned by the Custodian to the record. The reference number is unique within a branch.
in: query
required: false
schema:
type: string
parameter-18892:
name: ENTLMT_STS_NME
description: 'Entitlements Status is a description of the current processing status of the entitlement. Values include: Pending, Fully Released, Fully Paid, Partially Released, Partially Paid, Pending Payment, Pending, Reversal, Rev, To Be Received, (null), etc.'
in: query
required: false
schema:
type: string
parameter-19107:
name: CASH_TRANS_TYPE
description: A cash transaction type is a business transaction that is settled with immediate exchange of cash.
in: query
required: false
schema:
type: string
parameter-19064:
name: ACRL_BASIS_CDE
description: 'Accrual Basis Code is a code linked to the Accrual Basis parameter which indicates the basis on which interest accruals are calculated. Values include: 00043 (360 / 365), 00011 (360 / 360), 00063 (30 / 360 Non-EOM), etc.'
in: query
required: false
schema:
type: string
parameter-18878:
name: CONTR_PYBL_DT
description: Contractual Settlement Date is the date when the clients cash account should be credited with funds on a sale (and debited on a purchase) on the due settlement date in place of when a trade actually settles in the market.
in: query
required: false
schema:
type: string
format: date
parameter-18986:
name: SID_SEDOL
description: SEDOL (Stock Exchange Daily Official List) is a unique identification code, consisting of seven alphanumeric characters, that is assigned to all securities trading on the London Stock Exchange.
in: query
required: false
schema:
type: string
parameter-18911:
name: LCL_INCM_ERND
description: The Income Earned - Local is the signed income amount in local currency.
in: query
required: false
schema:
type: number
format: double
parameter-28869:
name: MKT_TRANS_TYPE
description: Market Transaction Type
in: query
required: false
schema:
type: string
parameter-19099:
name: EX_DATE
description: Ex Date (Dupe) is the trading cut off date after which position changes will no longer alter the eligibility to the corporate action.
in: query
required: false
schema:
type: string
format: date
parameter-19001:
name: TAX_LCL_CUR_CD
description: Tax Amount Local Currency (Currency) is the ISO Currency Code for the market tax amount.
in: query
required: false
schema:
type: string
parameter-18880:
name: CORP_ACTN_TYP
description: 'Corporate Action Type are codes that identify the type of corporation action transaction. Values include: BIDS (BID/REVERSE RIGHTS), CSHDIV (CASH DIVIDEND), INTR (INTEREST PAYMENT), STDIV (STOCK DIVIDEND), etc.'
in: query
required: false
schema:
type: string
parameter-13987:
name: ISSR_LOC_CD
description: 'Issuer Location Code is the ISO country code where the issuer of the security is based. Values include: AR (Argentina), CA (Canada), IE (Ireland), etc.'
in: query
required: false
schema:
type: string
parameter-14012:
name: SID_SEDOL
description: SEDOL (Stock Exchange Daily Official List) is a unique identification code, consisting of seven alphanumeric characters, that is assigned to all securities trading on the London Stock Exchange.
in: query
required: false
schema:
type: string
parameter-18945:
name: ORD_BANK_ADR_LNE_2
description: Ordering Bank Address2 is the second line of (2 of 4) address for the Ordering Bank
in: query
required: false
schema:
type: string
parameter-28747:
name: DIV_RATE
description: The Dividend Rate is the total expected dividend payments for an investment on an annualized basis
in: query
required: false
schema:
type: number
format: double
parameter-14004:
name: DLAY_DAYS
description: Delay Days is the number of days from the issuance of an MBS pool (or from the beginning of the interest accrual period) until the first payment is remitted/paid to the holders.
in: query
required: false
schema:
type: string
parameter-19108:
name: MKT_TRANS_TYPE
description: Financial Market Transaction Type indicates the type of trade conducted by the Financial Institution. * Domain * Buy Sell Borrow Lend Swap Transfer Exchange.
in: query
required: false
schema:
type: string
parameter-28837:
name: PRDCT_TYP
description: 'Product Type is a 2-digit high level description for the cash transaction Values include: DE (Data Entry), FX (Foreign Exchange Movement), FT (Funds Transfer), MM (Money Market Movement ), SC (Security Settlement Advice), (null).'
in: query
required: false
schema:
type: string
parameter-19067:
name: NXT_PAY_DT
description: Next Payable Date is the next date on which a dividend or interest payment is scheduled to be paid.
in: query
required: false
schema:
type: string
format: date
parameter-28787:
name: TAX_DEDD_IND
description: Tax Deducted Indicator advises if taxes have been deducted.
in: query
required: false
schema:
type: string
parameter-18894:
name: EVENT_CLAS_CD
description: 'Event Class are codes that identify the type of Income transaction. Values include: BOT, DELD, DIV (Dividend), INT (Interest), MBSD, PAID, RECD, SOLD, TSFD, (null).'
in: query
required: false
schema:
type: string
parameter-28775:
name: TRN_CD
description: Transaction Code is the specific type of transaction.
in: query
required: false
schema:
type: string
parameter-28800:
name: CMPNY_DESC
description: Company Description contains information regarding the company which issued the security.
in: query
required: false
schema:
type: string
parameter-19007:
name: TRD_EXCUTD_EF_DT
description: Trade Date is the date a transaction is effected or executed.
in: query
required: false
schema:
type: string
format: date
parameter-19095:
name: CLIENT_ID_1
description: Client ID 1
in: query
required: false
schema:
type: string
parameter-28859:
name: ORD_BANK_ADR_LNE_4
description: Ordering Bank Address4 is the fourth line of (4 of 4) address for the Ordering Bank
in: query
required: false
schema:
type: string
parameter-28724:
name: PRNCSH_CMB_AMT
description: Principal Cash is the consideration amount. On the Buy side, it is comprised of the broker commission + tax + security fee. On the Sell side, it is comprised of the broker commission - tax - security fee.
in: query
required: false
schema:
type: number
format: double
parameter-18850:
name: BNKCUST_REPMT_COND
description: Bank/Customer Repayment Conditions are the terms and conditions for payment services for financial institutions.
in: query
required: false
schema:
type: string
parameter-28765:
name: TAX_EXT_AMT
description: Tax Amount is the tax amount of the transaction.
in: query
required: false
schema:
type: number
format: double
parameter-18925:
name: SEC_SUB_TYP_CD
description: 'Issue Type Code is a code linked to the Issue Type parameter which describes the type of security instrument. Values include: 1 (ADR Convertible), 12 (Bond), 19 (Bond Convertible), etc.'
in: query
required: false
schema:
type: string
parameter-18915:
name: INT_PMT_COND
description: Interest Payment Conditions provides details for income transactions.
in: query
required: false
schema:
type: string
parameter-13992:
name: MATY_DT
description: Maturity Date is the date of maturity or redemption for fixed income securities.
in: query
required: false
schema:
type: string
format: date-time
parameter-28748:
name: ENTLMT_QTY
description: Entitlement Quantity is the associated security holding quantity on which the entitlement has been calculated.
in: query
required: false
schema:
type: number
format: double
parameter-18999:
name: TAX_AMT_CUR_CD
description: Tax Amount Currency is the ISO Currency Code for the tax amount.
in: query
required: false
schema:
type: string
parameter-19093:
name: INTRNL_REF_ID_CA
description: Custodian Reference (CA) is the unique reference assigned by the Custodian to the record. The reference number is unique within a branch.
in: query
required: false
schema:
type: string
parameter-18985:
name: SUB_DIVSN_ID
description: 'Reversal Indicator (FX) notes whether or not the transaction was processed to reverse an earlier transaction. Values include: N, R, Y, (null)'
in: query
required: false
schema:
type: string
parameter-19043:
name: TRANS_REF_NBR
description: Custodian Reference is the unique reference assigned by the Custodian to the record. The reference number is unique within a branch.
in: query
required: false
schema:
type: string
parameter-19018:
name: CASH_VAL_DT
description: Value Date is the date on which the cash posting corresponding to this trade will have value.
in: query
required: false
schema:
type: string
format: date
parameter-19019:
name: EV_CREATED_TMS
description: Created Timestamp is the date and time of when an item was loaded to the source system.
in: query
required: false
schema:
type: string
format: date-time
parameter-19085:
name: SEC_SHRT_NME
description: Issue Name is the Security Name of the security instrument.
in: query
required: false
schema:
type: string
parameter-18912:
name: INCM_IND
description: Income Indicator. Values include Y (Yes for Income), N (No for Income) and (null). This parameter pertains to US domestic only.
in: query
required: false
schema:
type: string
parameter-28848:
name: ORIG_BANK_ADR_LNE2
description: Originating Bank Address Line 2 is the second line of (2 of 4) address for the Originating Bank
in: query
required: false
schema:
type: string
parameter-28819:
name: ENTRY_ID
description: Entry ID is the two-digit National Codification Bureau (NCB) code
in: query
required: false
schema:
type: string
parameter-28746:
name: DIV_AMT
description: Gross Income is the gross amount received for an income transaction.
in: query
required: false
schema:
type: number
format: double
parameter-18972:
name: PRNCSH_CMB_AMT
description: Principal Cash is the consideration amount. On the Buy side, it is comprised of the broker commission + tax + security fee. On the Sell side, it is comprised of the broker commission - tax - security fee.
in: query
required: false
schema:
type: number
format: double
parameter-28761:
name: THREE_DAY_FLO
description: Three Day Float is the time period between when a deposit is made and when funds become available in an account.
in: query
required: false
schema:
type: number
format: double
parameter-18941:
name: DEAL_REF_NBR
description: OTM Reference is the Order and Trade Manager Reference number that has been assigned to the order instructions.
in: query
required: false
schema:
type: string
parameter-28844:
name: PMT_DTL_DESC
description: Payment Details provides descriptive information regarding the transaction.
in: query
required: false
schema:
type: string
parameter-28719:
name: RCEV_DIV_AMT
description: Received Dividend Amount is the dividend amount of the transaction.
in: query
required: false
schema:
type: number
format: double
parameter-18988:
name: SID_CUSIP
description: CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.
in: query
required: false
schema:
type: string
parameter-28902:
name: ACT_SETT_DT
description: Actual Settlement Date is the date of final settlement of the trade.
in: query
required: false
schema:
type: string
format: date
parameter-18929:
name: ISSR_LOC_NME
description: 'Issuer Location is the name of the country where the issuer of the security is based. Values include: Argentina (AR), Canada (CA), Ireland (IE), etc.'
in: query
required: false
schema:
type: string
parameter-19053:
name: STRK_PRC_AMT
description: Strike Price is the specified price on an options contract at which the contract may be exercised.
in: query
required: false
schema:
type: number
format: double
parameter-18861:
name: PRIN_INC_IND
description: 'Principal / Income Indicator advises if the balance is for Principal or Income. Values include: P (Principal) or I (Income).'
in: query
required: false
schema:
type: string
parameter-19000:
name: LOC_CUR_TAX_AMT
description: Tax Amount Local Currency Amount is the market tax amount of the transaction.
in: query
required: false
schema:
type: number
format: double
select_2:
name: $select
in: query
description: The `$select` parameter in an API allows users to specify which data parameters (properties or columns) they want to receive in the API response. This helps improve efficiency by reducing the amount of data transferred and simplifying client-side processing.
required: false
schema:
type: string
parameter-18839:
name: ACCT_BASE_NBR
description: Account Base Number is an internal Citi client identifier that is associated to a Safekeeping or cash account.
in: query
required: false
schema:
type: string
parameter-18901:
name: SALE_CUR_CD
description: The FX Sale Currency is the ISO 4217 Currency Code for the currency that is being sold as part of the foreign exchange transaction.
in: query
required: false
schema:
type: string
parameter-18933:
name: MATY_DT
description: Maturity Date is the date of maturity or redemption for fixed income securities.
in: query
required: false
schema:
type: string
format: date-time
parameter-18913:
name: INCM_QTY
description: Income Quantity is the number of shares/units for the income payment or the entitlement shares or face amount for income payments.
in: query
required: false
schema:
type: number
format: double
parameter-19024:
name: DB_CR_IND
description: Credit/Debit Indicator shows whether the cash posting associated to the corporate action will be a credit (C) or a debit (D).
in: query
required: false
schema:
type: string
parameter-19025:
name: LCL_CUR_CD
description: The CCY Code is the ISO Currency Code in which the cash will be credited and/or debited.
in: query
required: false
schema:
type: string
parameter-18962:
name: ORIG_BANK_ADR_LNE3
description: Originating Bank Address Line 3 is the third line of (3 of 4) address for the Originating Bank
in: query
required: false
schema:
type: string
parameter-29833:
name: ACCT_ID
description: Account ID is an identifier for both a cash account and/or a safekeeping account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-28788:
name: CORP_ACTN_TYP
description: 'Corporate Action Type are codes that identify the type of corporation action transaction. Values include: BIDS (BID/REVERSE RIGHTS), CSHDIV (CASH DIVIDEND), INTR (INTEREST PAYMENT), STDIV (STOCK DIVIDEND), etc.'
in: query
required: false
schema:
type: string
parameter-28834:
name: INCM_IND
description: Income Indicator. Values include Y (Yes for Income), N (No for Income) and (null). This parameter pertains to US domestic only.
in: query
required: false
schema:
type: string
parameter-19021:
name: DEAL_ID
description: 'Security Code is the Contract # or Security Number.'
in: query
required: false
schema:
type: string
parameter-28728:
name: NET_DIV
description: The Net Dividend is the net amount of the transaction.
in: query
required: false
schema:
type: number
format: double
parameter-19069:
name: PREV_FCTR_RATE
description: Previous Factor (Old) is the factor which applies to the last accrual period to determine payments and balances for principal paying securities.
in: query
required: false
schema:
type: number
format: double
parameter-28726:
name: LCL_INCM_ERND
description: The Income Earned - Local is the signed income amount in local currency.
in: query
required: false
schema:
type: number
format: double
parameter-19009:
name: TRN_CD
description: Transaction Code is the specific type of transaction.
in: query
required: false
schema:
type: string
parameter-28845:
name: POST_SEC_DESC
description: Posting Description is the first line of the descriptive information regarding the transaction.
in: query
required: false
schema:
type: string
parameter-13838:
name: ACCT_BUS_ID
description: Account Business Identifier is a business line identifier for the account.
in: query
required: false
schema:
type: string
parameter-18842:
name: ULTM_BENEF_ACCT
description: Ultimate Beneficiary Account is the account number of the Ultimate Beneficiary.
in: query
required: false
schema:
type: string
parameter-18939:
name: NOMINEE_CD
description: The Nominee Code provides the two-digit nominee code value for the transaction. This parameter pertains to US domestic only.
in: query
required: false
schema:
type: string
parameter-28786:
name: TAX_AMT_CUR_CD
description: Tax Amount Currency is the ISO Currency Code for the tax amount.
in: query
required: false
schema:
type: string
parameter-28799:
name: CLNT_REF_NBR
description: Custodian Reference is the unique reference assigned by the Custodian to the record. The reference number is unique within a branch.
in: query
required: false
schema:
type: string
parameter-19010:
name: TRANS_CATG_NME
description: 'Transaction Category is used in the US Cash Balance Summary report. Values include: CORPORATE ACTIONS DDA DDASEC DF DP INCOME MATURITIES MISCELLANEOUS RF RP Only applicable to the US cash transactions.'
in: query
required: false
schema:
type: string
parameter-28865:
name: ORD_PTY_ADR_LNE_4
description: Ordering Party Address4 is the fourth line of (4 of 4) address for the Ordering Party
in: query
required: false
schema:
type: string
parameter-13839:
name: ACCT_NME
description: Account Name is the name that is assigned to the cash account and/or the safekeeping account. If an alternate account name has been specified for an account it will be displayed as the Account Name.
in: query
required: false
schema:
type: string
parameter-28770:
name: US_TAX_CD
description: US Tax Codes indicates the US tax code that is applicable to the transaction.
in: query
required: false
schema:
type: string
parameter-28872:
name: PRIN_INC_IND
description: 'Principal / Income Indicator advises if the balance is for Principal or Income. Values include: P (Principal) or I (Income).'
in: query
required: false
schema:
type: string
parameter-28731:
name: ONE_DAY_FLO
description: One Day Float is the time period between when a deposit is made and when funds become available in an account.
in: query
required: false
schema:
type: number
format: double
parameter-13999:
name: SID_TICKER_SYMB
description: Ticker is the symbol used on the exchange to identify the security.
in: query
required: false
schema:
type: string
parameter-28862:
name: ORD_PTY_ADR_LNE_1
description: Ordering Party Address1 is the first line of (1 of 4) address for the Ordering Party
in: query
required: false
schema:
type: string
parameter-19086:
name: LST_BUSCLS_DT
description: The date for which End of Day data was last received for the account.
in: query
required: false
schema:
type: string
format: date
parameter-18981:
name: REC_DT
description: Record Date is the date established by the issuer of a security for the purpose of determining the holders who are entitled to receive a dividend or distribution or is the cut off date to determine which holders of the security are eligible.
in: query
required: false
schema:
type: string
format: date
parameter-19005:
name: SID_TICKER_SYMB
description: Ticker is the symbol used on the exchange to identify the security.
in: query
required: false
schema:
type: string
parameter-18905:
name: DIV_AMT
description: Gross Income is the gross amount received for an income transaction.
in: query
required: false
schema:
type: number
format: double
parameter-19039:
name: BGHT_REMIT_INSTRS
description: Bought Remit Instruction is text that describes the buy activity for the transaction.
in: query
required: false
schema:
type: string
parameter-18900:
name: CUR_CVN_RATE
description: FX Rate - Local is a foreign exchange rate applied for converting the local currency into the base currency. The rate is effective as of the trade date of the transaction.
in: query
required: false
schema:
type: number
format: double
parameter-19068:
name: PMT_FREQY
description: 'Payment Frequency indicates how often interest is paid on the security. Values include: 00001 (Annual), 00002 (Sem-Annual), 00035 (One Payment Per Year), etc.'
in: query
required: false
schema:
type: string
parameter-18858:
name: BRKR_NME
description: Transaction Broker Name.
in: query
required: false
schema:
type: string
parameter-18852:
name: BENEF
description: The Beneficiary is the recipient (payee) of the funds.
in: query
required: false
schema:
type: string
parameter-19051:
name: PFD_ID_CTXT_CD
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID parameter. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
in: query
required: false
schema:
type: string
parameter-18975:
name: PRDCT_NME
description: 'Product Name is a high level description for the cash transaction Values include: Data Entry (DE), Foreign Exchange Movement (FX), Funds Transfer (FT), Money Market Movement (MM), Security Settlement Advice (SC), (null).'
in: query
required: false
schema:
type: string
parameter-13842:
name: ALTV_CUR_CD
description: Account Base Currency Code is the ISO Currency Code for the account.
in: query
required: false
schema:
type: string
parameter-18949:
name: ORD_PTY_ACCT_NO
description: Ordering Party Account Number is the account number of the instructing party that has authorized the payment of funds.
in: query
required: false
schema:
type: string
parameter-28813:
name: BNK_CUST_PMT_COND
description: Bank/Customer Payment Conditions are the terms and conditions for payment services for financial institutions.
in: query
required: false
schema:
type: string
parameter-13982:
name: INCM_CUR_CD
description: Income Currency Code is the ISO currency code in which income payments will be made for the security in the local market.
in: query
required: false
schema:
type: string
parameter-28742:
name: CUM_AMRT_AMT
description: Cumulative Amortization Amount is the amount for fixed income securities. This parameter pertains to US domestic only.
in: query
required: false
schema:
type: number
format: double
parameter-28863:
name: ORD_PTY_ADR_LNE_2
description: Ordering Party Address2 is the second line of (2 of 4) address for the Ordering Party
in: query
required: false
schema:
type: string
parameter-28768:
name: TAX_LCL_CUR_CD
description: Tax Amount Local Currency (Currency) is the ISO Currency Code for the market tax amount.
in: query
required: false
schema:
type: string
parameter-14052:
name: SEC_SUB_TYP_CD
description: 'Issue Type Code is a code linked to the Issue Type parameter which describes the type of security instrument. Values include: 1 (ADR Convertible), 12 (Bond), 19 (Bond Convertible), etc.'
in: query
required: false
schema:
type: string
parameter-28846:
name: ORIG_BANK_ACCT_NO
description: The Originating Bank Account Number is the account at the originating bank from which the transfer originated.
in: query
required: false
schema:
type: string
parameter-18974:
name: PRCD_CMB_AMT
description: Proceeds - Local is the amount, in the market currency, for a sale and/or loan transaction.
in: query
required: false
schema:
type: number
format: double
parameter-28854:
name: LCL_CUR_NME
description: Local Currency Name is the description for the ISO currency code.
in: query
required: false
schema:
type: string
parameter-28820:
name: EOD_INTRA_IND
description: 'EOD/intraday Indicator advises if the balance is an End of Day reported balance or if the balance is an Intraday reported balance. Values are: 1 (Intraday) 2 (End of Day)'
in: query
required: false
schema:
type: string
parameter-28809:
name: BENEF_BNK
description: The Beneficiary Bank is the bank where the beneficiary has the account.
in: query
required: false
schema:
type: string
parameter-13979:
name: DTED_TMS
description: Dated Date/Time is the date that the interest begins to accrue on a fixed-income security.
in: query
required: false
schema:
type: string
format: date-time
parameter-28764:
name: TXWHLD_CMB_AMT
description: Tax Withheld is the amount of money that has been held back for tax purposes.
in: query
required: false
schema:
type: number
format: double
parameter-28743:
name: CUM_QTY
description: Cumulative Quantity is the units for fixed income securities. This parameter pertains to US domestic only.
in: query
required: false
schema:
type: number
format: double
parameter-28836:
name: PRDCT_NME
description: 'Product Name is a high level description for the cash transaction Values include: Data Entry (DE), Foreign Exchange Movement (FX), Funds Transfer (FT), Money Market Movement (MM), Security Settlement Advice (SC), (null).'
in: query
required: false
schema:
type: string
parameter-28811:
name: BENEF_REF
description: Beneficiary Reference is a transaction level reference at the beneficiary bank side.
in: query
required: false
schema:
type: string
parameter-14020:
name: ISS_CAT_NME
description: 'Issue Category is the description for the Issue Category Code. Values include: Common Stock (CSTK), Derivatives (DERIV), Mortgage Backed Securities (MBS), etc.'
in: query
required: false
schema:
type: string
parameter-18908:
name: INCM_CUR_CD
description: Income Currency Code is the ISO currency code in which income payments will be made for the security in the local market.
in: query
required: false
schema:
type: string
parameter-14017:
name: PMT_FREQY
description: 'Payment Frequency indicates how often interest is paid on the security. Values include: 00001 (Annual), 00002 (Sem-Annual), 00035 (One Payment Per Year), etc.'
in: query
required: false
schema:
type: string
parameter-18990:
name: ACCT_NME
description: Account Name is the name that is assigned to the cash account and/or the safekeeping account. If an alternate account name has been specified for an account it will be displayed as the Account Name.
in: query
required: false
schema:
type: string
parameter-28776:
name: TRN_CL_CD
description: 'Transaction Class is the transaction type code for securities transactions. Values include: ADJ (Adjustment), BIDS, BOE, BUY, CAPD, CAPG, CAPGL, DF (Deliver Free), DIV (Dividend), DRAW, DRIP, DVCA, etc.'
in: query
required: false
schema:
type: string
parameter-28771:
name: TRANS_DESC
description: A one-line text description of this cash flow activity.
in: query
required: false
schema:
type: string
parameter-18944:
name: ORD_BANK_ADR_LNE_1
description: Ordering Bank Address1 is the first line of (1 of 4) address for the Ordering Bank
in: query
required: false
schema:
type: string
parameter-19072:
name: CURR_FCTR_RATE
description: Current Factor (Old) is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
in: query
required: false
schema:
type: number
format: double
parameter-19075:
name: INCM_PROJN_RATE
description: Interest Rate is the coupon rate of the security.
in: query
required: false
schema:
type: number
format: double
parameter-19022:
name: CMPNY_NME
description: Company Name is the name of the company which issued the security.
in: query
required: false
schema:
type: string
parameter-28749:
name: BASE_INCM_ERND
description: The Income Earned - Base is the signed income amount in the account base currency.
in: query
required: false
schema:
type: number
format: double
parameter-28842:
name: PCH_CUR_CD
description: The FX Purchase Currency is the ISO Currency Code for the currency that is being purchased as part of the foreign exchange transaction.
in: query
required: false
schema:
type: string
parameter-28744:
name: CUR_CVN_RATE
description: FX Rate - Local is a foreign exchange rate applied for converting the local currency into the base currency. The rate is effective as of the trade date of the transaction.
in: query
required: false
schema:
type: number
format: double
parameter-28840:
name: PREF_SEC_ID_TP
description: 'Security Type identifies the Security ID. Values include: CUSIP, ISIN, SEDOL, etc.'
in: query
required: false
schema:
type: string
parameter-19047:
name: DNOMD_CUR_CD
description: Denomination Currency Code is the ISO currency code in which the security is denominated, in the local market.
in: query
required: false
schema:
type: string
parameter-18946:
name: ORD_BANK_ADR_LNE_3
description: Ordering Bank Address3 is the third line of (3 of 4) address for the Ordering Bank
in: query
required: false
schema:
type: string
parameter-28858:
name: ORD_BANK_ADR_LNE_3
description: Ordering Bank Address3 is the third line of (3 of 4) address for the Ordering Bank
in: query
required: false
schema:
type: string
parameter-28777:
name: TRN_CL_CD_CA
description: Transaction Class Code (CA) is the transaction type code for corporate action transactions. The parameter values are CATX and (null).
in: query
required: false
schema:
type: string
parameter-18976:
name: PRDCT_TYP
description: 'Product Type is a 2-digit high level description for the cash transaction Values include: DE (Data Entry), FX (Foreign Exchange Movement), FT (Funds Transfer), MM (Money Market Movement ), SC (Security Settlement Advice), (null).'
in: query
required: false
schema:
type: string
parameter-14053:
name: SEC_SUB_TYP_NME
description: 'Issue Type is a description of the type of the security instrument. Values include: ADR Convertible (1), Bond (12) , Bond Convertible (19), etc.'
in: query
required: false
schema:
type: string
parameter-28879:
name: RELD_REF
description: Related Reference as provided on a SWIFT message.
in: query
required: false
schema:
type: string
parameter-18886:
name: CUM_AMRT_AMT
description: Cumulative Amortization Amount is the amount for fixed income securities. This parameter pertains to US domestic only.
in: query
required: false
schema:
type: number
format: double
parameter-28722:
name: PREV_FCTR
description: The factor which applies for the previous accrual period to determine payments and balances for principal paying securities. Currently applicable to the US intraday cash transactions.
in: query
required: false
schema:
type: number
format: double
parameter-28827:
name: DEAL_REF_NBR
description: OTM Reference is the Order and Trade Manager Reference number that has been assigned to the order instructions.
in: query
required: false
schema:
type: string
parameter-14061:
name: SEC_SHRT_NME
description: Issue Name is the Security Name of the security instrument.
in: query
required: false
schema:
type: string
parameter-19023:
name: TRANS_DESC
description: A one-line text description of this cash flow activity.
in: query
required: false
schema:
type: string
parameter-18910:
name: BASE_INCM_ERND
description: The Income Earned - Base is the signed income amount in the account base currency.
in: query
required: false
schema:
type: number
format: double
parameter-28740:
name: INCM_QTY
description: Income Quantity is the number of shares/units for the income payment.
in: query
required: false
schema:
type: number
format: double
parameter-28867:
name: NOMINEE_CD
description: The Nominee Code provides the two-digit nominee code value for the transaction. This parameter pertains to US domestic only.
in: query
required: false
schema:
type: string
parameter-14060:
name: SEC_SECURITY_CD
description: CITI Internal Security Code is the identifier of the CITI Internal Security Identifier.
in: query
required: false
schema:
type: string
parameter-28812:
name: BGHT_REMIT_INSTRS
description: Bought Remit Instruction is text that describes the buy activity for the transaction.
in: query
required: false
schema:
type: string
parameter-28785:
name: SUB_DIVSN_ID
description: 'Reversal Indicator (FX) notes whether or not the transaction was processed to reverse an earlier transaction. Values include: N, R, Y, (null)'
in: query
required: false
schema:
type: string
parameter-18864:
name: CASH_NET_AMT
description: Cash Net Amount is the signed amount that will be credited or debited from the cash account.
in: query
required: false
schema:
type: number
format: double
parameter-18889:
name: DTED_TMS
description: Dated Date/Time is the date that the interest begins to accrue on a fixed-income security.
in: query
required: false
schema:
type: string
format: date-time
parameter-18922:
name: ISS_TMS
description: Issue Date is the date of first issue of the security.
in: query
required: false
schema:
type: string
format: date-time
parameter-18963:
name: ORIG_BANK_ADR_LNE4
description: Originating Bank Address Line 4 is the fourth line of (4 of 4) address for the Originating Bank
in: query
required: false
schema:
type: string
parameter-18856:
name: BR_ID
description: Branch Code is the identifier of the branch for the account. For the cash account the branch code is a numeric value and for the safekeeping account it is the ISO Country code.
in: query
required: false
schema:
type: string
parameter-28889:
name: SK_ACCT_ID
description: The safekeeping account ID is an identifier for a safekeeping account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-28894:
name: EV_CREATED_TMS
description: The date when the transaction was loaded into the source system.
in: query
required: false
schema:
type: string
format: date-time
parameter-19100:
name: PAY_DATE
description: Payable Date is the date on which a dividend or interest payment is scheduled to be paid.
in: query
required: false
schema:
type: string
format: date
parameter-28727:
name: LOC_CUR_TAX_AMT
description: Current Tax Amount (Local) is the market tax amount of the transaction.
in: query
required: false
schema:
type: number
format: double
parameter-19101:
name: PAY_RATE
description: This is a security Master parameter, it relates to the rate paid for the most recent Corporate Action. But It's only populated for US domestic securities (from ASTRA).
in: query
required: false
schema:
type: number
format: double
parameter-28806:
name: ASRD_INCM_IND
description: The Assured Income Indicator advises whether an income payment is assured (to be paid on the anticipated payment date) or actual (to be paid when funds are actually received). The values are ASRD (assured) and ACTU (actual).
in: query
required: false
schema:
type: string
parameter-18951:
name: ORD_PTY_ADR_LNE_2
description: Ordering Party Address2 is the second line of (2 of 4) address for the Ordering Party
in: query
required: false
schema:
type: string
parameter-14011:
name: SID_ISIN
description: ISIN (International Securities Identification Number) is a 12-character alpha-numerical code that does not contain information characterizing financial instruments but serves for uniform identification of a security at trading and settlement.
in: query
required: false
schema:
type: string
parameter-14088:
name: PAY_DATE
description: Payable Date is the date on which a dividend or interest payment is scheduled to be paid.
in: query
required: false
schema:
type: string
format: date
parameter-18983:
name: RELD_REF
description: Related Reference as provided on a SWIFT message.
in: query
required: false
schema:
type: string
parameter-14016:
name: NXT_PAY_DT
description: Next Payable Date is the next date on which a dividend or interest payment is scheduled to be paid.
in: query
required: false
schema:
type: string
format: date
parameter-18863:
name: CASH_DB_AMT
description: Cash Debit is the amount on the debit transaction
in: query
required: false
schema:
type: number
format: double
parameter-14013:
name: ACRL_BASIS_CDE
description: 'Accrual Basis Code is a code linked to the Accrual Basis parameter which indicates the basis on which interest accruals are calculated. Values include: 00043 (360 / 365), 00011 (360 / 360), 00063 (30 / 360 Non-EOM), etc.'
in: query
required: false
schema:
type: string
parameter-14014:
name: ACRL_BASIS_NME
description: Accrual Basis Description is the basis on which interest accrual is calculated, e.g. 30/360 meaning nominal 30 day months and a 360 day year.
in: query
required: false
schema:
type: string
parameter-13984:
name: ISS_TMS
description: Issue Date is the date of first issue of the security.
in: query
required: false
schema:
type: string
format: date-time
parameter-18953:
name: ORD_PTY_ADR_LNE_4
description: Ordering Party Address4 is the fourth line of (4 of 4) address for the Ordering Party
in: query
required: false
schema:
type: string
parameter-19028:
name: INTRNL_REF_ID
description: Custodian Reference (internal) is the unique reference assigned by the Custodian to the record. The reference number is unique within a branch.
in: query
required: false
schema:
type: string
parameter-28853:
name: LCL_CUR_CD
description: Currency code is the ISO currency code for the amount.
in: query
required: false
schema:
type: string
parameter-14050:
name: BR_NME
description: Branch Name is the name of the branch for the cash account and/or safekeeping account.
in: query
required: false
schema:
type: string
parameter-28738:
name: FACE_QTY
description: Face Value is the original face value for Mortgage Backed Securities in the US domestic market. For other MBS positions this will be the current face value after amortization.
in: query
required: false
schema:
type: number
format: double
parameter-19065:
name: ACRL_BASIS_NME
description: Accrual Basis Description is the basis on which interest accrual is calculated, e.g. 30/360 meaning nominal 30 day months and a 360 day year.
in: query
required: false
schema:
type: string
parameter-18931:
name: LCL_CUR_NME
description: Local Currency Name is the description for the ISO currency code or it is the name of the local currency of the Settlement Amount.
in: query
required: false
schema:
type: string
parameter-14090:
name: SID_LOCAL
description: Local ID is the Local security identifier of the associated security.
in: query
required: false
schema:
type: string
parameter-19096:
name: CLIENT_ID_2
description: Client ID 2
in: query
required: false
schema:
type: string
parameter-13998:
name: STRK_PRC_AMT
description: Strike Price is the specified price on an options contract at which the contract may be exercised.
in: query
required: false
schema:
type: number
format: double
parameter-14010:
name: PMT_FREQY_DESC
description: 'Payment Frequency Description indicates how often interest is paid on the security. Values include: Annual (00001), Sem-Annual (00002), One Payment Per Year (00035), etc.'
in: query
required: false
schema:
type: string
parameter-19045:
name: POST_SEC_DESC
description: Posting Description is the first line of the descriptive information regarding the transaction.
in: query
required: false
schema:
type: string
parameter-28801:
name: CMPNY_NME
description: Company Name is the name of the company which issued the security.
in: query
required: false
schema:
type: string
parameter-18938:
name: NOMINEE
description: 'Nominee: role played by a Legal entity established solely for the purpose of registration of record ownership of securities. A custodian typically registers customer securities in a nominee name for ease of handling subsequent transfers or denomination changes, interest and dividend collections and other corporate actions.'
in: query
required: false
schema:
type: number
format: double
parameter-28751:
name: AMT
description: Amount is the Cash Transaction amount that will be credited or debited from the cash account.
in: query
required: false
schema:
type: number
format: double
parameter-18943:
name: ORD_BANK_ACCT_NO
description: Ordering Bank Account Number is the account for the amount of money used to derive the financial instrument to be bought or sold.
in: query
required: false
schema:
type: string
parameter-18897:
name: FED_REF_NBR
description: The FED/CHIPS Reference Number is a unique number that is assigned by the Federal Reserve Bank (FED) or the Clearing House Interbank Payments System (CHIPS) for the transaction.
in: query
required: false
schema:
type: string
parameter-18888:
name: CURR_FCTR
description: Current Factor is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
in: query
required: false
schema:
type: number
format: double
parameter-14062:
name: LST_BUSCLS_DT
description: The date for which End of Day data was last received for the account.
in: query
required: false
schema:
type: string
format: date
parameter-19063:
name: PMT_FREQY_DESC
description: 'Payment Frequency Description indicates how often interest is paid on the security. Values include: Annual (00001), Sem-Annual (00002), One Payment Per Year (00035), etc.'
in: query
required: false
schema:
type: string
parameter-19087:
name: ACT_SETT_DT
description: Actual Settlement Date is the date of final settlement of the trade.
in: query
required: false
schema:
type: string
format: date
parameter-14009:
name: FCTR_DTE
description: Factor Date is the date the current factor is applicable from for principal paying securities.
in: query
required: false
schema:
type: string
format: date-time
parameter-19083:
name: RECORD_DT
description: Record Date is the date established by the issuer of a security for the purpose of determining the holders who are entitled to receive a dividend or distribution or is the cut off date to determine which holders of the security are eligible.
in: query
required: false
schema:
type: string
format: date
parameter-19060:
name: ENTRY_TYP
description: Entry Type
in: query
required: false
schema:
type: string
parameter-19084:
name: SEC_SECURITY_CD
description: CITI Internal Security Code is the identifier of the CITI Internal Security Identifier.
in: query
required: false
schema:
type: string
parameter-18890:
name: DIV_RATE
description: The Dividend Rate is the total expected dividend payments for an investment on an annualized basis
in: query
required: false
schema:
type: number
format: double
parameter-18973:
name: PRIN_QTY
description: Principal Quantity is the quantity for principal transactions.
in: query
required: false
schema:
type: number
format: double
parameter-18847:
name: ASRD_INCM_IND
description: The Assured Income Indicator advises whether an income payment is assured (to be paid on the anticipated payment date) or actual (to be paid when funds are actually received). The values are ASRD (assured) and ACTU (actual).
in: query
required: false
schema:
type: string
parameter-18966:
name: PLEDGE_CDE
description: Pledge Code is a 10 digit numeric number corresponding to the DTC(Depository Trust Company) participant number in a pledge.
in: query
required: false
schema:
type: string
parameter-19071:
name: ISS_CAT_NME
description: 'Issue Category is the description for the Issue Category Code. Values include: Common Stock (CSTK), Derivatives (DERIV), Mortgage Backed Securities (MBS), etc.'
in: query
required: false
schema:
type: string
parameter-28847:
name: ORIG_BANK_ADR_LNE1
description: Originating Bank Address Line 1 is the first line of (1 of 4) address for the Originating Bank
in: query
required: false
schema:
type: string
parameter-18948:
name: ORD_BANK_NME
description: Ordering Bank Name is the name of the institution that has been authorized to act on the payment of funds.
in: query
required: false
schema:
type: string
parameter-42408:
name: HEAD_ACCOUNT
description: SCAR Head Account Number
in: query
required: false
schema:
type: string
parameter-19104:
name: RVSL_IND
description: 'The Reversal Indicator notes whether or not the cash transaction was processed to reverse an earlier transaction. Values include: N, R, Y, (null).'
in: query
required: false
schema:
type: string
parameter-28855:
name: ORD_BANK_ACCT_NO
description: Ordering Bank Account Number
in: query
required: false
schema:
type: string
parameter-28882:
name: RVSL_IND
description: 'Reversal Indicator notes whether or not the transaction was processed to reverse an earlier transaction. Values include: N, R, Y, (null)'
in: query
required: false
schema:
type: string
parameter-28861:
name: ORD_PTY_ACCT_NO
description: Ordering Party Account Number
in: query
required: false
schema:
type: string
parameter-18987:
name: SK_ACCT_ID
description: The safekeeping account ID is an identifier for a safekeeping account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-18882:
name: CORR_BNK_ACCT_NBR
description: The Corresponding Bank Account Number is the account established by a banking institution to receive deposits from, make payments on behalf of, or handle other financial transactions for another financial institution.
in: query
required: false
schema:
type: string
parameter-14008:
name: ENTRY_TYP
description: Entry Type
in: query
required: false
schema:
type: string
parameter-54430:
name: SEGMENT
description: A Cash Blotter Detail record
in: query
required: false
schema:
type: string
parameter-18853:
name: BENEF_BNK
description: The Beneficiary Bank is the bank where the beneficiary has the account.
in: query
required: false
schema:
type: string
parameter-18954:
name: ORD_PTY_NME
description: Ordering Party Name is the name of the instructing party that has authorized the payment of funds.
in: query
required: false
schema:
type: string
parameter-18896:
name: EX_DISTN_DT
description: Ex Date is the trading cut off date after which position changes will no longer alter the eligibility to the corporate action or the date established by an issuer of a security for the purpose of determining the holders who are entitled to receive the last dividend or distribution.
in: query
required: false
schema:
type: string
format: date
parameter-19003:
name: TXWHLD_CMB_AMT
description: Tax Withheld is the amount of money that has been held back for tax purposes.
in: query
required: false
schema:
type: number
format: double
parameter-18881:
name: CORP_ACTN_TYP_NME
description: 'Corporate Action Type Name is the description for the Corporate Action Type code. Values include: BID/REVERSE RIGHTS (BIDS), CASH DIVIDEND (CSHDIV), INTEREST PAYMENT (INTR), STOCK DIVIDEND (STDIV), etc.'
in: query
required: false
schema:
type: string
parameter-18961:
name: ORIG_BANK_ADR_LNE2
description: Originating Bank Address Line 2 is the second line of (2 of 4) address for the Originating Bank
in: query
required: false
schema:
type: string
parameter-13993:
name: POOL_ID_CD
description: Pool ID is an alphanumeric code that identifies a particular mortgage backed security.
in: query
required: false
schema:
type: string
parameter-19103:
name: SID_LOCAL
description: Local ID is the Local security identifier of the associated security.
in: query
required: false
schema:
type: string
parameter-28745:
name: CURR_FCTR
description: Current Factor is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
in: query
required: false
schema:
type: number
format: double
parameter-28857:
name: ORD_BANK_ADR_LNE_2
description: Ordering Bank Address2 is the second line of (2 of 4) address for the Ordering Bank
in: query
required: false
schema:
type: string
parameter-18851:
name: CLNT_PFD_CUR_CD
description: Base Currency Code is the ISO currency code preferred by the client organization.
in: query
required: false
schema:
type: string
parameter-28814:
name: BNKCUST_REPMT_COND
description: Bank/Customer Repayment Conditions are the terms and conditions for payment services for financial institutions.
in: query
required: false
schema:
type: string
parameter-28723:
name: PRIN_QTY
description: Principal Quantity for principal transactions.
in: query
required: false
schema:
type: number
format: double
parameter-28893:
name: IOD_UPDATE_TMS
description: IOD Timestamp
in: query
required: false
schema:
type: string
format: date-time
parameter-28779:
name: TRAD_BRKR_NME
description: Counterparty is the other party to the trade. The person or entity (e.g. institution, agent, broker) with whom a transaction is conducted).
in: query
required: false
schema:
type: string
parameter-18909:
name: INCM_CUR_NME
description: Income Currency Name is the name of the currency in which income payments will be made for the security in the local market.
in: query
required: false
schema:
type: string
parameter-18844:
name: ALTV_CUR_CD
description: Account Base Currency Code is the ISO Currency Code for the account.
in: query
required: false
schema:
type: string
parameter-13995:
name: PFD_ISS_ID
description: Security ID is the most commonly used identifier for the security in a given market.
in: query
required: false
schema:
type: string
parameter-13983:
name: INCM_CUR_NME
description: Income Currency Name is the name of the currency in which income payments will be made for the security in the local market.
in: query
required: false
schema:
type: string
parameter-19031:
name: EOD_INTRA_IND
description: 'EOD/intraday Indicator advises if the balance is an End of Day reported balance or if the balance is an Intraday reported balance. Values are: 1 (Intraday) 2 (End of Day)'
in: query
required: false
schema:
type: string
parameter-28849:
name: ORIG_BANK_ADR_LNE3
description: Originating Bank Address Line 3 is the third line of (3 of 4) address for the Originating Bank
in: query
required: false
schema:
type: string
parameter-13978:
name: SEC_DESC
description: Issue Description contains the name and other details of the instrument.
in: query
required: false
schema:
type: string
parameter-13988:
name: ISSR_LOC_NME
description: 'Issuer Location is the name of the country where the issuer of the security is based. Values include: Argentina (AR), Canada (CA), Ireland (IE), etc.'
in: query
required: false
schema:
type: string
parameter-18898:
name: PCH_CUR_CD
description: The FX Purchase Currency is the ISO Currency Code for the currency that is being purchased as part of the foreign exchange transaction.
in: query
required: false
schema:
type: string
parameter-28769:
name: ULTM_BENEF_ACCT
description: Ultimate Beneficiary Account is the account number of the Ultimate Beneficiary.
in: query
required: false
schema:
type: string
parameter-28829:
name: INTRNL_REF_ID_CA
description: Custodian Reference (CA) is the unique reference assigned by the Custodian to the record. The reference number is unique within a branch.
in: query
required: false
schema:
type: string
parameter-19089:
name: CA_INCM_IND
description: 'The CA/Income Indicator advises if the cash transaction is related to corporate actions or income. Values are: C for Corporate Action, I for Income.'
in: query
required: false
schema:
type: string
parameter-18969:
name: PFD_ISS_ID
description: Security ID is the most commonly used identifier for the security in a given market.
in: query
required: false
schema:
type: string
parameter-18841:
name: ACCT_ID
description: Account ID is an identifier for both a cash account and/or a safekeeping account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-28886:
name: RCEV_DIV_CUR_CD
description: Received Dividend Currency is the ISO Currency Code for the dividend amount.
in: query
required: false
schema:
type: string
parameter-28782:
name: TRANS_CATG_NME
description: 'Transaction Category is used in the US Cash Balance Summary report. Values include: CORPORATE ACTIONS DDA DDASEC DF DP INCOME MATURITIES MISCELLANEOUS RF RP Only applicable to the US cash transactions.'
in: query
required: false
schema:
type: string
parameter-28789:
name: CORP_ACTN_TYP_NME
description: 'Corporate Action Type Name is the description for the Corporate Action Type code. Values include: BID/REVERSE RIGHTS (BIDS), CASH DIVIDEND (CSHDIV), INTEREST PAYMENT (INTR), STOCK DIVIDEND (STDIV), etc.'
in: query
required: false
schema:
type: string
parameter-28864:
name: ORD_PTY_ADR_LNE_3
description: Ordering Party Address3 is the third line of (3 of 4) address for the Ordering Party
in: query
required: false
schema:
type: string
parameter-54318:
name: CITI_INTRNL_REF_ID
description: Custodian Reference (Internal) is a Citi generated identifier for a unique cash transaction record. This attribute is only valid within Citi and we recommend that it should not be used by clients.
in: query
required: false
schema:
type: string
parameter-19020:
name: PREF_SEC_ID_TP
description: 'Security Type identifies the Security ID. Values include: CUSIP, ISIN, SEDOL, etc.'
in: query
required: false
schema:
type: string
parameter-13837:
name: ACCT_BUS_TYP_CD
description: 'Account Type Code indicates the type of the account. Values are: C (Cash Account), S (Safekeeping Account).'
in: query
required: false
schema:
type: string
parameter-18977:
name: RCEV_DIV_AMT
description: Received Dividend Amount is the dividend amount of the transaction.
in: query
required: false
schema:
type: number
format: double
parameter-18859:
name: BRKR_CODE
description: Broker Code
in: query
required: false
schema:
type: string
parameter-28825:
name: DB_CR_IND
description: Credit/Debit Indicator shows whether the cash posting associated to the corporate action will be a credit (C) or a debit (D).
in: query
required: false
schema:
type: string
parameter-18855:
name: BENEF_REF
description: Beneficiary Reference is a transaction level reference at the beneficiary bank side.
in: query
required: false
schema:
type: string
parameter-28736:
name: PRCD_CMB_AMT
description: Proceeds - Local is the amount, in the market currency, for a sale and/or loan transaction.
in: query
required: false
schema:
type: number
format: double
parameter-18967:
name: POOL_ID_CD
description: Pool ID is an alphanumeric code that identifies a particular mortgage backed security.
in: query
required: false
schema:
type: string
parameter-14019:
name: ISS_CATG_CD
description: 'Issue Category Code is a specific category for the security. Values include: CSTK (Common Stock), DERIV (Derivatives), MBS (Mortgage Backed Securities), etc.'
in: query
required: false
schema:
type: string
parameter-13989:
name: SEC_GROUP
description: 'Asset Type is a code representing the Asset Type of the security. Values include: EQTY (Equity), FI (Fixed Income), etc.'
in: query
required: false
schema:
type: string
parameter-28900:
name: EFF_POST_DT
description: The contractual settlement date while the underlying transaction is not settled. The actual settlement date for settled transactions.
in: query
required: false
schema:
type: string
format: date
parameter-18893:
name: ENTRY_ID
description: Entry ID is the two-digit National Codification Bureau (NCB) code
in: query
required: false
schema:
type: string
parameter-18860:
name: EFF_POST_DT
description: The contractual settlement date while the underlying transaction is not settled. The actual settlement date for settled transactions.
in: query
required: false
schema:
type: string
format: date
parameter-28866:
name: ORD_PTY_NME
description: Ordering Party Name is the name of the instructing party that has authorized the payment of funds.
in: query
required: false
schema:
type: string
parameter-18960:
name: ORIG_BANK_ADR_LNE1
description: Originating Bank Address Line 1 is the first line of (1 of 4) address for the Originating Bank
in: query
required: false
schema:
type: string
parameter-28833:
name: GROSS_NET_IND
description: The Gross/Net is an indicator that advises if the amount for the transaction is Gross or Net. Values include G (Gross), N (Net) and (null).
in: query
required: false
schema:
type: string
parameter-18887:
name: CUM_QTY
description: Cumulative Quantity is the units for fixed income securities. This parameter pertains to US domestic only.
in: query
required: false
schema:
type: number
format: double
parameter-18989:
name: SID_ISIN
description: ISIN (International Securities Identification Number) is a 12-character alpha-numerical code that does not contain information characterizing financial instruments but serves for uniform identification of a security at trading and settlement.
in: query
required: false
schema:
type: string
parameter-18873:
name: CMPNY_DESC
description: Company Description contains information regarding the company which issued the security.
in: query
required: false
schema:
type: string
parameter-18923:
name: SEC_DESC
description: Issue Description contains the name and other details of the instrument.
in: query
required: false
schema:
type: string
parameter-28808:
name: BENEF
description: The Beneficiary is the recipient (payee) of the funds.
in: query
required: false
schema:
type: string
parameter-19004:
name: THREE_DAY_FLO
description: Three Day Float is the time period between when a deposit is made and when funds become available in an account.
in: query
required: false
schema:
type: number
format: double
parameter-18978:
name: RCEV_DIV_CUR_CD
description: Received Dividend Currency is the ISO 4217 Currency Code for the dividend amount.
in: query
required: false
schema:
type: string
parameter-18950:
name: ORD_PTY_ADR_LNE_1
description: Ordering Party Address1 is the first line of (1 of 4) address for the Ordering Party
in: query
required: false
schema:
type: string
parameter-28753:
name: CASH_DB_AMT
description: Cash Debit is the amount on the debit transaction
in: query
required: false
schema:
type: number
format: double
parameter-28818:
name: ENTLMT_STS_NME
description: 'Entitlements Status is a description of the current processing status of the entitlement. Values include: Pending, Fully Released, Fully Paid, Partially Released, Partially Paid, Pending Payment, Pending, Reversal, Rev, To Be Received, (null), etc.'
in: query
required: false
schema:
type: string
parameter-18952:
name: ORD_PTY_ADR_LNE_3
description: Ordering Party Address3 is the third line of (3 of 4) address for the Ordering Party
in: query
required: false
schema:
type: string
parameter-19027:
name: CLNT_REF_NBR
description: Client Reference is a unique number assigned by the client, to the transaction, for identification purposes within their organization.
in: query
required: false
schema:
type: string
parameter-19026:
name: AMT
description: Amount is the Cash Transaction amount that will be credited or debited from the cash account.
in: query
required: false
schema:
type: number
format: double
parameter-18849:
name: BNK_CUST_PMT_COND
description: Bank/Customer Payment Conditions are the terms and conditions for payment services for financial institutions.
in: query
required: false
schema:
type: string
parameter-28890:
name: SOLD_REMIT_INSTRS
description: Sold Remit Instruction is text that describes the sell activity for the transaction.
in: query
required: false
schema:
type: string
parameter-18902:
name: FACE_QTY
description: Face Value is the original face value for Mortgage Backed Securities in the US domestic market. For other MBS positions this will be the current face value after amortization.
in: query
required: false
schema:
type: number
format: double
parameter-19032:
name: ACCT_BUS_TYP_CD
description: 'Account Type Code indicates the type of the account. Values are: C (Cash Account), S (Safekeeping Account).'
in: query
required: false
schema:
type: string
parameter-28752:
name: CASH_CR_AMT
description: Cash Credit is the amount on the credit transaction
in: query
required: false
schema:
type: number
format: double
parameter-28897:
name: CONTR_PYBL_DT
description: Contractual Settlement Date is the date when the clients cash account should be credited with funds on a sale (and debited on a purchase) on the due settlement date in place of when a trade actually settles in the market.
in: query
required: false
schema:
type: string
format: date
parameter-19110:
name: COB_DATE
description: Close of Business Date
in: query
required: false
schema:
type: string
format: date
parameter-18947:
name: ORD_BANK_ADR_LNE_4
description: Ordering Bank Address4 is the fourth line of (4 of 4) address for the Ordering Bank
in: query
required: false
schema:
type: string
parameter-18862:
name: CASH_CR_AMT
description: Cash Credit is the amount on the credit transaction
in: query
required: false
schema:
type: number
format: double
parameter-28898:
name: CASH_VAL_DT
description: Value Date is the date on which the cash posting corresponding to this trade will have value.
in: query
required: false
schema:
type: string
format: date
parameter-19097:
name: ACCT_PLEDGE_TYPE
description: Account Flag is a flag identifying whether the account is Free, 3rd party Pledge, Pledge HIC.
in: query
required: false
schema:
type: string
parameter-53479:
name: CITI_REFERENCE
description: Custodian Reference (Internal) is a Citi generated identifier for a unique cash transaction record. This attribute is only valid within Citi and we recommend that it should not be used by clients.
in: query
required: false
schema:
type: string
parameter-53468:
name: ACCT_ID
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-53521:
name: SENDER_REFERENCE
description: The Sender Reference - from the third party or the internal source system.
in: query
required: false
schema:
type: string
parameter-53475:
name: BUY_AMT
description: Total Buy amount for a FX trade.
in: query
required: false
schema:
type: number
format: double
parameter-53492:
name: FX_RATE
description: Client rate Includes forward points on FX rate.
in: query
required: false
schema:
type: number
format: double
parameter-53531:
name: ACCT_NME
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account.
in: query
required: false
schema:
type: string
select_3:
name: $select
in: query
description: The $SELECT parameter in an API allows users to specify which data fields (properties or columns) they want to receive in the API response. This helps improve efficiency by reducing the amount of data transferred and simplifying client-side processing.
required: false
schema:
type: string
parameter-53490:
name: FX_BRKR_BIC_CODE
description: FX Broker bank identitfier code.
in: query
required: false
schema:
type: string
parameter-53477:
name: BUY_CURR_CODE
description: Provides the ISO 4217 currency code in which amout will be debited from debit account.sample values are USD/INR.
in: query
required: false
schema:
type: string
parameter-53528:
name: TRADE_DT
description: The date on which the actual contract is executed between the buyer and seller of a specific country.
in: query
required: false
schema:
type: string
format: date
parameter-53519:
name: SELL_CURR_CODE
description: Provides the ISO 4217 currency code in which amout will be credited in credit account.sample values are USD/INR.
in: query
required: false
schema:
type: string
parameter-53517:
name: SELL_AMT
description: Total Sell amount for a FX trade.
in: query
required: false
schema:
type: number
format: double
parameter-53491:
name: FX_BRKR_NME
description: FX Broker Name. A forex broker is a financial services company that provides traders access to a platform for buying and selling foreign currencies.
in: query
required: false
schema:
type: string
parameter-53472:
name: BR_ID
description: 'Reflects the 2 CHAR Branch Code where the transaction was executed and processed. Sample values: LO = London; JE = Jersey ; LU = Luxembourg; NY = New York.'
in: query
required: false
schema:
type: string
parameter-53529:
name: VALUE_DT
description: Value Date is the delivery date on which counterparties to a transaction agree to settle their respective obligations by making payments and transferring ownership.
in: query
required: false
schema:
type: string
format: date
parameter-53494:
name: FX_TYPE
description: 'Forex traders transact in one of three distinct marketplaces: the spot, the forward, or the futures market.'
in: query
required: false
schema:
type: string
parameter-53450:
name: MKT_INFR_TX_ID
description: Identification of a transaction assigned by a market infrastructure other than a central securities depository, for example, Target2-Securities.
in: query
required: false
schema:
type: string
parameter-53433:
name: ACCT_SERVR_BIC
description: Account Servicer/Depository BIC is the Bank Identifier code of the party which administers the account.
in: query
required: false
schema:
type: string
parameter-53444:
name: PENALTY_AMT
description: Penalty Amount is calculated based on the security and instruction characteristics and the reason for the fail. For a Late Matching Fail Penalty (LMFP) that spans several business days, this amount is the sum of the amounts calculated for each applicable business day.
in: query
required: false
schema:
type: integer
format: int32
parameter-53431:
name: AGGR_AMT
description: The global net amount for a party is the sum of all cash penalties in this currency that this party is entitled to receive minus the sum of all cash penalties in this currency that are imposed to the party. A positive amount indicates that the party will be credited with this amount; a negative amount indicates that the amount will be debited.
in: query
required: false
schema:
type: number
format: double
parameter-53455:
name: CPRT_ACCT_SER_BIC
description: Counterparty's Account Servicer/Depository BIC is the Bank Identifier of the counterparty's account servicer/depository.
in: query
required: false
schema:
type: string
parameter-53380:
name: PENALTY_TYP_CD
description: Penalty Type indicates whether the penalty is a late matching fail penalty (LMFP) or a settlement fail penalty (SEFP).
in: query
required: false
schema:
type: string
parameter-53428:
name: RPT_PER_DT_END
description: The date calculated based on the Period chosen as the end date for the report.
in: query
required: false
schema:
type: string
format: date-time
parameter-53381:
name: PENALTY_AMT_CURR
description: Penalty Currency is the ISO 4217 currency code for the currency of the penalty amount.
in: query
required: false
schema:
type: string
parameter-53430:
name: CPRT_NET_AMT_CURR
description: Net Amount Currency is the currency of the Net Amount.
in: query
required: false
schema:
type: string
parameter-53456:
name: PENALTY_DETEC_DT
description: 'Penalty Detection Date is the day for which the penalty was computed. /nIt is the date on which the instruction matched for Late Matching Fail Penalty (LMFP) or the date on which an instruction fails to settle for Settlement Fail Penalty (SEFP). /nNote: This date is not updated upon re-calculation of the penalty and always relates to the business day for which the penalty was initially computed.'
in: query
required: true
schema:
type: string
format: date
select_4:
name: $select
in: query
description: The $SELECT parameter in an API allows users to specify which data fields (properties or columns) they want to receive in the API response. This helps improve efficiency by reducing the amount of data transferred and simplifying client-side processing.
required: false
schema:
type: string
parameter-53385:
name: SEC_SHRT_NME
description: Issue Name is the Security Name of the security instrument.
in: query
required: false
schema:
type: string
parameter-53443:
name: PENALTY_AMT_COMP
description: Indicates whether or not the amount calculated for the reported penalty will be added to the aggregated amounts at global level. There could be several reasons for not considering the penalty amount. The flag is used to indicate an exceptional situation. If the flag is not reported in the message this means that the penalty is considered for the calculation of aggregated amounts.
in: query
required: false
schema:
type: integer
format: int32
parameter-53440:
name: COM_REF
description: Common Reference is assigned by the market infrastructure (for example T2S) to the penalty and that is common for both the failing and the non-failing participant.
in: query
required: false
schema:
type: string
parameter-53425:
name: ACCT_NME
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
in: query
required: false
schema:
type: string
parameter-53390:
name: SEC_PEN_RT
description: Security penalty rate applied in the calculation of the penalty.
in: query
required: false
schema:
type: number
format: double
parameter-53434:
name: CURRENCY
description: Currency in which the penalties are expressed.
in: query
required: false
schema:
type: string
parameter-53391:
name: CNTR_SETL_DT
description: Penalty Type indicates whether the penalty is a late matching fail penalty (LMFP) or a settlement fail penalty (SEFP).
in: query
required: false
schema:
type: string
format: date
parameter-53393:
name: POST_AMT_CURR
description: Settlement Currency is the currency name for the Settlement Amount.
in: query
required: false
schema:
type: string
parameter-53446:
name: NBR_OF_DAYS
description: Number of Days is the number of days over which a late matching penalty has been calculated.
in: query
required: false
schema:
type: integer
format: int32
parameter-53435:
name: RLTD_PARTY_BIC
description: Identification of the party reported as party imposed with the penalties reported or party credited with the penalty(ies).
in: query
required: false
schema:
type: string
parameter-53429:
name: CASH_ACCT_ID
description: Cash Account ID is the account number for the cash account. It is unique within a branch.
in: query
required: false
schema:
type: string
parameter-53453:
name: RELATED_TX_ID
description: Reference of the linked message which was previously received.
in: query
required: false
schema:
type: string
parameter-53373:
name: ACCT_ID
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-53388:
name: CLIENT_REF
description: Number of Days is the number of days over which a late matching penalty has been calculated.
in: query
required: false
schema:
type: string
parameter-53424:
name: ACCT_ID
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-53383:
name: PFD_ID_CTXT_CD
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID field. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
in: query
required: false
schema:
type: string
parameter-53447:
name: ACCT_OWN_TX_ID
description: Reference assigned to the reported transaction by the account owner.
in: query
required: false
schema:
type: string
parameter-53394:
name: POST_AMT
description: Settlement Amount is the cash value of the trade in the market currency.
in: query
required: false
schema:
type: number
format: double
parameter-53457:
name: PENALTY_STATUS
description: Penalty status is to check if penalty is active or inactive for a given record.
in: query
required: true
schema:
type: string
parameter-53438:
name: CPRT_TYPE
description: Specifies the role of the counterparty in the transaction.
in: query
required: false
schema:
type: string
parameter-53382:
name: PENALTY_AMT
description: Penalty Amount is calculated based on the security and instruction characteristics and the reason for the fail. For a Late Matching Fail Penalty (LMFP) that spans several business days, this amount is the sum of the amounts calculated for each applicable business day.
in: query
required: false
schema:
type: number
format: double
parameter-53392:
name: POST_QTY
description: Quantity provides the number of units, par value or nominal value (for fixed income instruments), amount of currency (for FX transactions), or number of shares. Indicates the contract quantity on the original transaction that was given up.
in: query
required: false
schema:
type: number
format: double
parameter-53377:
name: PENALTY_DETEC_DT
description: 'Penalty Detection Date is the day for which the penalty was computed. /nIt is the date on which the instruction matched for Late Matching Fail Penalty (LMFP) or the date on which an instruction fails to settle for Settlement Fail Penalty (SEFP). /nNote: This date is not updated upon re-calculation of the penalty and always relates to the business day for which the penalty was initially computed.'
in: query
required: true
schema:
type: string
format: date
parameter-53432:
name: PFOD_MESG_ID
description: Reference of the penalty payment.
in: query
required: false
schema:
type: string
parameter-53426:
name: CPRT_ACCT_SER_NAME
description: Counterparty's Account Servicer/Depository is the name of the counterparty's account servicer/depository.
in: query
required: false
schema:
type: string
parameter-53437:
name: CPRT_BIC
description: Counterparty BIC is the Bank Identifier code of the party imposed with the penalties reported or party credited with the penalty(ies).
in: query
required: false
schema:
type: string
parameter-53375:
name: ACCT_OWN_NAME
description: Account Servicer/Depository is the name of the party which administers the account.
in: query
required: false
schema:
type: string
parameter-53386:
name: SID_ISIN
description: ISIN (International Securities Identification Number) is a 12-character alpha-numerical code governed by ISO 6166 it is a uniform identification of a security at trading and settlement. This data is sourced from multiple sources and will be provided if available.
in: query
required: false
schema:
type: string
parameter-53427:
name: RPT_PER_DT_START
description: The date calculated based on the Period chosen as the start date for the report.
in: query
required: false
schema:
type: string
format: date-time
parameter-53445:
name: CALC_METHOD
description: Calcualtion Method indixates the calculation rule used to compute the penalty. Values are CASH, MIXE, SECU, BOTH).
in: query
required: false
schema:
type: string
parameter-53379:
name: COM_REF
description: Common Reference is assigned by the market infrastructure (for example T2S) to the penalty and that is common for both the failing and the non-failing participant.
in: query
required: false
schema:
type: string
parameter-53448:
name: ACCT_SEC_TX_ID
description: Reference assigned to the reported transaction by the account servicer.
in: query
required: false
schema:
type: string
parameter-53378:
name: PENALTY_REF
description: Reference is assigned by the market infrastructure to the penalty and is the individual identification of the penalty for the relevant account owner (that is, either for the failing participant or for the non-failing participant).
in: query
required: false
schema:
type: string
parameter-53389:
name: TRADE_DT
description: Date when the trade was agreed on with counterparty.
in: query
required: false
schema:
type: string
format: date
parameter-53452:
name: CORP_ACT_EV_ID
description: Reference assigned by the account servicer to unambiguously identify a related corporate action event.
in: query
required: false
schema:
type: string
parameter-53395:
name: PENALTY_STATUS
description: Penalty status is to check if penalty is active or inactive for a given record.
in: query
required: true
schema:
type: string
parameter-53376:
name: CPRT_NAME
description: Counterparty is the name of the party imposed with the penalties reported or party credited with the penalty(ies).
in: query
required: false
schema:
type: string
parameter-53384:
name: PFD_ISS_ID
description: Security ID is the most commonly used identifier for the security in a given market.
in: query
required: false
schema:
type: string
parameter-53436:
name: PARTY_TYPE
description: Specifies the role of the party in the transaction.
in: query
required: false
schema:
type: string
parameter-53454:
name: PEN_PY_DT
description: Payment Date is the date at which the last payment on the entitlement was made. Or Date/time at which the movement is due to take place (cash and/or securities).
in: query
required: false
schema:
type: string
format: date
parameter-53449:
name: PROCESSOR_TX_ID
description: Identification of the transaction assigned by the processor of the instruction other than the account owner/the account servicer and the market infrastructure.
in: query
required: false
schema:
type: string
parameter-53451:
name: COMMON_ID
description: Unique reference agreed upon by the Investment Manager and the Broker/Dealer to identify the trade. This reference should be passed down and up through the whole life cycle of the transaction.
in: query
required: false
schema:
type: string
parameter-53439:
name: CPRT_NET_AMT
description: The bilateral net amount for a party and counterpart will be the sum of all cash penalties in this currency that this party is entitled to receive (reported as credit) from the same counterpart (that is, to be paid by this counterpart) minus the sum of all cash penalties in this currency that are imposed to the party (reported as debit) and to be paid to the given counterpart.
in: query
required: false
schema:
type: number
format: double
parameter-53442:
name: PENALTY_TYP_CD
description: Penalty Type indicates whether the penalty is a late matching fail penalty (LMFP) or a settlement fail penalty (SEFP).
in: query
required: false
schema:
type: string
parameter-53387:
name: CLIENT_SEC_REF
description: Calcualtion Method indixates the calculation rule used to compute the penalty. Values are CASH, MIXE, SECU, BOTH).
in: query
required: false
schema:
type: string
parameter-53441:
name: PENALTY_REF
description: Reference is assigned by the market infrastructure to the penalty and is the individual identification of the penalty for the relevant account owner (that is, either for the failing participant or for the non-failing participant).
in: query
required: false
schema:
type: string
parameter-53374:
name: ACCT_NME
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
in: query
required: false
schema:
type: string
parameter-36539:
name: ACCT_ID
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-36535:
name: ACCT_NME
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
in: query
required: false
schema:
type: string
parameter-36528:
name: ACCT_STS_TYP
description: 'Account Status provides the current status of the Cash Account and/or the Safekeeping Account. Values are: Open, Closed, Frozen'
in: query
required: false
schema:
type: string
parameter-36505:
name: GFC_ID
description: Client ID is an identifier that is available on a Cash Account and/or a Safekeeping Account.
in: query
required: false
schema:
type: string
parameter-36544:
name: ACCT_CLS_DT
description: Account Close Date is the date when the account was closed. It will only have a value if the account is closed.
in: query
required: false
schema:
type: string
format: date
parameter-36551:
name: LEGAL_ENTITY
description: This identifies the branch that is the Legal Entity for a Global Window branch.
in: query
required: false
schema:
type: string
parameter-36524:
name: ALT_ACCT_NME
description: Alternate Account Name is the user provided name for the account as entered using the Account Cabinet. If an Alternate Account Name is not provided this field will be blank.
in: query
required: false
schema:
type: string
parameter-36519:
name: BR_NME
description: Branch Name is the name of the branch for the Cash Account and/or Safekeeping Account.
in: query
required: false
schema:
type: string
parameter-36545:
name: ACCT_BUS_TYP_NME
description: Account Type Description indicates the type of the account. Values are CASH (C), S/K (S)
in: query
required: false
schema:
type: string
parameter-36502:
name: IBAN
description: IBAN ISO 13616:1997 is the International Bank Account Number for the Cash Account.
in: query
required: false
schema:
type: string
parameter-47704:
name: RELATED_SAFEKEEPING_ACCT_ID
description: This provides safekeeping account related to a cash account
in: query
required: false
schema:
type: string
parameter-36522:
name: ALTV_CUR_CD
description: Account Base Currency Code is the ISO Currency Code for the account.
in: query
required: false
schema:
type: string
parameter-36533:
name: ACCT_OPN_DT
description: Account Open Date is the date when the account was opened.
in: query
required: false
schema:
type: string
format: date
parameter-36518:
name: CASH_TYPE
description: Cash Type Code pertains to US Direct Cash Accounts and indicates whether the Cash Account has a split income and principal balance.
in: query
required: false
schema:
type: number
format: double
parameter-36548:
name: ACCT_BASE_NBR
description: Account Base Number is an internal Citi client identifier that is associated to a Safekeeping or Cash Account.
in: query
required: false
schema:
type: string
select_5:
name: $select
in: query
description: The $SELECT parameter in an API allows users to specify which data fields (properties or columns) they want to receive in the API response. This helps improve efficiency by reducing the amount of data transferred and simplifying client-side processing.
required: false
schema:
type: string
parameter-29079:
name: ALTN_CUR_EXCH_RATE
description: Base Currency Exchange Rate is the rate used to convert the Market Valuation to the Account Base Currency Valuation.
in: query
required: false
schema:
type: number
format: double
parameter-19199:
name: SETLD_QTY
description: Settled Quantity is the quantity that has settled or the quantity of the security that is fully settled at the "As Of" date. For partial settlements the settled quantity is the portion that has settled.
in: query
required: false
schema:
type: number
format: double
parameter-13415:
name: BR_NME
description: Branch Name is the name of the branch for the Cash Account and/or Safekeeping Account.
in: query
required: false
schema:
type: string
parameter-19164:
name: PNDNG_DELIV
description: Pending Deliverable is the sum of the quantity of outstanding deliver trades at the "As Of" date.
in: query
required: false
schema:
type: number
format: double
parameter-13520:
name: PMT_FREQY
description: 'Payment Frequency indicates how often interest is paid on the security. Values include: 00001 (Annual), 00002 (Sem-Annual), 00035 (One Payment Per Year), etc.'
in: query
required: false
schema:
type: string
parameter-29095:
name: CNTR_CD
description: Place Of Settlement Code is a 3 digit code corresponding to the settlement location of the holding.
in: query
required: false
schema:
type: string
parameter-13518:
name: ISS_CATG_CD
description: 'Issue Category Code is a specific category for the security. Values include: CSTK (Common Stock), DERIV (Derivatives), MBS (Mortgage Backed Securities), etc.'
in: query
required: false
schema:
type: string
parameter-29111:
name: ST_CD
description: State Code is a 2 digit code corresponding to the State where this statutory deposit is placed. Applies only to US Domestic holdings.
in: query
required: false
schema:
type: string
parameter-13442:
name: SEC_DESC
description: Issue Description contains the name and other details of the instrument.
in: query
required: false
schema:
type: string
parameter-19186:
name: TRDED_QTY
description: Traded Quantity is the quantity of the security held including any open trades.
in: query
required: false
schema:
type: number
format: double
parameter-19248:
name: ROLLED_FWD
description: Rolled Forward indicator parameter is used to flag if position valuation has been rolled forward from last close of business.
in: query
required: false
schema:
type: string
parameter-19115:
name: ALTV_CUR_CD
description: Account Base Currency Code is the ISO Currency Code for the account.
in: query
required: false
schema:
type: string
parameter-13497:
name: ACCT_BUS_TYP_CD
description: Account Type Code indicates the type of the account. Values are:
C (Cash Account)
S (Safekeeping Account).
in: query
required: false
schema:
type: string
parameter-19250:
name: IOD_TIMESTAMP
description: Provides the Timestamp when data is loaded in the Data Lake
in: query
required: false
schema:
type: string
format: date-time
parameter-29106:
name: PLACE_OF_SETLMT
description: Place Of Settlement is the name of the settlement location for the security.
in: query
required: false
schema:
type: string
parameter-13485:
name: PFD_ID_CTXT_CD
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID parameter. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
in: query
required: false
schema:
type: string
parameter-13412:
name: ISS_CAT_NME
description: 'Issue Category is the description for the Issue Category Code. Values include: Common Stock (CSTK), Derivatives (DERIV), Mortgage Backed Securities (MBS), etc.'
in: query
required: false
schema:
type: string
parameter-19196:
name: SID_ISIN
description: ISIN (International Securities Identification Number) is a 12-character alpha-numerical code that does not contain information characterizing financial instruments but serves for uniform identification of a security at trading and settlement.
in: query
required: false
schema:
type: string
parameter-19235:
name: FCTR_DTE
description: Factor Date is the date the current factor is applicable from for principal paying securities.
in: query
required: false
schema:
type: string
format: date-time
parameter-19191:
name: ACCT_ID
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-19182:
name: ST_CD
description: State Code is a 2 digit code corresponding to the State where this statutory deposit is placed. Applies only to US Domestic holdings.
in: query
required: false
schema:
type: string
parameter-19153:
name: SEC_SUB_TYP_CD
description: 'Issue Type Code is a code linked to the Issue Type parameter which describes the type of security instrument. Values include: 1 (ADR Convertible), 12 (Bond), 19 (Bond Convertible), etc.'
in: query
required: false
schema:
type: string
parameter-19124:
name: BR_NME
description: Branch Name is the name of the branch for the Cash Account and/or Safekeeping Account.
in: query
required: false
schema:
type: string
parameter-19229:
name: ISS_CATG_CD
description: 'Issue Category Code is a specific category for the security. Values include: CSTK (Common Stock), DERIV (Derivatives), MBS (Mortgage Backed Securities), etc.'
in: query
required: false
schema:
type: string
select_6:
name: $select
in: query
description: The `$select` parameter in an API allows you to specify which data parameters (properties or columns) they want to receive in the API response. This helps improve efficiency by reducing the amount of data transferred and simplifying client-side processing.
required: false
schema:
type: string
parameter-29094:
name: HOLD_LOCN_NME
description: How Position is Held is a description of the status of the holding, or where it is held.
in: query
required: false
schema:
type: string
parameter-13447:
name: ISSR_LOC_CD
description: 'Issuer Location Code is the ISO country code where the issuer of the security is based. Values include: AR (Argentina), CA (Canada), IE (Ireland), etc.'
in: query
required: false
schema:
type: string
parameter-19170:
name: PRC_CCY_NME
description: Market Value Currency is the name of the currency used to value the holding.
in: query
required: false
schema:
type: string
parameter-19135:
name: DTED_TMS
description: Dated Date/Time is the date that the interest begins to accrue on a fixed-income security.
in: query
required: false
schema:
type: string
format: date-time
parameter-19154:
name: SEC_SUB_TYP_NME
description: 'Issue Type is a description of the type of the security instrument. Values include: ADR Convertible (1), Bond (12) , Bond Convertible (19), etc.'
in: query
required: false
schema:
type: string
parameter-19202:
name: ASOF_TMS
description: The As Of Date is the date of the information being reported.
in: query
required: false
schema:
type: string
format: date-time
parameter-48550:
name: SETLD_QTY_MKT_EOD
description: Settled Quantity is the quantity of the security that is fully settled as of market close date
in: query
required: false
schema:
type: number
format: double
parameter-13445:
name: SEC_SUB_TYP_NME
description: 'Issue Type is a description of the type of the security instrument. Values include: ADR Convertible (1), Bond (12) , Bond Convertible (19), etc.'
in: query
required: false
schema:
type: string
parameter-19185:
name: SID_TICKER_SYMB
description: Ticker is the symbol used on the exchange to identify the security.
in: query
required: false
schema:
type: string
parameter-29104:
name: EOD_INTRA_IND
description: EOD/intraday Indicator advises if the information is as of End of Day or as of Intraday. Values are:
1 (Intraday)
2 (End of Day)
in: query
required: false
schema:
type: string
parameter-13488:
name: SEC_SHRT_NME
description: Issue Name is the Security Name of the security instrument.
in: query
required: false
schema:
type: string
parameter-13458:
name: POOL_ID_CD
description: Pool ID is an alphanumeric code that identifies a particular mortgage backed security.
in: query
required: false
schema:
type: string
parameter-19137:
name: DNOMD_CUR_CD
description: Denomination Currency Code is the ISO currency code in which the security is denominated, in the local market.
in: query
required: false
schema:
type: string
parameter-29105:
name: MKT_PRC_CUR_CD
description: Market Value Currency Code is the ISO currency code of the Market Value.
in: query
required: false
schema:
type: string
parameter-19126:
name: CNTR_CD
description: Place Of Settlement Code is a 3 digit code corresponding to the settlement location of the holding.
in: query
required: false
schema:
type: string
parameter-13454:
name: PMT_FREQY_DESC
description: 'Payment Frequency Description indicates how often interest is paid on the security. Values include: Annual (00001), Sem-Annual (00002), One Payment Per Year (00035), etc.'
in: query
required: false
schema:
type: string
parameter-48549:
name: TRDED_QTY_MKT_EOD
description: Traded Quantity is the quantity of the security held including any open trades as of market close date
in: query
required: false
schema:
type: number
format: double
parameter-19200:
name: HOLD_LOCN_NME
description: How Position is Held is a description of the status of the holding, or where it is held.
in: query
required: false
schema:
type: string
parameter-29098:
name: CNTRY_CD
description: Depot Domicile is the Depot domicile (Country where the sub-account is held).
in: query
required: false
schema:
type: string
parameter-19119:
name: ALTN_CUR_EXCH_RATE
description: The exchange rate used to convert Local Market Valuation to the Alternative Currency Valuation. Not applicable to the US domestic positions.
in: query
required: false
schema:
type: number
format: double
parameter-19168:
name: HLDNG_UPD_TMS
description: Position Update Timestamp is the date/time when the holding was last updated.
in: query
required: false
schema:
type: string
format: date-time
parameter-19230:
name: US_SIC_CD
description: SIC is the Standard Industrial Classification four-digit numeric code.
in: query
required: false
schema:
type: string
parameter-29120:
name: COB_DATE
description: Close of Business Date
in: query
required: false
schema:
type: string
format: date
parameter-13515:
name: SEC_SECURITY_CD
description: CITI Internal Security Code is the identifier of the CITI Internal Security Identifier.
in: query
required: false
schema:
type: string
parameter-29107:
name: SETL_HOLD_ST
description: How Position is Held Code is a 2 digit code corresponding to the How Position Is Held parameter which carries the status of the holding, or where it is held.
in: query
required: false
schema:
type: string
parameter-19195:
name: PFD_ISS_ID
description: Security ID is the most commonly used identifier for the security in a given market.
in: query
required: false
schema:
type: string
parameter-29101:
name: ACCT_ID
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-13466:
name: SID_CUSIP
description: CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.
in: query
required: false
schema:
type: string
parameter-19206:
name: ACCT_BUS_TYP_CD
description: 'Account Type Code indicates the type of the account. Values are:
C (Cash Account)
S (Safekeeping Account).'
in: query
required: false
schema:
type: string
parameter-19121:
name: ISS_CAT_NME
description: 'Issue Category is the description for the Issue Category Code. Values include: Common Stock (CSTK), Derivatives (DERIV), Mortgage Backed Securities (MBS), etc.'
in: query
required: false
schema:
type: string
parameter-48551:
name: MKT_EOD_CL_DT
description: This is the last close date for the position in the local market.
in: query
required: false
schema:
type: string
format: date
parameter-13448:
name: ISSR_LOC_NME
description: 'Issuer Location is the name of the country where the issuer of the security is based. Values include: Argentina (AR), Canada (CA), Ireland (IE), etc.'
in: query
required: false
schema:
type: string
parameter-19169:
name: PREV_FCTR
description: The factor which applies for the previous accrual period to determine payments and balances for principal paying securities. Currently applicable to the US intraday cash transactions.
in: query
required: false
schema:
type: number
format: double
parameter-19120:
name: ALTV_CUR_VAL
description: Base Currency Valuation is the Market Valuation in the Account Base Currency of the position for the "As Of" date.
in: query
required: false
schema:
type: number
format: double
parameter-19152:
name: ISS_PRC
description: Issue Price is the market price of the security at the "As Of" date.
in: query
required: false
schema:
type: number
format: double
parameter-13486:
name: PFD_ISS_ID
description: Security ID is the most commonly used identifier for the security in a given market.
in: query
required: false
schema:
type: string
parameter-29115:
name: ASOF_TMS
description: The As Of Date is the date of the information being reported.
in: query
required: false
schema:
type: string
format: date-time
parameter-13406:
name: ALTV_CUR_CD
description: Account Base Currency Code is the ISO Currency Code for the account.
in: query
required: false
schema:
type: string
parameter-19194:
name: PFD_ID_CTXT_CD
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID parameter. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
in: query
required: false
schema:
type: string
parameter-19181:
name: ST_NME
description: State is the state where this statutory deposit is placed. Applies only to US Domestic holdings.
in: query
required: false
schema:
type: string
parameter-19231:
name: PMT_FREQY
description: 'Payment Frequency indicates how often interest is paid on the security. Values include: 00001 (Annual), 00002 (Sem-Annual), 00035 (One Payment Per Year), etc.'
in: query
required: false
schema:
type: string
parameter-19116:
name: ACCT_BASE_NBR
description: Account Base Number is an internal Citi client identifier that is associated to a Safekeeping or Cash Account.
in: query
required: false
schema:
type: string
parameter-29076:
name: PREV_FCTR
description: The factor which applies for the previous accrual period to determine payments and balances for principal paying securities. Currently applicable to the US intraday cash transactions.
in: query
required: false
schema:
type: number
format: double
parameter-19162:
name: STK_EXCHG_NME
description: Nominee Description is the nominee name and/or other nominee information.
in: query
required: false
schema:
type: string
parameter-13428:
name: DNOMD_CUR_CD
description: Denomination Currency Code is the ISO currency code in which the security is denominated, in the local market.
in: query
required: false
schema:
type: string
parameter-19175:
name: SID_CUSIP
description: CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.
in: query
required: false
schema:
type: string
parameter-29096:
name: CNTR_CD_DESC
description: The Center Code description applicable to securities transactions only.
in: query
required: false
schema:
type: string
parameter-13474:
name: STRK_PRC_AMT
description: Strike Price is the specified price on an options contract at which the contract may be exercised.
in: query
required: false
schema:
type: number
format: double
parameter-19197:
name: SEC_SHRT_NME
description: Issue Name is the Security Name of the security instrument.
in: query
required: false
schema:
type: string
parameter-13484:
name: MATY_DT
description: Maturity Date is the date of maturity or redemption for fixed income securities.
in: query
required: false
schema:
type: string
format: date-time
parameter-48545:
name: MKT_EOD_CL_DT
description: Market EOD Close Date
in: query
required: false
schema:
type: string
format: date
parameter-19130:
name: CURR_FCTR
description: Current Factor is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
in: query
required: false
schema:
type: number
format: double
parameter-29088:
name: PNDNG_RECV
description: Pending Receivable is the sum of the quantity of outstanding receive trades at the "As Of" date.
in: query
required: false
schema:
type: number
format: double
parameter-19138:
name: CNTRY_CD
description: The Country Code (location) of the security custodian. Not applicable to the US domestic positions.
in: query
required: false
schema:
type: string
parameter-13424:
name: GFC_ID
description: Client ID is an identifier that is available on a Cash Account and/or a Safekeeping Account. This Client ID is referred to, internally at Citi, as a GFCID.
in: query
required: false
schema:
type: string
parameter-29087:
name: PNDNG_DELIV
description: Pending Deliverable is the sum of the quantity of outstanding deliver trades at the "As Of" date.
in: query
required: false
schema:
type: number
format: double
parameter-19127:
name: CNTR_CD_DESC
description: The center code description applicable to securities transactions only.
in: query
required: false
schema:
type: string
parameter-29084:
name: ISS_PRC
description: Issue Price is the market price of the security at the "As Of" date.
in: query
required: false
schema:
type: number
format: double
parameter-13426:
name: DTED_TMS
description: Dated Date/Time is the date that the interest begins to accrue on a fixed-income security.
in: query
required: false
schema:
type: string
format: date-time
parameter-13465:
name: SID_SEDOL
description: SEDOL (Stock Exchange Daily Official List) is a unique identification code, consisting of seven alphanumeric characters, that is assigned to all securities trading on the London Stock Exchange.
in: query
required: false
schema:
type: string
parameter-19247:
name: PLACE_OF_SETLMT
description: Place Of Settlement is the name of the settlement location for the security, applicable to securities positions , transactions only.
in: query
required: false
schema:
type: string
parameter-29080:
name: ALTV_CUR_VAL
description: Base Currency Valuation is the Market Valuation in the Account Base Currency of the position for the "As Of" date.
in: query
required: false
schema:
type: number
format: double
parameter-19226:
name: SEC_SECURITY_CD
description: CITI Internal Security Code is the identifier of the CITI Internal Security Identifier.
in: query
required: false
schema:
type: string
parameter-19192:
name: ACCT_NME
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
in: query
required: false
schema:
type: string
parameter-19198:
name: INCM_PROJN_RATE
description: Interest Rate is the coupon rate of the security.
in: query
required: false
schema:
type: number
format: double
parameter-19156:
name: ISSR_LOC_CD
description: 'Issuer Location Code is the ISO country code where the issuer of the security is based. Values include: AR (Argentina), CA (Canada), IE (Ireland), etc.'
in: query
required: false
schema:
type: string
parameter-29089:
name: PRC_CCY_NME
description: Market Value Currency is the name of the currency used to value the holding.
in: query
required: false
schema:
type: string
parameter-19190:
name: MKT_PRC_CUR_CD
description: Market Value Currency Code is the ISO currency code of the Market Value.
in: query
required: false
schema:
type: string
parameter-19165:
name: PNDNG_RECV
description: Pending Receivable is the sum of the quantity of outstanding receive trades at the "As Of" date.
in: query
required: false
schema:
type: number
format: double
parameter-19136:
name: DLAY_DAYS
description: Delay Days is the number of days from the issuance of an MBS pool (or from the beginning of the interest accrual period) until the first payment is remitted/paid to the holders.
in: query
required: false
schema:
type: string
parameter-19193:
name: MATY_DT
description: Maturity Date is the date of maturity or redemption for fixed income securities.
in: query
required: false
schema:
type: string
format: date-time
parameter-29112:
name: ST_NME
description: State is the state where this statutory deposit is placed. Applies only to US Domestic holdings.
in: query
required: false
schema:
type: string
parameter-29117:
name: HLDNG_UPD_TMS
description: Position Update Timestamp is the date/time when the holding was last updated.
in: query
required: false
schema:
type: string
format: date-time
parameter-19228:
name: ISS_TMS
description: Issue Date is the date of first issue of the security.
in: query
required: false
schema:
type: string
format: date-time
parameter-13405:
name: BR_ID
description: Branch Code is the identifier of the branch for the account. For the Cash Account the branch code is a numeric value and for the Safekeeping Account it is the ISO Country code.
in: query
required: false
schema:
type: string
parameter-13413:
name: SEC_GROUP
description: 'Asset Type is a code representing the Asset Type of the security. Values include: EQTY (Equity), FI (Fixed Income), etc.'
in: query
required: false
schema:
type: string
parameter-29073:
name: TRDED_QTY
description: Traded Quantity is the quantity of the security held including any open trades.
in: query
required: false
schema:
type: number
format: double
parameter-19245:
name: COB_DATE
description: Close of Business Date
in: query
required: false
schema:
type: string
format: date
parameter-13407:
name: ACCT_BASE_NBR
description: Account Base Number is an internal Citi client identifier that is associated to a Safekeeping or Cash Account.
in: query
required: false
schema:
type: string
parameter-29113:
name: STK_EXCHG_NME
description: Nominee Description is the nominee name and/or other nominee information
in: query
required: false
schema:
type: string
parameter-29086:
name: ORGL_FCE_VAL
description: Face Value is the original face value for Mortgage Backed Securities in the US domestic market. For other MBS positions this will be the current face value after amortization.
in: query
required: false
schema:
type: number
format: double
parameter-13489:
name: INCM_PROJN_RATE
description: Interest Rate is the coupon rate of the security.
in: query
required: false
schema:
type: number
format: double
parameter-19145:
name: SETL_HOLD_ST
description: How Position is Held Code is a 2 digit code corresponding to the How Position Is Held parameter which carries the status of the holding, or where it is held.
in: query
required: false
schema:
type: string
parameter-13487:
name: SID_ISIN
description: ISIN (International Securities Identification Number) is a 12-character alpha-numerical code that does not contain information characterizing financial instruments but serves for uniform identification of a security at trading and settlement.
in: query
required: false
schema:
type: string
parameter-19133:
name: GFC_ID
description: Client ID is an identifier that is available on a Cash Account and/or a Safekeeping Account. This Client ID is referred to, internally at Citi, as a GFCID.
in: query
required: false
schema:
type: string
parameter-29077:
name: CURR_FCTR
description: Current Factor is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
in: query
required: false
schema:
type: number
format: double
parameter-13427:
name: DLAY_DAYS
description: Delay Days is the number of days from the issuance of an MBS pool (or from the beginning of the interest accrual period) until the first payment is remitted/paid to the holders.
in: query
required: false
schema:
type: string
parameter-19201:
name: ORGL_FCE_VAL
description: Face Value is the original face value for Mortgage Backed Securities in the US domestic market. For other MBS positions this will be the current face value after amortization.
in: query
required: false
schema:
type: number
format: double
parameter-48544:
name: SETLD_QTY_MKT_EOD
description: Settled Quantity is the quantity of the security that is fully settled as of market close date
in: query
required: false
schema:
type: number
format: double
parameter-19167:
name: POOL_ID_CD
description: Pool ID is an alphanumeric code that identifies a particular mortgage backed security.
in: query
required: false
schema:
type: string
parameter-19157:
name: ISSR_LOC_NME
description: 'Issuer Location is the name of the country where the issuer of the security is based. Values include: Argentina (AR), Canada (CA), Ireland (IE), etc.'
in: query
required: false
schema:
type: string
parameter-13444:
name: SEC_SUB_TYP_CD
description: 'Issue Type Code is a code linked to the Issue Type parameter which describes the type of security instrument. Values include: 1 (ADR Convertible), 12 (Bond), 19 (Bond Convertible), etc.'
in: query
required: false
schema:
type: string
parameter-13476:
name: SID_TICKER_SYMB
description: Ticker is the symbol used on the exchange to identify the security.
in: query
required: false
schema:
type: string
parameter-19163:
name: PMT_FREQY_DESC
description: 'Payment Frequency Description indicates how often interest is paid on the security. Values include: Annual (00001), Sem-Annual (00002), One Payment Per Year (00035), etc.'
in: query
required: false
schema:
type: string
parameter-19160:
name: MKT_VAL_AMT
description: The market price of the holding multiplied by the number of units or shares held. Usually, the monetary value of the holding. This is the indicative valuation of the position at EOD using the Issue Price supplied.
in: query
required: false
schema:
type: number
format: double
parameter-29118:
name: FCTR_DTE
description: Factor Date is the date the current factor is applicable from for principal paying securities.
in: query
required: false
schema:
type: string
format: date-time
parameter-19122:
name: SEC_GROUP
description: 'Asset Type is a code representing the Asset Type of the security. Values include: EQTY (Equity), FI (Fixed Income), etc.'
in: query
required: false
schema:
type: string
parameter-48543:
name: TRDED_QTY_MKT_EOD
description: Traded Quantity is the quantity of the security held including any open trades as of market close date
in: query
required: false
schema:
type: number
format: double
parameter-13483:
name: ACCT_NME
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
in: query
required: false
schema:
type: string
parameter-13517:
name: ISS_TMS
description: Issue Date is the date of first issue of the security.
in: query
required: false
schema:
type: string
format: date-time
parameter-19114:
name: BR_ID
description: Branch Code is the identifier of the branch for the account. For the Cash Account the branch code is a numeric value and for the Safekeeping Account it is the ISO Country code.
in: query
required: false
schema:
type: string
parameter-19237:
name: SID_LOCAL
description: Local ID is the Local security identifier of the associated security.
in: query
required: false
schema:
type: string
parameter-19183:
name: STRK_PRC_AMT
description: Strike Price is the specified price on an options contract at which the contract may be exercised.
in: query
required: false
schema:
type: number
format: double
parameter-29116:
name: IOD_UPDATE_TMS
description: IOD Timestamp
in: query
required: false
schema:
type: string
format: date-time
parameter-13519:
name: US_SIC_CD
description: SIC is the Standard Industrial Classification four-digit numeric code.
in: query
required: false
schema:
type: string
parameter-19174:
name: SID_SEDOL
description: SEDOL (Stock Exchange Daily Official List) is a unique identification code, consisting of seven alphanumeric characters, that is assigned to all securities trading on the London Stock Exchange.
in: query
required: false
schema:
type: string
parameter-13526:
name: SID_LOCAL
description: Local ID is the Local security identifier of the associated security.
in: query
required: false
schema:
type: string
parameter-19151:
name: SEC_DESC
description: Issue Description contains the name and other details of the instrument.
in: query
required: false
schema:
type: string
parameter-29075:
name: SETLD_QTY
description: Settled Quantity is the quantity of the security that is fully settled at the "As Of" date.
in: query
required: false
schema:
type: number
format: double
parameter-19205:
name: EOD_INTRA_IND
description: 'EOD/intraday Indicator advises if the balance is an End of Day reported balance or if the balance is an Intraday reported balance. Values are:
1 (Intraday)
2 (End of Day)'
in: query
required: false
schema:
type: string
parameter-41566:
name: CNTRY_CD
description: The Country Code (location) of the security custodian. Not applicable to the US domestic positions.
in: query
required: false
schema:
type: string
parameter-41728:
name: VALUE_DT
description: Value Date is the date on which the cash posting corresponding to this trade will have value.
in: query
required: false
schema:
type: string
format: date
parameter-49564:
name: TRAN_NOTES
description: The transaction notes
in: query
required: false
schema:
type: string
parameter-41734:
name: PARTICIPANT_NO
description: DTC Number is the participant or sub-account number at DTCC.
in: query
required: false
schema:
type: string
parameter-41579:
name: FAIL_DESC
description: Fail Description provides the reason why the trade has not or is not expected to settle on the contractual settlement date.
in: query
required: false
schema:
type: string
parameter-41556:
name: ACT_SETT_DT
description: Actual Settlement Date is the date of final settlement of the trade.
in: query
required: false
schema:
type: string
format: date
parameter-41572:
name: SEC_CCY
description: Denomination Currency Code is the ISO 4217 currency code in which the security is denominated, in the local market.
in: query
required: false
schema:
type: string
parameter-41738:
name: FCTR_DTE
description: Factor Date is the date the current factor is applicable from for principal paying securities.
in: query
required: false
schema:
type: string
format: date-time
parameter-41617:
name: TICKER
description: Ticker is the symbol used on the exchange to identify the security.
in: query
required: false
schema:
type: string
parameter-41571:
name: HOLDING_TYPE
description: How Position is Held is a description of the status of the holding affected by the trade, or where that holding is held.
in: query
required: false
schema:
type: string
parameter-41612:
name: SETT_QTY
description: Settled Quantity is the quantity that has settled or the quantity of the security that is fully settled at the "As Of" date. For partial settlements the settled quantity is the portion that has settled.
in: query
required: false
schema:
type: number
format: double
parameter-41708:
name: PLDG_ABA_NO
description: ABA Number is the American Bankers Association Transit Number - used to identify a US institution.
in: query
required: false
schema:
type: string
parameter-41619:
name: TRANS_TYP
description: Transaction Type indicates the direction of the trade. Values are Receive Free, Receive Versus Payment, Deliver Free, Delivery Versus Payment, etc.
in: query
required: false
schema:
type: string
parameter-42371:
name: LAST_CHANGE_TIMESTAMP
description: Last Change Timestamp
in: query
required: false
schema:
type: string
format: date-time
parameter-41711:
name: SEC_LEND_FLG
description: Securities Lending Flag indicates that the trade is a securities lending transaction.
in: query
required: false
schema:
type: string
parameter-41694:
name: FAIL_TXT
description: Fail Text provides additional information on the reason for failure.
in: query
required: false
schema:
type: string
parameter-41560:
name: FAIL_TEXT
description: Fail Text provides additional information to the Fail/Market Status for failing trades.
in: query
required: false
schema:
type: string
parameter-41559:
name: RELATED_REF
description: Related Reference is the value provided via RELA tag on the underlying instruction.
in: query
required: false
schema:
type: string
parameter-41716:
name: UPDATE_TMS
description: Created Timestamp is the date and time of when an item was loaded to the source system.
in: query
required: false
schema:
type: string
format: date-time
parameter-41754:
name: TICKER
description: Ticker is the symbol used on the exchange to identify the security.
in: query
required: false
schema:
type: string
parameter-41681:
name: RELATED_REF
description: Related Reference is the value provided via RELA tag on the underlying instruction.
in: query
required: false
schema:
type: string
parameter-41686:
name: CLR_BRKR_NME
description: Clearing Broker Name is the name of the firm that guarantees the obligations of the parties in an exchange traded security or derivative transaction.
in: query
required: false
schema:
type: string
parameter-41578:
name: FAIL_AGE
description: Fail Age is the number of days the transaction has not settled, past the contractual settlement date.
in: query
required: false
schema:
type: integer
format: int32
parameter-41699:
name: SETT_CCY
description: Settlement Currency is the currency name for the Settlement Amount.
in: query
required: false
schema:
type: string
parameter-41596:
name: SEC_ID_TYPE
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID field. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
in: query
required: false
schema:
type: string
parameter-41750:
name: ISSUE_TYP
description: 'Issue Type is a description of the type of the security instrument. Values include: ADR Convertible (1), Bond (12) , Bond Convertible (19), etc.'
in: query
required: false
schema:
type: string
parameter-41569:
name: CURR_FCTR_RATE
description: Current Factor is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
in: query
required: false
schema:
type: number
format: double
parameter-41622:
name: REAG_DEAG
description: Settlement Counterparty is the name associated to the underlying instruction's REAG/DEAG tag if provided.
in: query
required: false
schema:
type: string
parameter-41591:
name: LOAN_REF_ID
description: The Loan Reference Number is the number assigned to 3rd party lending transactions. This is for US domestic only.
in: query
required: false
schema:
type: string
parameter-41739:
name: ISS_TMS
description: Issue Date is the date of first issue of the security.
in: query
required: false
schema:
type: string
format: date-time
parameter-41563:
name: BUYR_SELL_CD
description: Buyer/Seller Code is the code associated to the Buyer/Seller.
in: query
required: false
schema:
type: string
parameter-41718:
name: TRANS_TYP
description: Transaction Type indicates the direction of the trade. Values are Receive Free, Receive Versus Payment, Deliver Free, Delivery Versus Payment, etc.
in: query
required: false
schema:
type: string
parameter-41599:
name: PLDG_ABA_NAM
description: American Bankers Association Description is the name of the institution identified by the ABA number.
in: query
required: false
schema:
type: string
parameter-41695:
name: INST_DT
description: Instruction Date is the date the trade was first received.
in: query
required: false
schema:
type: string
format: date
parameter-41606:
name: SEC_LEND_FLG
description: Securities Lending Flag indicates that the trade is a securities lending transaction.
in: query
required: false
schema:
type: string
parameter-41553:
name: ACCT_BASE_NBR
description: Account Base Number is an internal Citi client identifier that is associated to a Safekeeping or Cash Account.
in: query
required: false
schema:
type: string
parameter-41581:
name: INST_DT
description: Instruction Date is the date the trade was first received.
in: query
required: false
schema:
type: string
format: date
parameter-49560:
name: TRAN_NOTES
description: The transaction notes
in: query
required: false
schema:
type: string
parameter-41585:
name: SETT_AMT
description: Settlement Amount is the cash value of the partial settlement in the local currency.
in: query
required: false
schema:
type: number
format: double
parameter-41751:
name: CUSIP
description: CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.
in: query
required: false
schema:
type: string
parameter-41727:
name: PLACE_OF_SETLMT_CD
description: Place Of Settlement code is the code associated with the Place of Settlement or Depository Centre Code for the security.
in: query
required: false
schema:
type: string
parameter-41741:
name: ISSR_LOC_NME
description: 'Issuer Location is the name of the country where the issuer of the security is based. Values include: Argentina (AR), Canada (CA), Ireland (IE), etc.'
in: query
required: false
schema:
type: string
parameter-41557:
name: BR_ID
description: Branch Code is the identifier of the branch for the account. For the Cash Account the branch code is a numeric value and for the Safekeeping Account it is the ISO Country code.
in: query
required: false
schema:
type: string
select_7:
name: $select
in: query
description: The $SELECT parameter in an API allows users to specify which data fields (properties or columns) they want to receive in the API response. This helps improve efficiency by reducing the amount of data transferred and simplifying client-side processing.
required: false
schema:
type: string
parameter-41602:
name: PREV_FCTR_RATE
description: Previous Factor is the factor which applies to the last accrual period to determine payments and balances for principal paying securities.
in: query
required: false
schema:
type: number
format: double
parameter-41704:
name: PART_UNSETL_QTY
description: Unsettled Quantity shows the quantity that is still yet to settle when there is a partial settlement of the trade.
in: query
required: false
schema:
type: number
format: double
parameter-49549:
name: MITI_REF
description: Market Infrastructure Transaction Identification Reference number
in: query
required: false
schema:
type: string
parameter-41615:
name: ISIN
description: ISIN (International Securities Identification Number) is a 12-character alpha-numerical code that does not contain information characterizing financial instruments but serves for uniform identification of a security at trading and settlement.
in: query
required: false
schema:
type: string
parameter-41594:
name: PARTIAL_SETTLEMENT_FLAG
description: Partial Settlement Flag indicates if the trades data contains partial settlements details.
in: query
required: false
schema:
type: string
parameter-41722:
name: TRADE_DT
description: Trade Date is the date a transaction is effected or executed.
in: query
required: false
schema:
type: string
format: date-time
parameter-41732:
name: BR_ID
description: Branch Code is the identifier of the branch for the account. For the Cash Account the branch code is a numeric value and for the Safekeeping Account it is the ISO Country code.
in: query
required: false
schema:
type: string
parameter-41625:
name: TRN_CL_CD
description: 'Transaction Class is the transaction type code for securities transactions. Values include: ADJ (Adjustment), BIDS, BOE, BUY, CAPD, CAPG, CAPGL, DF (Deliver Free), DIV (Dividend), DRAW, DRIP, DVCA, etc.'
in: query
required: false
schema:
type: string
parameter-41729:
name: ACCT_BASE_NBR
description: Account Base Number is an internal Citi client identifier that is associated to a Safekeeping or Cash Account.
in: query
required: false
schema:
type: string
parameter-41554:
name: ACCT_ID
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-41627:
name: SIGNED_QTY
description: The signed quantity based on the type of a transaction. The value would be positive in case of a receive, and it would be negative in case of a deliver.
in: query
required: false
schema:
type: number
format: double
parameter-41558:
name: BR_NME
description: Branch Name is the name of the branch for the Cash Account and/or Safekeeping Account.
in: query
required: false
schema:
type: string
parameter-41744:
name: SEC_ID
description: Security ID is the most commonly used identifier for the security in a given market.
in: query
required: false
schema:
type: string
parameter-49559:
name: CRTD_TMS
description: Created Timestamp (CR) is the date and time of when an item was loaded to the Reporting database. Applicable to intraday information only.
in: query
required: false
schema:
type: string
format: date-time
parameter-41611:
name: ISSUE_TYP
description: 'Issue Type is a description of the type of the security instrument. Values include: ADR Convertible (1), Bond (12) , Bond Convertible (19), etc.'
in: query
required: false
schema:
type: string
parameter-41733:
name: BR_NME
description: Branch Name is the name of the branch for the Cash Account and/or Safekeeping Account.
in: query
required: false
schema:
type: string
parameter-41562:
name: CLIENT_REF
description: Client Reference is a unique number assigned by the client, to the transaction, for identification purposes within their organization.
in: query
required: false
schema:
type: string
parameter-41628:
name: PLACE_OF_SETLMT_CD
description: Place Of Settlement code is the code associated with the Place of Settlement or Depository Centre Code for the security.
in: query
required: false
schema:
type: string
parameter-41614:
name: CUSIP
description: CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.
in: query
required: false
schema:
type: string
parameter-41740:
name: ISSR_LOC_CD
description: 'Issuer Location Code is the ISO country code where the issuer of the security is based. Values include: AR (Argentina), CA (Canada), IE (Ireland), etc.'
in: query
required: false
schema:
type: string
parameter-41620:
name: TRANS_REF_NBR
description: Custodian Reference is the unique reference assigned by the Custodian to the record. The reference number is unique within a branch.
in: query
required: false
schema:
type: string
parameter-41605:
name: ASSET_TYP
description: 'Asset Type is a code representing the Asset Type of the security. Values include: EQTY (Equity), FI (Fixed Income), etc.'
in: query
required: false
schema:
type: string
parameter-41737:
name: SEC_CCY
description: Denomination Currency Code is the ISO 4217 currency code in which the security is denominated, in the local market.
in: query
required: false
schema:
type: string
parameter-41589:
name: LOAN_PURPOSE_CD
description: Loan Purpose Code is a code that identifies the purpose of the loan transaction if the position is on loan.
in: query
required: false
schema:
type: string
parameter-41692:
name: FAIL_AGE
description: Fail Age is the number of days the transaction has not settled, past the contractual settlement date.
in: query
required: false
schema:
type: integer
format: int32
parameter-41561:
name: TRD_STATUS
description: Transaction Status
in: query
required: false
schema:
type: string
parameter-42372:
name: COB_DATE
description: Close of Business Date
in: query
required: false
schema:
type: string
format: date
parameter-41687:
name: CONTR_SETT_DT
description: Contractual Settlement Date is the date when the clients cash account should be credited with funds on a sale (and debited on a purchase) on the due settlement date in place of when a trade actually settles in the market.
in: query
required: false
schema:
type: string
format: date-time
parameter-41565:
name: CONTR_SETT_DT
description: Contractual Settlement Date is the date when the clients cash account should be credited with funds on a sale (and debited on a purchase) on the due settlement date in place of when a trade actually settles in the market.
in: query
required: false
schema:
type: string
format: date-time
parameter-41714:
name: SETT_QTY
description: Settled Quantity is the quantity that has settled or the quantity of the security that is fully settled at the "As Of" date. For partial settlements the settled quantity is the portion that has settled.
in: query
required: false
schema:
type: number
format: double
parameter-41626:
name: TRANS_CLASS
description: Transaction Classification describes the category of trade. Values include MARKET TRADES, SECURITIES LENDING TRANSACTIONS, etc.
in: query
required: false
schema:
type: string
parameter-41583:
name: ISSR_LOC_CD
description: 'Issuer Location Code is the ISO country code where the issuer of the security is based. Values include: AR (Argentina), CA (Canada), IE (Ireland), etc.'
in: query
required: false
schema:
type: string
parameter-41616:
name: SEDOL
description: SEDOL (Stock Exchange Daily Official List) is a unique identification code, consisting of seven alphanumeric characters, that is assigned to all securities trading on the London Stock Exchange.
in: query
required: false
schema:
type: string
parameter-41712:
name: QUANTITY
description: Quantity provides the number of units, par value or nominal value (for fixed income instruments), amount of currency (for FX transactions), or number of shares. Indicates the contract quantity on the original transaction that was given up.
in: query
required: false
schema:
type: number
format: double
parameter-41719:
name: TRANS_REF_NBR
description: Custodian Reference is the unique reference assigned by the Custodian to the record. The reference number is unique within a branch.
in: query
required: false
schema:
type: string
parameter-41710:
name: CASH_ACCT_ID
description: Cash Account ID is the account id of the cash account which will be credited or debited at settlement for the trade.
in: query
required: false
schema:
type: string
parameter-49548:
name: MARKET_REF
description: Market Infrastructure reference
in: query
required: false
schema:
type: string
parameter-41582:
name: ISS_TMS
description: Issue Date is the date of first issue of the security.
in: query
required: false
schema:
type: string
format: date-time
parameter-41748:
name: ISSUE_NME
description: Issue Name is the Security Name of the security instrument.
in: query
required: false
schema:
type: string
parameter-41701:
name: LOAN_PURPOSE_CD
description: Loan Purpose Code is a code that identifies the purpose of the loan transaction if the position is on loan.
in: query
required: false
schema:
type: string
parameter-41752:
name: ISIN
description: ISIN (International Securities Identification Number) is a 12-character alpha-numerical code that does not contain information characterizing financial instruments but serves for uniform identification of a security at trading and settlement.
in: query
required: false
schema:
type: string
parameter-41603:
name: CASH_ACCT_ID
description: Cash Account ID is the account id of the cash account which will be credited or debited at settlement for the trade.
in: query
required: false
schema:
type: string
parameter-41717:
name: SWIFT_STATUS
description: SWIFT Status is the combined SWIFT 25D and 24B status codes as would be shown in an MT537 message.
in: query
required: false
schema:
type: string
parameter-41697:
name: SETT_AMT
description: Settlement Amount is the cash value of the partial settlement in the local currency.
in: query
required: false
schema:
type: number
format: double
parameter-41713:
name: SEC_SHORT_IND
description: Short Flag indicates if the transaction can be processed or if it cannot be processed due to a short position.
in: query
required: false
schema:
type: string
parameter-49550:
name: MATCHING_REF
description: The Market Infrastructure reference under which transaction has matched
in: query
required: false
schema:
type: string
parameter-41623:
name: TRADE_DT
description: Trade Date is the date a transaction is effected or executed.
in: query
required: false
schema:
type: string
format: date-time
parameter-41595:
name: PARTICIPANT_NO
description: DTC Number is the participant or sub-account number at DTCC.
in: query
required: false
schema:
type: string
parameter-41700:
name: LOAN_DT
description: Loan Date is the date the loan originated.
in: query
required: false
schema:
type: string
format: date
parameter-55291:
name: DTC_FED_IDENTIFIER
description: It describes indicator values of trades settled in DTC (Depository Trust Company) or FED (Federal) location from market via SMI (Securities Market Interface).
in: query
required: false
schema:
type: string
parameter-41746:
name: SEC_DESC
description: Issue Description contains the name and other details of the instrument.
in: query
required: false
schema:
type: string
parameter-41731:
name: ACCT_NME
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
in: query
required: false
schema:
type: string
parameter-55295:
name: DTC_FED_IDENTIFIER
description: It describes indicator values of trades settled in DTC (Depository Trust Company) or FED (Federal) location from market via SMI (Securities Market Interface).
in: query
required: false
schema:
type: string
parameter-41600:
name: PLDG_ABA_NO
description: ABA Number is the American Bankers Association Transit Number - used to identify a US institution.
in: query
required: false
schema:
type: string
parameter-41588:
name: LOAN_DT
description: Loan Date is the date the loan originated.
in: query
required: false
schema:
type: string
format: date
parameter-42176:
name: TRADE_STATUS_VALUES
description: It provides the logical value of the trade status.
in: query
required: false
schema:
type: string
parameter-41597:
name: SEC_ID
description: Security ID is the most commonly used identifier for the security in a given market.
in: query
required: false
schema:
type: string
parameter-41590:
name: LOAN_PURPOSE_DESC
description: Loan Purpose is the description of the purpose of the loan transaction if the position is on loan.
in: query
required: false
schema:
type: string
parameter-49542:
name: MARKET_REF
description: Market Reference
in: query
required: false
schema:
type: string
parameter-42167:
name: TRADE_STATUS_VALUES
description: It provides the logical value of the trade status.
in: query
required: false
schema:
type: string
parameter-41698:
name: LCL_CUR_CD
description: Settlement Currency Code is the ISO currency code of the local currency of the Settlement Amount.
in: query
required: false
schema:
type: string
parameter-41568:
name: CONTR_SETT_FLG
description: Contractual Settlement Flag indicates whether the trade will settle on the Contractual Settlement Date whether or not it actually settles. Values are Y (settle on contractual settlement date) or N (settle on actual settlement date).
in: query
required: false
schema:
type: string
parameter-41601:
name: PLDG_REF_NBR
description: Pledge Reference is the unique reference number for the pledge transaction.
in: query
required: false
schema:
type: string
parameter-41587:
name: SETT_CCY
description: Settlement Currency is the currency name for the Settlement Amount.
in: query
required: false
schema:
type: string
parameter-41555:
name: ACCT_NME
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
in: query
required: false
schema:
type: string
parameter-41726:
name: SIGNED_QTY
description: The signed quantity based on the type of a transaction. The value would be positive in case of a receive, and it would be negative in case of a deliver.
in: query
required: false
schema:
type: number
format: double
parameter-41610:
name: ISSUE_TYP_CD
description: 'Issue Type Code is a code linked to the Issue Type field which describes the type of security instrument. Values include: 1 (ADR Convertible), 12 (Bond), 19 (Bond Convertible), etc.'
in: query
required: false
schema:
type: string
parameter-55414:
name: SETD_CMB_QTY
description: Settled Quantity.
in: query
required: false
schema:
type: number
format: double
parameter-41745:
name: PREV_FCTR_RATE
description: Previous Factor is the factor which applies to the last accrual period to determine payments and balances for principal paying securities.
in: query
required: false
schema:
type: number
format: double
parameter-41702:
name: LOAN_PURPOSE_DESC
description: Loan Purpose is the description of the purpose of the loan transaction if the position is on loan.
in: query
required: false
schema:
type: string
parameter-41720:
name: REAG_DEAG_CD
description: Settlement Counterparty Code is the code associated to the Settlement Counterparty.
in: query
required: false
schema:
type: string
parameter-41723:
name: TRN_CD
description: 'Transaction Type reflects the code of the transaction type. Sample Values returned: SLS (Securities Lending System); CONV; ISWAP.'
in: query
required: false
schema:
type: string
parameter-41749:
name: ISSUE_TYP_CD
description: 'Issue Type Code is a code linked to the Issue Type field which describes the type of security instrument. Values include: 1 (ADR Convertible), 12 (Bond), 19 (Bond Convertible), etc.'
in: query
required: false
schema:
type: string
parameter-41592:
name: MATY_DT
description: Maturity Date is the date of maturity or redemption for fixed income securities.
in: query
required: false
schema:
type: string
format: date-time
parameter-49544:
name: MATCHING_REF
description: Matching reference
in: query
required: false
schema:
type: string
parameter-41607:
name: QUANTITY
description: Quantity provides the number of units, par value or nominal value (for fixed income instruments), amount of currency (for FX transactions), or number of shares. Indicates the contract quantity on the original transaction that was given up.
in: query
required: false
schema:
type: number
format: double
parameter-41685:
name: BUYR_SELL_CD
description: Buyer/Seller Code is the code associated to the Buyer/Seller.
in: query
required: false
schema:
type: string
parameter-41736:
name: CURR_FCTR_RATE
description: Current Factor is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
in: query
required: false
schema:
type: number
format: double
parameter-41598:
name: PLACE_OF_SETLMT
description: Place Of Settlement is the name of the settlement location for the security, applicable to securities positions , transactions only.
in: query
required: false
schema:
type: string
parameter-41753:
name: SEDOL
description: SEDOL (Stock Exchange Daily Official List) is a unique identification code, consisting of seven alphanumeric characters, that is assigned to all securities trading on the London Stock Exchange.
in: query
required: false
schema:
type: string
parameter-41580:
name: FCTR_DTE
description: Factor Date is the date the current factor is applicable from for principal paying securities.
in: query
required: false
schema:
type: string
format: date-time
parameter-41680:
name: ACT_SETT_DT
description: Actual Settlement Date is the date of final settlement of the trade.
in: query
required: false
schema:
type: string
format: date
parameter-41682:
name: TRD_STATUS
description: Transaction Status
in: query
required: false
schema:
type: string
parameter-49563:
name: CRTD_TMS
description: Created Timestamp (CR) is the date and time of when an item was loaded to the Reporting database. Applicable to intraday information only.
in: query
required: false
schema:
type: string
format: date-time
parameter-41586:
name: SETT_CCY_CD
description: Settlement Currency Code is the ISO 4217 currency code for the Settlement Amount.
in: query
required: false
schema:
type: string
parameter-41609:
name: ISSUE_NME
description: Issue Name is the Security Name of the security instrument.
in: query
required: false
schema:
type: string
parameter-41689:
name: CONTR_SETT_FLG
description: Contractual Settlement Flag indicates whether the trade will settle on the Contractual Settlement Date whether or not it actually settles. Values are Y (settle on contractual settlement date) or N (settle on actual settlement date).
in: query
required: false
schema:
type: string
parameter-41706:
name: PLACE_OF_SETLMT
description: Place Of Settlement is the name of the settlement location for the security, applicable to securities positions , transactions only.
in: query
required: false
schema:
type: string
parameter-41721:
name: REAG_DEAG
description: Settlement Counterparty is the name associated to the underlying instruction's REAG/DEAG tag if provided.
in: query
required: false
schema:
type: string
parameter-41690:
name: DEAL_REF_NBR
description: OTM Reference is the Order and Trade Manager Reference number that has been assigned to the order instructions.
in: query
required: false
schema:
type: string
parameter-41693:
name: FAIL_DESC
description: Fail Description provides the reason why the trade has not or is not expected to settle on the contractual settlement date.
in: query
required: false
schema:
type: string
parameter-41747:
name: ASSET_TYP
description: 'Asset Type is a code representing the Asset Type of the security. Values include: EQTY (Equity), FI (Fixed Income), etc.'
in: query
required: false
schema:
type: string
parameter-41604:
name: SEC_DESC
description: Issue Description contains the name and other details of the instrument.
in: query
required: false
schema:
type: string
parameter-49543:
name: MITI_REF
description: Market Infrastructure Transaction Identification Reference number
in: query
required: false
schema:
type: string
parameter-41688:
name: COMP_DESC
description: Company Description contains information regarding the company which issued the security.
in: query
required: false
schema:
type: string
parameter-41679:
name: ACCT_ID
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-41564:
name: BUYR_SELL
description: Buyer/Seller is the name associated to the underlying instruction's BUYR/SELL tag if provided.
in: query
required: false
schema:
type: string
parameter-41584:
name: ISSR_LOC_NME
description: 'Issuer Location is the name of the country where the issuer of the security is based. Values include: Argentina (AR), Canada (CA), Ireland (IE), etc.'
in: query
required: false
schema:
type: string
parameter-41705:
name: PARTIAL_SETTLEMENT_FLAG
description: Partial Settlement Flag indicates if the trades data contains partial settlements details.
in: query
required: false
schema:
type: string
parameter-41691:
name: HOLDING_TYPE
description: How Position is Held is a description of the status of the holding affected by the trade, or where that holding is held.
in: query
required: false
schema:
type: string
parameter-41567:
name: COMP_DESC
description: Company Description contains information regarding the company which issued the security.
in: query
required: false
schema:
type: string
parameter-41725:
name: TRANS_CLASS
description: Transaction Classification describes the category of trade. Values include MARKET TRADES, SECURITIES LENDING TRANSACTIONS, etc.
in: query
required: false
schema:
type: string
parameter-41618:
name: SWIFT_STATUS
description: SWIFT Status is the combined SWIFT 25D and 24B status codes as would be shown in an MT537 message.
in: query
required: false
schema:
type: string
parameter-41742:
name: MATY_DT
description: Maturity Date is the date of maturity or redemption for fixed income securities.
in: query
required: false
schema:
type: string
format: date-time
parameter-41707:
name: PLDG_ABA_NAM
description: American Bankers Association Description is the name of the institution identified by the ABA number.
in: query
required: false
schema:
type: string
parameter-55003:
name: DEPOT_ID
description: Depot code represents an account of Citi in local markets used for settlement. It can be either 3rd party agent, local Citi branch or CSD (Central Securities Depository).
in: query
required: false
schema:
type: string
parameter-55415:
name: CONSID_AMT_P
description: Settled Amount is the amount that has settled, corresponding to the Settled Quantity. Settled Amount will be less than Instructed Amount in partial settlements.
in: query
required: false
schema:
type: number
format: double
parameter-41715:
name: HOLDING_TYPE_CD
description: Location of Where Held is a code indicating the location of a holding. Examples include HD - Held At Depot and LE - Securities Lent.
in: query
required: false
schema:
type: string
parameter-41683:
name: CLIENT_REF
description: Client Reference is a unique number assigned by the client, to the transaction, for identification purposes within their organization.
in: query
required: false
schema:
type: string
parameter-41735:
name: CNTRY_CD
description: The Country Code (location) of the security custodian. Not applicable to the US domestic positions.
in: query
required: false
schema:
type: string
parameter-41621:
name: REAG_DEAG_CD
description: Settlement Counterparty Code is the code associated to the Settlement Counterparty.
in: query
required: false
schema:
type: string
parameter-41593:
name: PART_UNSETL_QTY
description: Unsettled Quantity shows the quantity that is still yet to settle when there is a partial settlement of the trade.
in: query
required: false
schema:
type: number
format: double
parameter-41613:
name: HOLDING_TYPE_CD
description: Location of Where Held is a code indicating the location of a holding. Examples include HD - Held At Depot and LE - Securities Lent.
in: query
required: false
schema:
type: string
parameter-41629:
name: VALUE_DT
description: Value Date is the date on which the cash posting corresponding to this trade will have value.
in: query
required: false
schema:
type: string
format: date
parameter-41577:
name: UPDATE_TMS
description: Created Timestamp is the date and time of when an item was loaded to the source system.
in: query
required: false
schema:
type: string
format: date-time
parameter-41624:
name: TRANS_TYP_CD
description: Transaction Type Code is the code associated to the Transaction Type.
in: query
required: false
schema:
type: string
parameter-41570:
name: DEAL_REF_NBR
description: OTM Reference is the Order and Trade Manager Reference number that has been assigned to the order instructions.
in: query
required: false
schema:
type: string
parameter-41724:
name: TRANS_CLASS_CD
description: 'Transaction Class is the transaction type code for securities transactions. Values include: ADJ (Adjustment), BIDS, BOE, BUY, CAPD, CAPG, CAPGL, DF (Deliver Free), DIV (Dividend), DRAW, DRIP, DVCA, etc.'
in: query
required: false
schema:
type: string
parameter-41743:
name: SEC_ID_TYPE
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID field. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
in: query
required: false
schema:
type: string
parameter-41703:
name: LOAN_REF_ID
description: The Loan Reference Number is the number assigned to 3rd party lending transactions. This is for US domestic only.
in: query
required: false
schema:
type: string
parameter-41709:
name: PLDG_REF_NBR
description: Pledge Reference is the unique reference number for the pledge transaction.
in: query
required: false
schema:
type: string
parameter-41608:
name: SEC_SHORT_IND
description: Short Flag indicates if the transaction can be processed or if it cannot be processed due to a short position.
in: query
required: false
schema:
type: string
parameter-14981:
name: ACCT_BUS_TYP_CD
description: 'Account Type Code indicates the type of the account. Values are: C (Cash Account), S (Safekeeping Account).'
in: query
required: false
schema:
type: string
parameter-29401:
name: AMT_RECVED_CCY
description: Reclaim Amount Received is the value of the refund received from the Tax Authority excluding interest, expressed in the currency of the reclaim
in: query
required: false
schema:
type: number
format: double
parameter-29417:
name: TAX_PAID_USD
description: Local Tax (WHT Paid) (USD) is the value of tax withheld expressed in US dollar currency
in: query
required: false
schema:
type: number
format: double
parameter-14758:
name: BR_ID
description: Branch Code is the identifier of the branch for the account. For the Cash Account the branch code is a numeric value and for the Safekeeping Account it is the ISO Country code.
in: query
required: false
schema:
type: string
parameter-14985:
name: ACCT_NME
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
in: query
required: false
schema:
type: string
parameter-29435:
name: NET_DIV_GBP
description: Net Dividend (GBP) is the value of is the dividend net of withholding tax expressed in British pound currency
in: query
required: false
schema:
type: number
format: double
parameter-29407:
name: GROSS_DIV_EUR
description: Gross Dividend (EUR) is the value of the Gross Dividend expressed in Euro currency
in: query
required: false
schema:
type: number
format: double
parameter-14984:
name: ACCT_ID
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-14998:
name: SEC_SECURITY_CD
description: CITI Internal Security Code is the identifier of the CITI Internal Security Identifier.
in: query
required: false
schema:
type: string
parameter-29403:
name: AMT_RECVED_GBP
description: Reclaim Amount Received (GBP) is the value of the refund received from the Tax Authority expressed in British pound currency
in: query
required: false
schema:
type: number
format: double
parameter-29438:
name: OVERRIDE_CNTRY_ID_TRS
description: Security Domicile (Stock Residency) is the country in which tax was withheld and where tax will be reclaimed
in: query
required: false
schema:
type: number
format: double
parameter-15032:
name: STRK_PRC_AMT
description: Strike Price is the specified price on an options contract at which the contract may be exercised.
in: query
required: false
schema:
type: number
format: double
parameter-14991:
name: GFC_ID
description: Client ID is an identifier that is available on a Cash Account and/or a Safekeeping Account. This Client ID is referred to, internally at Citi, as a GFCID.
in: query
required: false
schema:
type: string
parameter-29436:
name: NET_DIV_USD
description: Net Dividend (USD) is the value of is the dividend net of withholding tax expressed in US dollar currency
in: query
required: false
schema:
type: number
format: double
parameter-29396:
name: DATE_SENT_TO_LTA
description: Date sent to LTA is the date when the reclaim was submitted to the local tax authority
in: query
required: false
schema:
type: string
format: date
parameter-15013:
name: FCTR_DTE
description: Factor Date is the date the current factor is applicable from for principal paying securities.
in: query
required: false
schema:
type: string
format: date-time
parameter-29428:
name: RECLM_VAL_USD
description: Reclaim Amount (USD) is the value of the amount being reclaimed expressed in US dollar currency
in: query
required: false
schema:
type: number
format: double
parameter-29395:
name: DATE_SENT_TO_FTA
description: Date sent to FTA is the date when the reclaim was submitted to the foreign tax authority
in: query
required: false
schema:
type: string
format: date
parameter-29414:
name: TAX_PAID_CCY
description: Local Tax (WHT Paid) is the value of tax withheld expressed in the currency of the reclaim
in: query
required: false
schema:
type: number
format: double
parameter-14988:
name: ALTV_CUR_CD
description: Account Base Currency Code is the ISO Currency Code for the account.
in: query
required: false
schema:
type: string
parameter-29413:
name: EQUIVAL_RATE_CCY
description: Equivalent Rate is the dividend rate per share expressed in the currency of the reclaim
in: query
required: false
schema:
type: number
format: double
parameter-15033:
name: US_SIC_CD
description: SIC is the Standard Industrial Classification four-digit numeric code.
in: query
required: false
schema:
type: string
parameter-29391:
name: RECONCILIATION_DATE
description: Receipt Date is the date when the funds were credited into client's cash account
in: query
required: false
schema:
type: string
format: date
parameter-29375:
name: ENTITY_TYPE
description: 'Entity Type (Fiscal Type) is the Beneficial Owner entity type (i.e.: corporate, Pension Fund, etc.)'
in: query
required: false
schema:
type: string
parameter-29402:
name: AMT_RECVED_EUR
description: Reclaim Amount Received (EUR) is the value of the refund received from the Tax Authority expressed in Euro currency
in: query
required: false
schema:
type: number
format: double
parameter-15018:
name: ISS_CATG_CD
description: 'Issue Category Code is a specific category for the security. Values include: CSTK (Common Stock), DERIV (Derivatives), MBS (Mortgage Backed Securities), etc.'
in: query
required: false
schema:
type: string
parameter-29426:
name: RECLM_VAL_GBP
description: Reclaim Amount (GBP) is the value of the amount being reclaimed expressed in British pound currency
in: query
required: false
schema:
type: number
format: double
parameter-29400:
name: ALLOCATED_HOLDING
description: Holding Value is the number of reclaimable shares per reclaim
in: query
required: false
schema:
type: number
format: double
parameter-29384:
name: INCOME_ACCOUNT
description: Cash Account is the cash account number the income was paid to
in: query
required: false
schema:
type: string
select_8:
name: $select
in: query
description: The $SELECT parameter in an API allows users to specify which data fields (properties or columns) they want to receive in the API response. This helps improve efficiency by reducing the amount of data transferred and simplifying client-side processing.
required: false
schema:
type: string
parameter-29415:
name: TAX_PAID_EUR
description: Local Tax (WHT Paid) (EUR) is the value of tax withheld expressed in Euro currency
in: query
required: false
schema:
type: number
format: double
parameter-15016:
name: INCM_PROJN_RATE
description: Interest Rate is the coupon rate of the security.
in: query
required: false
schema:
type: number
format: double
parameter-29368:
name: COUNTRY
description: Country is the reclaim market
in: query
required: false
schema:
type: string
parameter-15030:
name: SEC_SUB_TYP_CD
description: 'Issue Type Code is a code linked to the Issue Type field which describes the type of security instrument. Values include: 1 (ADR Convertible), 12 (Bond), 19 (Bond Convertible), etc.'
in: query
required: false
schema:
type: string
parameter-29430:
name: INT_AMT_EUR
description: Interest Amount (EUR) is the amount of interest paid by the Foreign Tax Authority in addition to the tax reclaim value expressed in Euro currency
in: query
required: false
schema:
type: number
format: double
parameter-29388:
name: STATUS
description: Reclaim Status is the current status of the reclaim
in: query
required: false
schema:
type: string
parameter-29419:
name: TOTAL_AMT_RECVED_EUR
description: Reclaim Amount Received (EUR) is the value of the refund received from the Tax Authority including interest, expressed in Euro currency
in: query
required: false
schema:
type: number
format: double
parameter-29427:
name: RECLM_VAL_RCY
description: Reclaim Amount is the value of the amount being reclaimed expressed in the currency of the reclaim
in: query
required: false
schema:
type: number
format: double
parameter-29383:
name: MARKET
description: Depot Domicile is the Depot domicile (Country where the sub-account is held).
in: query
required: false
schema:
type: string
parameter-29431:
name: INT_AMT_GBP
description: Interest Amount (GBP) is the amount of interest paid by the Foreign Tax Authority in addition to the tax reclaim value expressed in British pound currency
in: query
required: false
schema:
type: number
format: double
parameter-29425:
name: RECLM_VAL_EUR
description: Reclaim Amount (EUR) is the value of the amount being reclaimed expressed in Euro currency
in: query
required: false
schema:
type: number
format: double
parameter-29420:
name: TOTAL_AMT_RECVED_GBP
description: Reclaim Amount Received (GBP) is the value of the refund received from the Tax Authority including interest, expressed in British pound currency
in: query
required: false
schema:
type: number
format: double
parameter-29366:
name: CODE_RATE_CURR
description: Rate Currency is the currency of the dividend
in: query
required: false
schema:
type: string
parameter-14990:
name: CASH_TYPE
description: Cash Type Code pertains to US Direct Cash Accounts and indicates whether the Cash Account has a split income and principal balance.
in: query
required: false
schema:
type: number
format: double
parameter-15029:
name: SEC_GROUP
description: 'Asset Type is a code representing the Asset Type of the security. Values include: EQTY (Equity), FI (Fixed Income), etc.'
in: query
required: false
schema:
type: string
parameter-15014:
name: INCM_CUR_CD
description: Income Currency Code is the ISO currency code in which income payments will be made for the security in the local market.
in: query
required: false
schema:
type: string
parameter-14997:
name: SEC_DESC
description: Issue Description contains the name and other details of the instrument.
in: query
required: false
schema:
type: string
parameter-15019:
name: ISS_TMS
description: Issue Date is the date of first issue of the security.
in: query
required: false
schema:
type: string
format: date-time
parameter-15017:
name: ISS_CAT_NME
description: 'Issue Category is the description for the Issue Category Code. Values include: Common Stock (CSTK), Derivatives (DERIV), Mortgage Backed Securities (MBS), etc.'
in: query
required: false
schema:
type: string
parameter-29424:
name: RECLAIM_RATE
description: Reclaim Rate is the percentage that the Ben Owner is entitled to reclaim back from the Foreign Tax Authorities (i.e. WHT Rate % less treaty rate)
in: query
required: false
schema:
type: number
format: double
parameter-29434:
name: NET_DIV_EUR
description: Net Dividend (EUR) is the value of is the dividend net of withholding tax expressed in Euro currency
in: query
required: false
schema:
type: number
format: double
parameter-29390:
name: PAY_DATE
description: Pay Date is the pay date of the dividend payment
in: query
required: false
schema:
type: string
format: date
parameter-29422:
name: WITH_RATE
description: WHT Rate is the rate of withholding tax applied to the income payment
in: query
required: false
schema:
type: number
format: double
parameter-31457:
name: UID
description: Indicates whether or not the record was inserted, updated or deleted in Custody Reporting.
in: query
required: false
schema:
type: string
parameter-29405:
name: HOLDING
description: Total Entitlement Holding Amount is the total number of shares at entitlement level.
in: query
required: false
schema:
type: number
format: double
parameter-29374:
name: ENTITLEMENT_REF
description: Entitlement Reference is the unique reference number generated from Citi internal systems for each line of taxable income
in: query
required: false
schema:
type: string
parameter-14989:
name: BR_NME
description: Branch Name is the name of the branch for the Cash Account and/or Safekeeping Account.
in: query
required: false
schema:
type: string
parameter-15024:
name: PFD_ID_CTXT_CD
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID field. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
in: query
required: false
schema:
type: string
parameter-15031:
name: SEC_SUB_TYP_NME
description: 'Issue Type is a description of the type of the security instrument. Values include: ADR Convertible (1), Bond (12) , Bond Convertible (19), etc.'
in: query
required: false
schema:
type: string
parameter-14987:
name: ACCT_STS_TYP
description: 'Account Status provides the current status of the Cash Account and/or the Safekeeping Account. Values are: Open, Closed, Frozen'
in: query
required: false
schema:
type: string
parameter-29404:
name: AMT_RECVED_USD
description: Reclaim Amount Received (USD) is the value of the refund received from the Tax Authority expressed in US dollar currency
in: query
required: false
schema:
type: number
format: double
parameter-29418:
name: TOTAL_AMT_RECVED_CCY
description: Reclaim Amount Received is the value of the refund received from the Tax Authority including interest, expressed in the currency of the reclaim
in: query
required: false
schema:
type: number
format: double
parameter-29408:
name: GROSS_DIV_GBP
description: Gross Dividend (GBP) is the value of the Gross Dividend expressed in British pound currency
in: query
required: false
schema:
type: number
format: double
parameter-15012:
name: DTED_TMS
description: Dated Date/Time is the date that the interest begins to accrue on a fixed-income security.
in: query
required: false
schema:
type: string
format: date-time
parameter-14992:
name: IBAN
description: IBAN is the International Bank Account Number for the Cash Account.
in: query
required: false
schema:
type: string
parameter-15008:
name: ACRL_BASIS_NME
description: Accrual Basis Description is the basis on which interest accrual is calculated, e.g. 30/360 meaning nominal 30 day months and a 360 day year.
in: query
required: false
schema:
type: string
parameter-15015:
name: INCM_CUR_NME
description: Income Currency Name is the name of the currency in which income payments will be made for the security in the local market.
in: query
required: false
schema:
type: string
parameter-29411:
name: FX_RATE_GBP
description: FX Rate (GBP) is the FX rate used to convert the reclaim currency into GBP
in: query
required: false
schema:
type: number
format: double
parameter-15007:
name: ACRL_BASIS_CDE
description: 'Accrual Basis Code is a code linked to the Accrual Basis field which indicates the basis on which interest accruals are calculated. Values include: 00043 (360 / 365), 00011 (360 / 360), 00063 (30 / 360 Non-EOM), etc.'
in: query
required: false
schema:
type: string
parameter-14996:
name: CMPNY_NME
description: Company Name is the name of the company which issued the security.
in: query
required: false
schema:
type: string
parameter-29432:
name: INT_AMT_USD
description: Interest Amount (USD) is the amount of interest paid by the Foreign Tax Authority in addition to the tax reclaim value expressed in US dollar currency
in: query
required: false
schema:
type: number
format: double
parameter-29365:
name: CLIENT_REF
description: Client Reference is a unique number assigned by the client, to the transaction, for identification purposes within their organization.
in: query
required: false
schema:
type: string
parameter-29412:
name: FX_RATE_USD
description: FX Rate (USD) is the FX rate used to convert the reclaim currency into USD
in: query
required: false
schema:
type: number
format: double
parameter-15001:
name: SID_BLOOMBERG
description: Bloomberg ID is the value supplied by Bloomberg to identify the security.
in: query
required: false
schema:
type: string
parameter-29410:
name: FX_RATE_EUR
description: FX Rate (EUR) is the FX rate used to convert the reclaim currency into EUR
in: query
required: false
schema:
type: number
format: double
parameter-14999:
name: SEC_SHRT_NME
description: Issue Name is the Security Name of the security instrument.
in: query
required: false
schema:
type: string
parameter-15022:
name: MATY_DT
description: Maturity Date is the date of maturity or redemption for fixed income securities.
in: query
required: false
schema:
type: string
format: date-time
parameter-29385:
name: RECLAIM_REF
description: Reclaim Reference is the unique identifying number for each reclaim in Citi system
in: query
required: false
schema:
type: string
parameter-15025:
name: PFD_ISS_ID
description: Security ID is the most commonly used identifier for the security in a given market.
in: query
required: false
schema:
type: string
parameter-29380:
name: ISIN
description: Alternate Security Code (ISIN) is the International Securities Identification Number.
in: query
required: false
schema:
type: string
parameter-29389:
name: PAYQUARTER
description: Pay Quarter is the pay quarter of the dividend
in: query
required: false
schema:
type: string
parameter-29362:
name: BEN_OWNER_NAME
description: Beneficial Owner Name is the name of the Beneficiary Owner of the reclaim
in: query
required: false
schema:
type: string
parameter-29394:
name: EX_DATE
description: Ex Date is the trading cut off date after which position changes will no longer alter the eligibility to the corporate action.
in: query
required: false
schema:
type: string
format: date
parameter-15023:
name: NXT_PAY_DT
description: Next Payable Date is the next date on which a dividend or interest payment is scheduled to be paid.
in: query
required: false
schema:
type: string
format: date
parameter-15026:
name: PMT_FREQY_DESC
description: 'Payment Frequency Description indicates how often interest is paid on the security. Values include: Annual (00001), Sem-Annual (00002), One Payment Per Year (00035), etc.'
in: query
required: false
schema:
type: string
parameter-29416:
name: TAX_PAID_GBP
description: Local Tax (WHT Paid) (GBP) is the value of tax withheld expressed in British pound currency
in: query
required: false
schema:
type: number
format: double
parameter-29386:
name: SEC_SHRTN
description: Security Name is the stock name of the security
in: query
required: false
schema:
type: string
parameter-29367:
name: CODE_RCLM_CURR
description: Reclaim Currency is the currency of the reclaim (currency in which the claim is made)
in: query
required: false
schema:
type: string
parameter-29364:
name: BO_DOMICILE
description: BO Domicile (Fiscal Domicile) is the Domicile of beneficial owner
in: query
required: false
schema:
type: string
parameter-29392:
name: STATUS_CHANGE_DATE
description: Status Date is the date on which the status was last changed
in: query
required: false
schema:
type: string
format: date
parameter-15020:
name: ISSR_LOC_CD
description: 'Issuer Location Code is the ISO country code where the issuer of the security is based. Values include: AR (Argentina), CA (Canada), IE (Ireland), etc.'
in: query
required: false
schema:
type: string
parameter-29393:
name: STATUTE_DTE
description: Statute Date is the last day the reclaim is in statute
in: query
required: false
schema:
type: string
format: date
parameter-29423:
name: PAYYEAR
description: Pay Year is the pay year of the dividend
in: query
required: false
schema:
type: number
format: double
parameter-14980:
name: ACCT_BASE_NBR
description: Account Base Number is an internal Citi client identifier that is associated to a Safekeeping or Cash Account.
in: query
required: false
schema:
type: string
parameter-15010:
name: DLAY_DAYS
description: Delay Days is the number of days from the issuance of an MBS pool (or from the beginning of the interest accrual period) until the first payment is remitted/paid to the holders.
in: query
required: false
schema:
type: string
parameter-29371:
name: DEPOT_CODE
description: Depot Code is the internal Citi identifier for the local sub account the securities are held on
in: query
required: false
schema:
type: string
parameter-15021:
name: ISSR_LOC_NME
description: 'Issuer Location is the name of the country where the issuer of the security is based. Values include: Argentina (AR), Canada (CA), Ireland (IE), etc.'
in: query
required: false
schema:
type: string
parameter-15009:
name: CURR_FCTR_RATE
description: Current Factor is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
in: query
required: false
schema:
type: number
format: double
parameter-14982:
name: ACCT_BUS_TYP_NME
description: Account Type Description indicates the type of the account. Values are CASH (C), S/K (S)
in: query
required: false
schema:
type: string
parameter-29409:
name: GROSS_DIV_USD
description: Gross Dividend (USD) is the value of the Gross Dividend expressed in US dollar currency
in: query
required: false
schema:
type: number
format: double
parameter-29377:
name: GERMAN_FILE_NUMBER
description: EFiling Serial# (Reclaim) is the reference no. for electronically filed reclaim submission
in: query
required: false
schema:
type: string
parameter-15011:
name: DNOMD_CUR_CD
description: Denomination Currency Code is the ISO currency code in which the security is denominated, in the local market.
in: query
required: false
schema:
type: string
parameter-29429:
name: INT_AMT_CCY
description: Interest Amount Received is the amount of interest paid by the Foreign Tax Authority in addition to the tax reclaim value expressed in the currency of the reclaim
in: query
required: false
schema:
type: number
format: double
parameter-29376:
name: FUND_NAME
description: Portfolio Name is the name of the safekeeping account
in: query
required: false
schema:
type: string
parameter-29373:
name: EFILE_REF
description: E-File Reference is Citi's unique reference for each electronic submission to Tax authorities (submission may contains more than 1 reclaim)
in: query
required: false
schema:
type: string
parameter-29363:
name: BO_BATCH_NO
description: Batch Number is Citi's unique reference for the reclaims submitted to the Tax authorities (submission may contains more than 1 reclaim)
in: query
required: false
schema:
type: string
parameter-29382:
name: LOCAL_TAX_ID
description: Tax ID is the Beneficial Owner local Tax ID
in: query
required: false
schema:
type: string
parameter-15088:
name: PAYABLE_DATE
description: Payable Date is the date on which a dividend or interest payment is scheduled to be paid.
in: query
required: false
schema:
type: string
format: date
parameter-15004:
name: SID_LOCAL
description: Local ID is the Local security identifier of the associated security.
in: query
required: false
schema:
type: string
parameter-29381:
name: ISSUER_TAX_ID
description: Security Code is the SEDOL code (Stock Exchange Daily Official List identifier) of the security
in: query
required: false
schema:
type: string
parameter-29387:
name: SK_ACCT_ID
description: The Safekeeping Account ID is an identifier for a Safekeeping Account that is unique within a branch.
in: query
required: false
schema:
type: string
parameter-29378:
name: EVENT_REFERENCE
description: Event Reference is the Corporate Action event ID (CAID)
in: query
required: false
schema:
type: string
parameter-14986:
name: ACCT_OPN_DT
description: Account Open Date is the date when the account was opened.
in: query
required: false
schema:
type: string
format: date
parameter-29421:
name: TOTAL_AMT_RECVED_USD
description: Reclaim Amount Received (USD) is the value of the refund received from the Tax Authority including interest, expressed in US dollar currency
in: query
required: false
schema:
type: number
format: double
parameter-15006:
name: SID_TICKER_SYMB
description: Ticker is the symbol used on the exchange to identify the security.
in: query
required: false
schema:
type: string
parameter-29397:
name: CREATION_DATE
description: Input Date is the date when the reclaim was loaded to Citi's reclaim system
in: query
required: false
schema:
type: string
format: date
parameter-14983:
name: ACCT_CLS_DT
description: Account Close Date is the date when the account was closed. It will only have a value if the account is closed.
in: query
required: false
schema:
type: string
format: date
parameter-15027:
name: POOL_ID_CD
description: Pool ID is an alphanumeric code that identifies a particular mortgage backed security.
in: query
required: false
schema:
type: string
parameter-29406:
name: GROSS_DIV_CCY
description: Gross Dividend is the value of the Gross Dividend expressed in the currency of the reclaim
in: query
required: false
schema:
type: number
format: double
parameter-29433:
name: NET_DIV_CCY
description: Net Dividend is the value of is the dividend net of withholding tax expressed in the currency of the reclaim
in: query
required: false
schema:
type: number
format: double
parameter-15002:
name: SID_CUSIP
description: CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.
in: query
required: false
schema:
type: string
parameter-15028:
name: PREV_FCTR_RATE
description: Previous Factor is the factor which applies to the last accrual period to determine payments and balances for principal paying securities.
in: query
required: false
schema:
type: number
format: double
parameter-29398:
name: DIVIDEND_RATE
description: The Dividend Rate is the total expected dividend payments for an investment on an annualized basis
in: query
required: false
schema:
type: number
format: double
responses:
Unsupported-Media-Type:
description: Unsupported Media Type
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Unsupported-Media-Type-Example:
$ref: '#/components/examples/Unsupported-Media-Type-Example'
Not-Found:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Not-Found-Example:
$ref: '#/components/examples/Not-Found-Example'
Internal-Server-Error:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Internal-Server-Error-Example:
$ref: '#/components/examples/Internal-Server-Error-Example'
Method-Not-Allowed:
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Method-Not-Allowed-Example:
$ref: '#/components/examples/Method-Not-Allowed-Example'
Bad-Request:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Bad-Request-Example:
$ref: '#/components/examples/Bad-Request-Example'
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Unauthorized-Example:
$ref: '#/components/examples/Unauthorized-Example'
headers:
dod-request-id:
schema:
type: string
description: The UUID representing the unique identifier of the dod request.
paging-page-number:
schema:
type: string
description: The current page number
paging-total-page-count:
schema:
type: string
description: The total count of pages available
paging-total-record-count:
schema:
type: string
description: The total count of records
dod-request-id_2:
schema:
type: string
description: The UUID representing the unique identifier of the dod request
dod-request-id_3:
schema:
type: string
description: The UUID representing the unique identifier of the dod request
dod-request-id_4:
schema:
type: string
description: The UUID representing the unique identifier of the dod request
dod-request-id_5:
schema:
type: string
description: The UUID representing the unique identifier of the dod request
dod-request-id_6:
schema:
type: string
description: The UUID representing the unique identifier of the dod request
dod-request-id_7:
schema:
type: string
description: The UUID representing the unique identifier of the dod request
dod-request-id_8:
schema:
type: string
description: The UUID representing the unique identifier of the dod request
schemas:
1bcf00be-b782-4f9f-a814-0752b0326ae6-xml-response-schema:
type: object
properties:
row:
type: array
items:
$ref: '#/components/schemas/1bcf00be-b782-4f9f-a814-0752b0326ae6-data-schema'
xml:
name: data
ErrorResponse:
type: object
title: ErrorResponse
xml:
name: ErrorResponse
properties:
ref_id:
type: string
maxLength: 60
description: Unique ID for the Transaction
title: ref_id
xml:
name: RefId
errorDetails:
type: array
title: Error Detail
uniqueItems: true
items:
$ref: '#/components/schemas/ErrorDetail'
e0b62396-5920-4270-96b1-26dddee0c242-json-response-schema:
type: object
properties:
Count:
type: number
format: integer
PagedList:
type: array
items:
$ref: '#/components/schemas/e0b62396-5920-4270-96b1-26dddee0c242-data-schema'
e0b62396-5920-4270-96b1-26dddee0c242-data-schema:
type: object
properties:
ACCT_BASE_NBR:
type: string
description: Account Base Number is an internal Citi client identifier that is associated to a safekeeping or cash account.
example: 8-DEMOCSH53JPY
ACCT_BUS_TYP_CD:
type: string
description: A code to indicate the type of account
Cash
Safekeeping
E-Report.
example: C
ACCT_BUS_TYP_NME:
type: string
description: Account type description indicates the type of the account. Values are
CASH (C)
S/K (S)
example: CASH
ACCT_ID:
type: string
description: Account ID is an identifier for both a cash account and/or a safekeeping account that is unique within a branch.
example: DEMOSK02US
ACCT_NME:
type: string
description: Account Name is the name that is assigned to the cash account and/or the safekeeping account. If an alternate account name has been specified for an account it will be displayed as the Account Name.
example: Demo - SK - US DCC Equity
ACCT_STS_TYP:
type: string
description: Account status provides the current status of the cash account and/or the safekeeping account. Values are:
Open
Closed
Frozen
example: Open
ALTV_CUR_CD:
type: string
description: Account Base Currency Code is the ISO Currency Code for the account.
example: JPY
ASOF_TMS:
type: string
format: date-time
description: The As Of Date is the date of the information being reported.
example: '2019-08-26 00:00:00'
AVAL_BAL:
type: number
format: double
description: Available Balance is the cash account balance for all posted transactions, except for future value dated transactions.
example: '6136188.61'
BAL_STS_TYP:
type: string
description: Cash Balance Type will be Posted for all cash accounts except for US Direct cash accounts where the balance type can be either Posted or Sweep.
example: POSTED
BR_ID:
type: string
description: Branch Code is the identifier of the branch for the account.For the cash account the branch code is a numeric value and for the safekeeping account it is the ISO Country code.
example: '484'
BR_NME:
type: string
description: Branch Name is the name of the branch for the cash account and/or safekeeping account.
example: NEW YORK SECURITIES CB
CASH_TYPE:
type: number
format: double
description: Cash Type Code pertains to US Direct cash accounts and indicates whether the cash account has a split income and principal balance.
example: '1'
COB_DATE:
type: string
format: date
description: Close of Business Date
example: '2019-08-26'
EOD_INTRA_IND:
type: string
description: EOD/intraday Indicator advises if the balance is an end-of-day reported balance or if the balance is an Intraday reported balance. Values are:
- 1 (Intraday)
- 2 (End of Day).
example: '2'
GFC_ID:
type:
- string
- 'null'
description: Client ID is an identifier that is available on a cash account and/or a safekeeping account. This Client ID is referred to, internally at Citi, as a GFCID.
example: '1000123456'
LCL_CUR_CD:
type: string
description: Currency code is the ISO currency code for the amount.
example: JPY
LED_BAL:
type: number
format: double
description: Ledger Balance is the balance for the cash account that includes all posted transactions including future value dated transactions.
example: '6136188.61'
LST_ENTRY_TMS:
type: string
format: date-time
description: Balance change date displays the date of the last change to the balance based on transactions that have been posted to the cash account.
example: '2019-08-26 00:00:00'
LST_UPD_TMS:
type: string
format: date-time
description: Balance Update Timestamp displays the date/time of the last update to the balance due to transactions that have posted to the cash account (Intraday) or due to reporting database updates (End of Day).
example: '2019-08-26 00:00:00'
OPNG_BAL:
type: number
format: double
description: Opening balance is the opening ledger balance (previous days closing balance) for the cash account. Ledger Balance includes all posted transactions including future value dated transactions.
example: '6136188.61'
PRNCPL_INC_IND:
type: string
description: Principal / Income Indicator advises if the balance is for principal or income. Values include:
P (Principal)
I (Income)
example: P
ROLLED_FWD:
type: string
description: Rolled Forward indicator parameter is used to flag if position valuation has been rolled forward from last close of business.
example: Y
TRANS_REF_NBR:
type: string
description: Custodian Reference is the unique reference assigned by the custodian to the record. The reference number is unique within a branch.
example: '46050312345'
IOD_TIMESTAMP:
type: string
format: date-time
description: Provides the Timestamp when data is loaded in the Data Lake
example: '2019-08-26 00:00:00'
HEAD_ACCOUNT:
type: string
description: SCAR Head Account Number
example: '1234567'
ErrorDetail:
type: object
title: Error Detail
xml:
name: ErrorDetail
properties:
issue:
type: string
maxLength: 150
description: more details about the issue
title: issue
xml:
name: Issue
action:
type: string
maxLength: 150
description: corrective action to be taken to resolve above issue
title: action
xml:
name: Action
code:
type: string
maxLength: 10
description: unique code representing the issue
title: code
xml:
name: Code
1bcf00be-b782-4f9f-a814-0752b0326ae6-data-schema:
type: object
properties:
ACCT_BASE_NBR:
type: string
description: Account Base Number is an internal Citi client identifier that is associated to a safekeeping or cash account.
example: 8-DEMOCSH53JPY
ACCT_BUS_TYP_CD:
type: string
description: A code to indicate the type of account
Cash
Safekeeping,br> E-Report.
example: C
ACCT_BUS_TYP_NME:
type: string
description: Account type description indicates the type of the account. Values are:
CASH (C)
S/K (S)
example: CASH
ACCT_ID:
type: string
description: Account ID is an identifier for both a cash account and/or a safekeeping account that is unique within a branch.
example: DEMOSK02US
ACCT_NME:
type: string
description: Account Name is the name that is assigned to the cash account and/or the safekeeping account. If an alternate account name has been specified for an account it will be displayed as the Account Name.
example: Demo - SK - US DCC Equity
ACCT_STS_TYP:
type: string
description: Account status provides the current status of the cash account and/or the safekeeping account. Values are
Open
Closed
Frozen
example: Open
ALTV_CUR_CD:
type: string
description: Account Base Currency Code is the ISO Currency Code for the account.
example: JPY
ASOF_TMS:
type: string
format: date-time
description: The As Of Date is the date of the information being reported.
example: '2019-08-26 00:00:00'
AVAL_BAL:
type: number
format: double
description: Available Balance is the cash account balance for all posted transactions, except for future value dated transactions.
example: '6136188.61'
BAL_STS_TYP:
type: string
description: Cash Balance Type will be Posted for all cash accounts except for US Direct cash accounts where the balance type can be either Posted or Sweep.
example: POSTED
BR_ID:
type: string
description: Branch Code is the identifier of the branch for the account.For the cash account the branch code is a numeric value and for the safekeeping account it is the ISO Country code.
example: '484'
BR_NME:
type: string
description: Branch Name is the name of the branch for the cash account and/or safekeeping account.
example: NEW YORK SECURITIES CB
CASH_TYPE:
type: number
format: double
description: Cash Type Code pertains to US Direct cash accounts and indicates whether the cash account has a split income and principal balance.
example: '1'
COB_DATE:
type: string
format: date
description: Close of Business Date
example: '2019-08-26'
EOD_INTRA_IND:
type: string
description: EOD/intraday Indicator advises if the balance is an end-of-day reported balance or if the balance is an Intraday reported balance. Values are:
- 1 (Intraday)
- 2 (End of Day)
example: '2'
GFC_ID:
type:
- string
- 'null'
description: Client ID is an identifier that is available on a cash account and/or a safekeeping account. This Client ID is referred to, internally at Citi, as a GFCID.
example: '1000123456'
IOD_UPDATE_TMS:
type: string
format: date-time
description: IOD Timestamp
example: '2019-08-26 00:00:00'
LCL_CUR_CD:
type: string
description: Currency code is the ISO currency code for the amount.
example: JPY
LED_BAL:
type: number
format: double
description: Ledger Balance is the balance for the cash account that includes all posted transactions including future value dated transactions.
example: '6136188.61'
LST_ENTRY_TMS:
type: string
format: date-time
description: Balance change date displays the date of the last change to the balance based on transactions that have been posted to the cash account.
example: '2019-08-26 00:00:00'
LST_UPD_TMS:
type: string
format: date-time
description: Balance Update Timestamp displays the date/time of the last update to the balance due to transactions that have posted to the cash account (Intraday) or due to reporting database updates (end-of-day).
example: '2019-08-26 00:00:00'
OPNG_BAL:
type: number
format: double
description: Opening balance is the opening ledger balance (previous days closing balance) for the cash account. Ledger Balance includes all posted transactions including future value dated transactions.
example: '6136188.61'
PRNCPL_INC_IND:
type: string
description: 'Principal / Income Indicator advises if the balance is for principal or income. Values include:
P (Principal)
I (Income)'
example: P
TRANS_REF_NBR:
type: string
description: Custodian Reference is the unique reference assigned by the custodian to the record. The reference number is unique within a branch.
example: '46050312345'
1bcf00be-b782-4f9f-a814-0752b0326ae6-json-response-schema:
type: object
properties:
Count:
type: number
format: integer
PagedList:
type: array
items:
$ref: '#/components/schemas/1bcf00be-b782-4f9f-a814-0752b0326ae6-data-schema'
e0b62396-5920-4270-96b1-26dddee0c242-xml-response-schema:
type: object
properties:
row:
type: array
items:
$ref: '#/components/schemas/e0b62396-5920-4270-96b1-26dddee0c242-data-schema'
xml:
name: data
0687f793-b687-4ac0-9337-e6a0c8445918-data-schema:
type: object
properties:
BR_ID:
type: string
description: Branch Code is the identifier of the branch for the account. For the cash account the branch code is a numeric value and for the safekeeping account it is the ISO Country code.
example: '484'
ACCT_ID:
type: string
description: Account ID is an identifier for both a cash account and/or a safekeeping account that is unique within a branch.
example: DEMOSK02US
ACCT_BUS_TYP_CD:
type: string
description: 'Account Type Code indicates the type of the account. Values are: C (Cash Account), S (Safekeeping Account).'
example: C
ACCT_BUS_ID:
type: string
description: Account Business Identifier is a business line identifier for the account.
example: CITI
ACCT_NME:
type: string
description: Account Name is the name that is assigned to the cash account and/or the safekeeping account. If an alternate account name has been specified for an account it will be displayed as the Account Name.
example: Demo - SK - Japan 2
ALTV_CUR_CD:
type: string
description: Account Base Currency Code is the ISO Currency Code for the account.
example: JPY
CONTR_PYBL_DT:
type: string
format: date
description: Contractual Settlement Date is the date when the clients cash account should be credited with funds on a sale (and debited on a purchase) on the due settlement date in place of when a trade actually settles in the market.
example: '2019-08-26'
AMT:
type: number
format: double
description: Amount is the Cash Transaction amount that will be credited or debited from the cash account.
example: '15416.98'
BENEF:
type: string
description: The Beneficiary is the recipient (payee) of the funds.
example: BENEFICIARY NAME
BENEF_BNK:
type: string
description: The Beneficiary Bank is the bank where the beneficiary has the account.
example: CITIBANK N.A
BENEF_REF:
type: string
description: Beneficiary Reference is a transaction level reference at the beneficiary bank side.
example: DEMOSG123456
BGHT_REMIT_INSTRS:
type: string
description: Bought Remit Instruction is text that describes the buy activity for the transaction.
example: ON MATURITY WE WILL DEBIT YOUR ACCOUNT
BNK_CUST_PMT_COND:
type: string
description: Bank/Customer Payment Conditions are the terms and conditions for payment services for financial institutions.
example: YOUR/OUR PAYMENT VALUE
BNKCUST_REPMT_COND:
type: string
description: Bank/Customer Repayment Conditions are the terms and conditions for payment services for financial institutions.
example: OUR/YOUR REPAYMENT VALUE
CASH_CR_AMT:
type: number
format: double
description: Cash Credit is the amount on the credit transaction
example: '6136188.61'
CASH_DB_AMT:
type: number
format: double
description: Cash Debit is the amount on the debit transaction
example: '6136188.61'
CASH_NET_AMT:
type: number
format: double
description: Cash Net Amount is the signed amount that will be credited or debited from the cash account.
example: '6136188.61'
CASH_VAL_DT:
type: string
format: date
description: Value Date is the date on which the cash posting corresponding to this trade will have value.
example: 2023-04-2
CLNT_REF_NBR:
type: string
description: Client Reference is a unique number assigned by the client, to the transaction, for identification purposes within their organization.
example: '5516313912'
CMPNY_DESC:
type: string
description: Company Description contains information regarding the company which issued the security.
example: CITIBANK N.A
CMPNY_NME:
type: string
description: Company Name is the name of the company which issued the security.
example: FN BS6982
CORR_BNK_ACCT_NBR:
type: string
description: The Corresponding Bank Account Number is the account established by a banking institution to receive deposits from, make payments on behalf of, or handle other financial transactions for another financial institution.
example: '123456789'
CUM_AMRT_AMT:
type: number
format: double
description: Cumulative Amortization Amount is the amount for fixed income securities. This parameter pertains to US domestic only.
example: '6136188.61'
CUM_QTY:
type: number
format: double
description: Cumulative Quantity is the units for fixed income securities. This parameter pertains to US domestic only.
example: '371889'
CUR_CVN_RATE:
type: number
format: double
description: FX Rate - Local is a foreign exchange rate applied for converting the local currency into the base currency. The rate is effective as of the trade date of the transaction.
example: '1.076'
DB_CR_IND:
type: string
description: Credit/Debit Indicator shows whether the cash posting associated to the corporate action will be a credit (C) or a debit (D).
example: C
DEAL_ID:
type: string
description: 'Security Code is the Contract # or Security Number.'
example: JP3783050002
DIV_AMT:
type: number
format: double
description: Gross Income is the gross amount received for an income transaction.
example: '150676.24'
EV_CREATED_TMS:
type: string
format: date-time
description: Created Timestamp is the date and time of when an item was loaded to the source system.
example: '2024-07-03 00:00:00'
EVENT_CLAS_CD:
type: string
description: 'Event Class are codes that identify the type of Income transaction. Values include: BOT, DELD, DIV (Dividend), INT (Interest), MBSD, PAID, RECD, SOLD, TSFD, (null).'
example: DIV
TRANS_CATG_NME:
type: string
description: 'Transaction Category is used in the US Cash Balance Summary report. Values include: CORPORATE ACTIONS DDA DDASEC DF DP INCOME MATURITIES MISCELLANEOUS RF RP Only applicable to the US cash transactions.'
example: DIVIDEND
INT_PMT_COND:
type: string
description: Interest Payment Conditions provides details for income transactions.
example: 130325 PLN 89,74
LOC_CUR_TAX_AMT:
type: number
format: double
description: Tax Amount Local Currency Amount is the market tax amount of the transaction.
example: '2889.12'
LCL_CUR_CD:
type: string
description: The CCY Code is the ISO Currency Code in which the cash will be credited and/or debited.
example: SGD
LCL_CUR_NME:
type: string
description: Local Currency Name is the description for the ISO currency code or it is the name of the local currency of the Settlement Amount.
example: HONG KONG DOLLAR
NET_DIV:
type: number
format: double
description: The Net Dividend is the net amount of the transaction.
example: '242116.38'
NOMINEE_CD:
type: string
description: The Nominee Code provides the two-digit nominee code value for the transaction. This parameter pertains to US domestic only.
example: '88'
ONE_DAY_FLO:
type: number
format: double
description: One Day Float is the time period between when a deposit is made and when funds become available in an account.
example: '200'
ORD_BANK_ACCT_NO:
type: string
description: Ordering Bank Account Number is the account for the amount of money used to derive the financial instrument to be bought or sold.
example: DEMOC12345
ORD_BANK_ADR_LNE_4:
type: string
description: Ordering Bank Address4 is the fourth line of (4 of 4) address for the Ordering Bank
example: NEW YORK
ORD_BANK_NME:
type: string
description: Ordering Bank Name is the name of the institution that has been authorized to act on the payment of funds.
example: DEMO ASSET MGMT
ORD_PTY_ACCT_NO:
type: string
description: Ordering Party Account Number is the account number of the instructing party that has authorized the payment of funds.
example: DEMO12345678
ORD_PTY_ADR_LNE_1:
type: string
description: Ordering Party Address1 is the first line of (1 of 4) address for the Ordering Party
example: 1/WMHHIKPBST
ORD_PTY_ADR_LNE_2:
type: string
description: Ordering Party Address2 is the second line of (2 of 4) address for the Ordering Party
example: 429-433 PINNER ROAD
ORD_PTY_ADR_LNE_3:
type: string
description: Ordering Party Address3 is the third line of (3 of 4) address for the Ordering Party
example: VKTBI
ORD_PTY_ADR_LNE_4:
type: string
description: Ordering Party Address4 is the fourth line of (4 of 4) address for the Ordering Party
example: POTOMAC,MD
ORIG_BANK_ACCT_NO:
type: string
description: The Originating Bank Account Number is the account at the originating bank from which the transfer originated.
example: DEMOGB2LXXX
ORIG_BANK_ADR_LNE1:
type: string
description: Originating Bank Address Line 1 is the first line of (1 of 4) address for the Originating Bank
example: KI BWCPYHTDROAZK CITY
ORIG_BANK_ADR_LNE2:
type: string
description: Originating Bank Address Line 2 is the second line of (2 of 4) address for the Originating Bank
example: XITUN DIST
ORIG_BANK_ADR_LNE3:
type: string
description: Originating Bank Address Line 3 is the third line of (3 of 4) address for the Originating Bank
example: NEW YORK
ORIG_BANK_ADR_LNE4:
type: string
description: Originating Bank Address Line 4 is the fourth line of (4 of 4) address for the Originating Bank
example: US
RELD_REF:
type: string
description: Related Reference as provided on a SWIFT message.
example: CITI2L6777USBK44
SALE_CUR_CD:
type: string
description: The FX Sale Currency is the ISO 4217 Currency Code for the currency that is being sold as part of the foreign exchange transaction.
example: INR
SK_ACCT_ID:
type: string
description: The safekeeping account ID is an identifier for a safekeeping account that is unique within a branch.
example: '614442644'
SOLD_REMIT_INSTRS:
type: string
description: Sold Remit Instruction is text that describes the sell activity for the transaction.
example: ON MATURITY WE WILL CREDIT YOUR ACCOUNT CITIBANK, N.A.
SUB_DIVSN_ID:
type: string
description: 'Reversal Indicator (FX) notes whether or not the transaction was processed to reverse an earlier transaction. Values include: N, R, Y, (null)'
example: N
TAX_AMT_CUR_CD:
type: string
description: Tax Amount Currency is the ISO Currency Code for the tax amount.
example: EUR
TAX_DEDD_IND:
type: string
description: Tax Deducted Indicator advises if taxes have been deducted.
example: null
TAX_EXT_AMT:
type: number
format: double
description: Tax Amount is the tax amount of the transaction.
example: '3095.25'
TAX_LCL_CUR_CD:
type: string
description: Tax Amount Local Currency (Currency) is the ISO Currency Code for the market tax amount.
example: EUR
THREE_DAY_FLO:
type: number
format: double
description: Three Day Float is the time period between when a deposit is made and when funds become available in an account.
example: null
TRANS_REF_NBR:
type: string
description: Custodian Reference is the unique reference assigned by the Custodian to the record. The reference number is unique within a branch.
example: '156943580'
TRN_CD:
type: string
description: Transaction Code is the specific type of transaction.
example: '874'
TXWHLD_CMB_AMT:
type: number
format: double
description: Tax Withheld is the amount of money that has been held back for tax purposes.
example: '2203.13'
ULTM_BENEF_ACCT:
type: string
description: Ultimate Beneficiary Account is the account number of the Ultimate Beneficiary.
example: DEMOCH1234
US_TAX_CD:
type: string
description: US Tax Codes indicates the US tax code that is applicable to the transaction.
example: 0080
PRNCSH_CMB_AMT:
type: number
format: double
description: Principal Cash is the consideration amount. On the Buy side, it is comprised of the broker commission + tax + security fee. On the Sell side, it is comprised of the broker commission - tax - security fee.
example: '836509.21'
PRDCT_NME:
type: string
description: 'Product Name is a high level description for the cash transaction Values include: Data Entry (DE), Foreign Exchange Movement (FX), Funds Transfer (FT), Money Market Movement (MM), Security Settlement Advice (SC), (null).'
example: SECURITY SETTLEMENT ADVICE
PMT_DTL_DESC:
type: string
description: Payment Details provides descriptive information regarding the transaction.
example: Payment for services
ORD_BANK_ADR_LNE_1:
type: string
description: Ordering Bank Address1 is the first line of (1 of 4) address for the Ordering Bank
example: STANDARD STREET
ORD_BANK_ADR_LNE_2:
type: string
description: Ordering Bank Address2 is the second line of (2 of 4) address for the Ordering Bank
example: WILMINGTON
ORD_BANK_ADR_LNE_3:
type: string
description: Ordering Bank Address3 is the third line of (3 of 4) address for the Ordering Bank
example: MAURITIUS AE
PCH_CUR_CD:
type: string
description: The FX Purchase Currency is the ISO Currency Code for the currency that is being purchased as part of the foreign exchange transaction.
example: SGD
EFF_POST_DT:
type: string
format: date
description: The contractual settlement date while the underlying transaction is not settled. The actual settlement date for settled transactions.
example: '2019-08-26'
PRCD_CMB_AMT:
type: number
format: double
description: Proceeds - Local is the amount, in the market currency, for a sale and/or loan transaction.
example: '113911.25'
INCM_IND:
type: string
description: Income Indicator. Values include Y (Yes for Income), N (No for Income) and (null). This parameter pertains to US domestic only.
example: N
FACE_QTY:
type: number
format: double
description: Face Value is the original face value for Mortgage Backed Securities in the US domestic market. For other MBS positions this will be the current face value after amortization.
example: '3147'
ENTRY_ID:
type: string
description: Entry ID is the two-digit National Codification Bureau (NCB) code
example: '40'
PREF_SEC_ID_TP:
type: string
description: 'Security Type identifies the Security ID. Values include: CUSIP, ISIN, SEDOL, etc.'
example: ISIN
TRN_CL_CD:
type: string
description: Transaction Class Code (CA) is the transaction type code for corporate action transactions. The parameter values are CATX and (null).
example: CATX
POST_SEC_DESC:
type: string
description: Posting Description is the first line of the descriptive information regarding the transaction.
example: FN CB4658
SEC_DESC:
type: string
description: Issue Description contains the name and other details of the instrument.
example: TEMPORARY SECURITY 003263100
DTED_TMS:
type: string
format: date-time
description: Dated Date/Time is the date that the interest begins to accrue on a fixed-income security.
example: '2019-08-26 00:00:00'
DNOMD_CUR_CD:
type: string
description: Denomination Currency Code is the ISO currency code in which the security is denominated, in the local market.
example: HKD
INCM_CUR_CD:
type: string
description: Income Currency Code is the ISO currency code in which income payments will be made for the security in the local market.
example: SGD
INCM_CUR_NME:
type: string
description: Income Currency Name is the name of the currency in which income payments will be made for the security in the local market.
example: SINGAPORE DOLLAR
ISS_TMS:
type: string
format: date-time
description: Issue Date is the date of first issue of the security.
example: '2019-11-26 00:00:00'
ISSR_LOC_CD:
type: string
description: 'Issuer Location Code is the ISO country code where the issuer of the security is based. Values include: AR (Argentina), CA (Canada), IE (Ireland), etc.'
example: CA
ISSR_LOC_NME:
type: string
description: 'Issuer Location is the name of the country where the issuer of the security is based. Values include: Argentina (AR), Canada (CA), Ireland (IE), etc.'
example: CANADA
SEC_GROUP:
type: string
description: 'Asset Type is a code representing the Asset Type of the security. Values include: EQTY (Equity), FI (Fixed Income), etc.'
example: FI
MATY_DT:
type: string
format: date-time
description: Maturity Date is the date of maturity or redemption for fixed income securities.
example: '2041-10-10 00:00:00'
POOL_ID_CD:
type: string
description: Pool ID is an alphanumeric code that identifies a particular mortgage backed security.
example: AB1234
PFD_ID_CTXT_CD:
type: string
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID parameter. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
example: ISIN
PFD_ISS_ID:
type: string
description: Security ID is the most commonly used identifier for the security in a given market.
example: BFXCMX4
STRK_PRC_AMT:
type: number
format: double
description: Strike Price is the specified price on an options contract at which the contract may be exercised.
example: '109.9'
SID_TICKER_SYMB:
type: string
description: Ticker is the symbol used on the exchange to identify the security.
example: DARK
DLAY_DAYS:
type: string
description: Delay Days is the number of days from the issuance of an MBS pool (or from the beginning of the interest accrual period) until the first payment is remitted/paid to the holders.
example: '13'
CNTRY_CD:
type: string
description: The Country Code (location) of the security custodian. Not applicable to the US domestic positions.
example: JE
ENTRY_TYP:
type: string
description: Entry Type
example: null
FCTR_DTE:
type: string
format: date-time
description: Factor Date is the date the current factor is applicable from for principal paying securities.
example: '2023-12-10 00:00:00'
PMT_FREQY_DESC:
type: string
description: 'Payment Frequency Description indicates how often interest is paid on the security. Values include: Annual (00001), Sem-Annual (00002), One Payment Per Year (00035), etc.'
example: Annual
SID_ISIN:
type: string
description: ISIN (International Securities Identification Number) is a 12-character alpha-numerical code that does not contain information characterizing financial instruments but serves for uniform identification of a security at trading and settlement.
example: JP3049040003
SID_SEDOL:
type: string
description: SEDOL (Stock Exchange Daily Official List) is a unique identification code, consisting of seven alphanumeric characters, that is assigned to all securities trading on the London Stock Exchange.
example: BJ18KB6
ACRL_BASIS_CDE:
type: string
description: 'Accrual Basis Code is a code linked to the Accrual Basis parameter which indicates the basis on which interest accruals are calculated. Values include: 00043 (360 / 365), 00011 (360 / 360), 00063 (30 / 360 Non-EOM), etc.'
example: '00043'
ACRL_BASIS_NME:
type: string
description: Accrual Basis Description is the basis on which interest accrual is calculated, e.g. 30/360 meaning nominal 30 day months and a 360 day year.
example: 360 / 365
NXT_PAY_DT:
type: string
format: date
description: Next Payable Date is the next date on which a dividend or interest payment is scheduled to be paid.
example: '2026-04-22'
PMT_FREQY:
type: string
description: 'Payment Frequency indicates how often interest is paid on the security. Values include: 00001 (Annual), 00002 (Sem-Annual), 00035 (One Payment Per Year), etc.'
example: '00001'
ISS_CATG_CD:
type: string
description: 'Issue Category Code is a specific category for the security. Values include: CSTK (Common Stock), DERIV (Derivatives), MBS (Mortgage Backed Securities), etc.'
example: EQTY
ISS_CAT_NME:
type: string
description: 'Issue Category is the description for the Issue Category Code. Values include: Common Stock (CSTK), Derivatives (DERIV), Mortgage Backed Securities (MBS), etc.'
example: EQUITIES
INCM_PROJN_RATE:
type: number
format: double
description: Interest Rate is the coupon rate of the security.
example: '3.0946'
TRANS_DESC:
type: string
description: A one-line text description of this cash flow activity.
example: CASH DIVIDEND , QTY
EOD_INTRA_IND:
type: string
description: 'EOD/intraday Indicator advises if the balance is an End of Day reported balance or if the balance is an Intraday reported balance. Values are: 1 (Intraday) 2 (End of Day)'
example: '2'
CURR_FCTR:
type: number
format: double
description: Current Factor is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
example: '0.01580556'
DIV_RATE:
type: number
format: double
description: The Dividend Rate is the total expected dividend payments for an investment on an annualized basis
example: '0.452071'
PREV_FCTR:
type: number
format: double
description: The factor which applies for the previous accrual period to determine payments and balances for principal paying securities. Currently applicable to the US intraday cash transactions.
example: '0.84824716'
PRIN_INC_IND:
type: string
description: 'Principal / Income Indicator advises if the balance is for Principal or Income. Values include: P (Principal) or I (Income).'
example: P
PRIN_QTY:
type: number
format: double
description: Principal Quantity is the quantity for principal transactions.
example: '1041002'
TRAD_BRKR_NME:
type: string
description: Counterparty is the other party to the trade. The person or entity (e.g. institution, agent, broker) with whom a transaction is conducted).
example: CITIBANK N.A
TRD_EXCUTD_EF_DT:
type: string
format: date
description: Trade Date is the date a transaction is effected or executed.
example: '2023-12-26'
BASE_INCM_ERND:
type: number
format: double
description: The Income Earned - Base is the signed income amount in the account base currency.
example: '836509.21'
LCL_INCM_ERND:
type: number
format: double
description: The Income Earned - Local is the signed income amount in local currency.
example: '63099.87'
PRDCT_TYP:
type: string
description: 'Product Type is a 2-digit high level description for the cash transaction Values include: DE (Data Entry), FX (Foreign Exchange Movement), FT (Funds Transfer), MM (Money Market Movement ), SC (Security Settlement Advice), (null).'
example: SC
RCEV_DIV_CUR_CD:
type: string
description: Received Dividend Currency is the ISO 4217 Currency Code for the dividend amount.
example: HKD
RCEV_DIV_AMT:
type: number
format: double
description: Received Dividend Amount is the dividend amount of the transaction.
example: '2606.56'
INCM_QTY:
type: number
format: double
description: Income Quantity is the number of shares/units for the income payment or the entitlement shares or face amount for income payments.
example: '124755'
SID_CUSIP:
type: string
description: CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.
example: T5379P105
BR_NME:
type: string
description: Branch Name is the name of the branch for the cash account and/or safekeeping account.
example: NEW YORK SECURITIES CB
SEC_SUB_TYP_CD:
type: string
description: 'Issue Type Code is a code linked to the Issue Type parameter which describes the type of security instrument. Values include: 1 (ADR Convertible), 12 (Bond), 19 (Bond Convertible), etc.'
example: '12'
SEC_SUB_TYP_NME:
type: string
description: 'Issue Type is a description of the type of the security instrument. Values include: ADR Convertible (1), Bond (12) , Bond Convertible (19), etc.'
example: BOND
FED_REF_NBR:
type: string
description: The FED/CHIPS Reference Number is a unique number that is assigned by the Federal Reserve Bank (FED) or the Clearing House Interbank Payments System (CHIPS) for the transaction.
example: C-12345678
ORD_PTY_NME:
type: string
description: Ordering Party Name is the name of the instructing party that has authorized the payment of funds.
example: LNIXSHUS YDUBTY
SEC_SECURITY_CD:
type: string
description: CITI Internal Security Code is the identifier of the CITI Internal Security Identifier.
example: 000BMG6KT4
SEC_SHRT_NME:
type: string
description: Issue Name is the Security Name of the security instrument.
example: FR QN4224
LST_BUSCLS_DT:
type: string
format: date
description: The date for which End of Day data was last received for the account.
example: '2024-07-04'
ACT_SETT_DT:
type: string
format: date
description: Actual Settlement Date is the date of final settlement of the trade.
example: '2024-08-22'
DEAL_REF_NBR:
type: string
description: OTM Reference is the Order and Trade Manager Reference number that has been assigned to the order instructions.
example: DEMO-1234567
ASRD_INCM_IND:
type: string
description: The Assured Income Indicator advises whether an income payment is assured (to be paid on the anticipated payment date) or actual (to be paid when funds are actually received). The values are ASRD (assured) and ACTU (actual).
example: ACTU
GROSS_NET_IND:
type: string
description: The Gross/Net is an indicator that advises if the amount for the transaction is Gross or Net. Values include G (Gross), N (Net) and (null)
example: G
CA_INCM_IND:
type: string
description: 'The CA/Income Indicator advises if the cash transaction is related to corporate actions or income. Values are:
C for Corporate Action
I for Income.'
example: C
INTRNL_REF_ID_CA:
type: string
description: Custodian Reference (CA) is the unique reference assigned by the Custodian to the record. The reference number is unique within a branch.
example: '15396821'
TRN_CL_CD_CA:
type: string
description: Transaction Class Code (CA) is the transaction type code for corporate action transactions. The parameter values are:
CATX
(null)
example: CATX
CORP_ACTN_TYP:
type: string
description: Corporate Action Type are codes that identify the type of corporation action transaction. Values include BIDS (BID/REVERSE RIGHTS), CSHDIV (CASH DIVIDEND), INTR (INTEREST PAYMENT), STDIV (STOCK DIVIDEND), etc.
example: BONU
CORP_ACTN_TYP_NME:
type: string
description: Corporate Action Type Name is the description for the Corporate Action Type code. Values include:
BID/REVERSE RIGHTS (BIDS)
CASH DIVIDEND (CSHDIV)
INTEREST PAYMENT (INTR)
STOCK DIVIDEND (STDIV)
etc.
example: BONUS ISSUE
ENTLMT_STS_NME:
type: string
description: Entitlements Status is a description of the current processing status of the entitlement. Values include:
Pending
Fully Released
Fully Paid
Partially Released
Partially Paid
Pending Payment
Pending
Reversal
Rev
To Be Received
(null)
etc.
example: PARTIALLY PAID
ENTLMT_QTY:
type: number
format: double
description: Entitlement Quantity is the associated security holding quantity on which the entitlement has been calculated.
example: '81338'
PAY_DATE:
type: string
format: date
description: Payable Date is the date on which a dividend or interest payment is scheduled to be paid.
example: '2022-01-05'
SID_LOCAL:
type: string
description: Local ID is the Local security identifier of the associated security.
example: 0059663300
RVSL_IND:
type: string
description: 'The Reversal Indicator notes whether or not the cash transaction was processed to reverse an earlier transaction. Values include: N, R, Y, (null).'
example: Y
IOD_UPDATE_TMS:
type: string
format: date-time
description: IOD Timestamp
example: '2024-10-01 05:30:10'
CASH_TRANS_TYPE:
type: string
description: A cash transaction type is a business transaction that is settled with immediate exchange of cash.
example: ACH PYMT
MKT_TRANS_TYPE:
type: string
description: Financial Market Transaction Type indicates the type of trade conducted by the Financial Institution. * Domain * Buy Sell Borrow Lend Swap Transfer Exchange.
example: TAX PAYMENT
CITI_INTRNL_REF_ID:
type: string
description: Custodian Reference (Internal) is a Citi generated identifier for a unique cash transaction record. This attribute is only valid within Citi and we recommend that it should not be used by clients.
example: T135177509
f5471486-3c48-45bc-9b1f-05a7d57bdc71-json-response-schema:
type: object
properties:
Count:
type: number
format: integer
PagedList:
type: array
items:
$ref: '#/components/schemas/f5471486-3c48-45bc-9b1f-05a7d57bdc71-data-schema'
0687f793-b687-4ac0-9337-e6a0c8445918-xml-response-schema:
type: object
properties:
row:
type: array
items:
$ref: '#/components/schemas/0687f793-b687-4ac0-9337-e6a0c8445918-data-schema'
xml:
name: data
0687f793-b687-4ac0-9337-e6a0c8445918-json-response-schema:
type: object
properties:
Count:
type: number
format: integer
PagedList:
type: array
items:
$ref: '#/components/schemas/0687f793-b687-4ac0-9337-e6a0c8445918-data-schema'
f5471486-3c48-45bc-9b1f-05a7d57bdc71-data-schema:
type: object
properties:
ACCT_BASE_NBR:
type: string
description: Account Base Number is an internal Citi client identifier that is associated to a Safekeeping or cash account.
example: 8-DEMOCSH53JPY
ACCT_ID:
type: string
description: Account ID is an identifier for both a cash account and/or a Safekeeping account that is unique within a branch.
example: DEMOSK02US
ULTM_BENEF_ACCT:
type: string
description: Ultimate Beneficiary Account is the account number of the Ultimate Beneficiary.
example: DEMOCH1234
BR_NME:
type: string
description: Branch Name is the name of the branch for the cash account and/or safekeeping account.
example: NEW YORK SECURITIES CB
ALTV_CUR_CD:
type: string
description: Account Base Currency Code is the ISO Currency Code for the account.
example: JPY
SEC_GROUP:
type: string
description: Asset Type is a code representing the Asset Type of the security. Values include:
EQTY (Equity)
FI (Fixed Income)
etc.
example: FI
ASRD_INCM_IND:
type: string
description: The Assured Income Indicator advises whether an income payment is assured (to be paid on the anticipated payment date) or actual (to be paid when funds are actually received). The values are:
ASRD (assured)
ACTU (actual).
example: ACTU
BNK_CUST_PMT_COND:
type: string
description: Bank/Customer Payment Conditions are the terms and conditions for payment services for financial institutions.
example: YOUR/OUR PAYMENT VALUE
BNKCUST_REPMT_COND:
type: string
description: Bank/Customer Repayment Conditions are the terms and conditions for payment services for financial institutions.
example: OUR/YOUR REPAYMENT VALUE
CLNT_PFD_CUR_CD:
type: string
description: Base Currency Code is the ISO currency code preferred by the client organization.
example: USD
BENEF:
type: string
description: The Beneficiary is the recipient (payee) of the funds.
example: BENEFICIARY NAME
BENEF_BNK:
type: string
description: The Beneficiary Bank is the bank where the beneficiary has the account.
example: CITIBANK N.A
BENEF_REF:
type: string
description: Beneficiary Reference is a transaction level reference at the beneficiary bank side.
example: DEMOSG123456
BR_ID:
type: string
description: Branch Code is the identifier of the branch for the account. For the cash account the branch code is a numeric value and for the safekeeping account it is the ISO Country code.
example: '484'
BRKR_NME:
type: string
description: Transaction Broker Name.
example: BROKER NAME
BRKR_CODE:
type: string
description: Broker Code
example: '1234'
EFF_POST_DT:
type: string
format: date
description: The contractual settlement date while the underlying transaction is not settled. The actual settlement date for settled transactions.
example: '2019-08-26'
PRIN_INC_IND:
type: string
description: 'Principal / Income Indicator advises if the balance is for Principal or Income. Values include:
P (Principal)
I (Income).'
example: P
CASH_CR_AMT:
type: number
format: double
description: Cash Credit is the amount on the credit transaction
example: '6136188.61'
CASH_DB_AMT:
type: number
format: double
description: Cash Debit is the amount on the debit transaction
example: '6136188.61'
CASH_NET_AMT:
type: number
format: double
description: Cash Net Amount is the signed amount that will be credited or debited from the cash account.
example: '6136188.61'
CMPNY_DESC:
type: string
description: Company Description contains information regarding the company which issued the security.
example: CITIBANK N.A
CONTR_PYBL_DT:
type: string
format: date
description: Contractual Settlement Date is the date when the clients cash account should be credited with funds on a sale (and debited on a purchase) on the due settlement date in place of when a trade actually settles in the market.
example: '2019-08-26'
CORP_ACTN_TYP:
type: string
description: Corporate Action Type are codes that identify the type of corporation action transaction. Values include BIDS (BID/REVERSE RIGHTS), CSHDIV (CASH DIVIDEND), INTR (INTEREST PAYMENT), STDIV (STOCK DIVIDEND), etc.
example: BONU
CORP_ACTN_TYP_NME:
type: string
description: Corporate Action Type Name is the description for the Corporate Action Type code. Values include BID/REVERSE RIGHTS (BIDS), CASH DIVIDEND (CSHDIV), INTEREST PAYMENT (INTR), STOCK DIVIDEND (STDIV), etc.
example: BONUS ISSUE
CORR_BNK_ACCT_NBR:
type: string
description: The Corresponding Bank Account Number is the account established by a banking institution to receive deposits from, make payments on behalf of, or handle other financial transactions for another financial institution.
example: '123456789'
TRAD_BRKR_NME:
type: string
description: Counterparty is the other party to the trade. The person or entity (e.g. institution, agent, broker) with whom a transaction is conducted).
example: CITIBANK N.A
CUM_AMRT_AMT:
type: number
format: double
description: Cumulative Amortization Amount is the amount for fixed income securities. This parameter pertains to US domestic only.
example: '6136188.61'
CUM_QTY:
type: number
format: double
description: Cumulative Quantity is the units for fixed income securities. This parameter pertains to US domestic only.
example: '371889'
CURR_FCTR:
type: number
format: double
description: Current Factor is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
example: '0.01580556'
DTED_TMS:
type: string
format: date-time
description: Dated Date/Time is the date that the interest begins to accrue on a fixed-income security.
example: '2019-08-26 00:00:00'
DIV_RATE:
type: number
format: double
description: The Dividend Rate is the total expected dividend payments for an investment on an annualized basis
example: '0.452071'
ENTLMT_QTY:
type: number
format: double
description: Entitlement Quantity is the associated security holding quantity on which the entitlement has been calculated.
example: '81338'
ENTLMT_STS_NME:
type: string
description: 'Entitlements Status is a description of the current processing status of the entitlement. Values include: Pending, Fully Released, Fully Paid, Partially Released, Partially Paid, Pending Payment, Pending, Reversal, Rev, To Be Received, (null), etc.'
example: PARTIALLY PAID
ENTRY_ID:
type: string
description: Entry ID is the two-digit National Codification Bureau (NCB) code
example: '40'
EVENT_CLAS_CD:
type: string
description: 'Event Class are codes that identify the type of Income transaction. Values include: BOT, DELD, DIV (Dividend), INT (Interest), MBSD, PAID, RECD, SOLD, TSFD, (null).'
example: DIV
EX_DISTN_DT:
type: string
format: date
description: Ex Date is the trading cut off date after which position changes will no longer alter the eligibility to the corporate action or the date established by an issuer of a security for the purpose of determining the holders who are entitled to receive the last dividend or distribution.
example: '2021-06-09'
FED_REF_NBR:
type: string
description: The FED/CHIPS Reference Number is a unique number that is assigned by the Federal Reserve Bank (FED) or the Clearing House Interbank Payments System (CHIPS) for the transaction.
example: C-12345678
PCH_CUR_CD:
type: string
description: The FX Purchase Currency is the ISO Currency Code for the currency that is being purchased as part of the foreign exchange transaction.
example: SGD
CUR_CVN_RATE:
type: number
format: double
description: FX Rate - Local is a foreign exchange rate applied for converting the local currency into the base currency. The rate is effective as of the trade date of the transaction.
example: '1.076'
SALE_CUR_CD:
type: string
description: The FX Sale Currency is the ISO 4217 Currency Code for the currency that is being sold as part of the foreign exchange transaction.
example: INR
FACE_QTY:
type: number
format: double
description: Face Value is the original face value for Mortgage Backed Securities in the US domestic market. For other MBS positions this will be the current face value after amortization.
example: '3147'
DIV_AMT:
type: number
format: double
description: Gross Income is the gross amount received for an income transaction.
example: '150676.24'
GROSS_NET_IND:
type: string
description: The Gross/Net is an indicator that advises if the amount for the transaction is Gross or Net. Values include G (Gross), N (Net) and (null).
example: G
INCM_CUR_CD:
type: string
description: Income Currency Code is the ISO currency code in which income payments will be made for the security in the local market.
example: SGD
INCM_CUR_NME:
type: string
description: Income Currency Name is the name of the currency in which income payments will be made for the security in the local market.
example: SINGAPORE DOLLAR
BASE_INCM_ERND:
type: number
format: double
description: The Income Earned - Base is the signed income amount in the account base currency.
example: '836509.21'
LCL_INCM_ERND:
type: number
format: double
description: The Income Earned - Local is the signed income amount in local currency.
example: '63099.87'
INCM_IND:
type: string
description: Income Indicator. Values include Y (Yes for Income), N (No for Income) and (null). This parameter pertains to US domestic only.
example: N
INCM_QTY:
type: number
format: double
description: Income Quantity is the number of shares/units for the income payment or the entitlement shares or face amount for income payments.
example: '124755'
INT_PMT_COND:
type: string
description: Interest Payment Conditions provides details for income transactions.
example: 130325 PLN 89,74
ISS_CLF_NME:
type: string
description: Issue Classification Name is a description for the Issue Classification Code parameter. This is for US ASTRA only and values include Stripped, UIT, Sealed-Envlp, etc.
example: GOLD STRIP
ISS_TMS:
type: string
format: date-time
description: Issue Date is the date of first issue of the security.
example: '2019-11-26 00:00:00'
SEC_DESC:
type: string
description: Issue Description contains the name and other details of the instrument.
example: TEMPORARY SECURITY 003263100
SEC_SUB_TYP_CD:
type: string
description: 'Issue Type Code is a code linked to the Issue Type parameter which describes the type of security instrument. Values include: 1 (ADR Convertible), 12 (Bond), 19 (Bond Convertible), etc.'
example: '12'
SEC_SUB_TYP_NME:
type: string
description: 'Issue Type is a description of the type of the security instrument. Values include: ADR Convertible (1), Bond (12) , Bond Convertible (19), etc.'
example: BOND
ISSR_LOC_CD:
type: string
description: 'Issuer Location Code is the ISO country code where the issuer of the security is based. Values include: AR (Argentina), CA (Canada), IE (Ireland), etc.'
example: CA
ISSR_LOC_NME:
type: string
description: 'Issuer Location is the name of the country where the issuer of the security is based. Values include: Argentina (AR), Canada (CA), Ireland (IE), etc.'
example: CANADA
LCL_CUR_NME:
type: string
description: Local Currency Name is the description for the ISO currency code or it is the name of the local currency of the Settlement Amount.
example: HONG KONG DOLLAR
MATY_DT:
type: string
format: date-time
description: Maturity Date is the date of maturity or redemption for fixed income securities.
example: '2041-10-10 00:00:00'
NET_DIV:
type: number
format: double
description: The Net Dividend is the net amount of the transaction.
example: '242116.38'
NOMINEE:
type: number
format: double
description: 'Nominee: role played by a Legal entity established solely for the purpose of registration of record ownership of securities. A custodian typically registers customer securities in a nominee name for ease of handling subsequent transfers or denomination changes, interest and dividend collections and other corporate actions.'
example: null
NOMINEE_CD:
type: string
description: The Nominee Code provides the two-digit nominee code value for the transaction. This parameter pertains to US domestic only.
example: '88'
DEAL_REF_NBR:
type: string
description: OTM Reference is the Order and Trade Manager Reference number that has been assigned to the order instructions.
example: DEMO-1234567
ONE_DAY_FLO:
type: number
format: double
description: One Day Float is the time period between when a deposit is made and when funds become available in an account.
example: '200'
ORD_BANK_ACCT_NO:
type: string
description: Ordering Bank Account Number is the account for the amount of money used to derive the financial instrument to be bought or sold.
example: DEMOC12345
ORD_BANK_ADR_LNE_1:
type: string
description: Ordering Bank Address1 is the first line of (1 of 4) address for the Ordering Bank
example: STANDARD STREET
ORD_BANK_ADR_LNE_2:
type: string
description: Ordering Bank Address2 is the second line of (2 of 4) address for the Ordering Bank
example: WILMINGTON
ORD_BANK_ADR_LNE_3:
type: string
description: Ordering Bank Address3 is the third line of (3 of 4) address for the Ordering Bank
example: MAURITIUS AE
ORD_BANK_ADR_LNE_4:
type: string
description: Ordering Bank Address4 is the fourth line of (4 of 4) address for the Ordering Bank
example: NEW YORK
ORD_BANK_NME:
type: string
description: Ordering Bank Name is the name of the institution that has been authorized to act on the payment of funds.
example: DEMO ASSET MGMT
ORD_PTY_ACCT_NO:
type: string
description: Ordering Party Account Number is the account number of the instructing party that has authorized the payment of funds.
example: DEMO12345678
ORD_PTY_ADR_LNE_1:
type: string
description: Ordering Party Address1 is the first line of (1 of 4) address for the Ordering Party
example: 1/WMHHIKPBST
ORD_PTY_ADR_LNE_2:
type: string
description: Ordering Party Address2 is the second line of (2 of 4) address for the Ordering Party
example: 429-433 PINNER ROAD
ORD_PTY_ADR_LNE_3:
type: string
example: VKTBI
description: Ordering Party Address3 is the third line of (3 of 4) address for the Ordering Party
ORD_PTY_ADR_LNE_4:
type: string
description: Ordering Party Address4 is the fourth line of (4 of 4) address for the Ordering Party
example: POTOMAC,MD
ORD_PTY_NME:
type: string
description: Ordering Party Name is the name of the instructing party that has authorized the payment of funds.
example: LNIXSHUS YDUBTY
ORIG_BANK_ACCT_NO:
type: string
description: The Originating Bank Account Number is the account at the originating bank from which the transfer originated.
example: DEMOGB2LXXX
ORIG_BANK_ADR_LNE1:
type: string
description: Originating Bank Address Line 1 is the first line of (1 of 4) address for the Originating Bank
example: KI BWCPYHTDROAZK CITY
ORIG_BANK_ADR_LNE2:
type: string
description: Originating Bank Address Line 2 is the second line of (2 of 4) address for the Originating Bank
example: XITUN DIST
ORIG_BANK_ADR_LNE3:
type: string
description: Originating Bank Address Line 3 is the third line of (3 of 4) address for the Originating Bank
example: NEW YORK
ORIG_BANK_ADR_LNE4:
type: string
description: Originating Bank Address Line 4 is the fourth line of (4 of 4) address for the Originating Bank
example: US
PMT_DTL_DESC:
type: string
description: Payment Details provides descriptive information regarding the transaction.
example: Payment for services
PLEDGE_CDE:
type: string
description: Pledge Code is a 10 digit numeric number corresponding to the DTC (Depository Trust Company) participant number in a pledge
example: '0000023634'
POOL_ID_CD:
type: string
description: Pool ID is an alphanumeric code that identifies a particular mortgage backed security.
example: AB1234
PFD_ISS_ID:
type: string
description: Security ID is the most commonly used identifier for the security in a given market.
example: BFXCMX4
PREV_FCTR:
type: number
format: double
description: The factor which applies for the previous accrual period to determine payments and balances for principal paying securities. Currently applicable to the US intraday cash transactions.
example: '0.84824716'
PRNCSH_CMB_AMT:
type: number
format: double
description: Principal Cash is the consideration amount. On the Buy side, it is comprised of the broker commission + tax + security fee. On the Sell side, it is comprised of the broker commission - tax - security fee.
example: '836509.21'
PRIN_QTY:
type: number
format: double
description: Principal Quantity is the quantity for principal transactions.
example: '1041002'
PRCD_CMB_AMT:
type: number
format: double
description: Proceeds - Local is the amount, in the market currency, for a sale and/or loan transaction.
example: '113911.25'
PRDCT_NME:
type: string
description: 'Product Name is a high level description for the cash transaction Values include: Data Entry (DE), Foreign Exchange Movement (FX), Funds Transfer (FT), Money Market Movement (MM), Security Settlement Advice (SC), (null).'
example: SECURITY SETTLEMENT ADVICE
PRDCT_TYP:
type: string
description: 'Product Type is a 2-digit high level description for the cash transaction Values include: DE (Data Entry), FX (Foreign Exchange Movement), FT (Funds Transfer), MM (Money Market Movement ), SC (Security Settlement Advice), (null).'
example: SC
RCEV_DIV_AMT:
type: number
format: double
description: Received Dividend Amount is the dividend amount of the transaction.
example: '2606.56'
RCEV_DIV_CUR_CD:
type: string
description: Received Dividend Currency is the ISO 4217 Currency Code for the dividend amount.
example: HKD
REC_DT:
type: string
format: date
description: Record Date is the date established by the issuer of a security for the purpose of determining the holders who are entitled to receive a dividend or distribution or is the cut off date to determine which holders of the security are eligible.
example: '2025-01-30'
RELD_REF:
type: string
description: Related Reference as provided on a SWIFT message.
example: CITI2L6777USBK44
SUB_DIVSN_ID:
type: string
description: 'Reversal Indicator (FX) notes whether or not the transaction was processed to reverse an earlier transaction. Values include: N, R, Y, (null)'
example: N
SID_SEDOL:
type: string
description: SEDOL (Stock Exchange Daily Official List) is a unique identification code, consisting of seven alphanumeric characters, that is assigned to all securities trading on the London Stock Exchange.
example: BJ18KB6
SK_ACCT_ID:
type: string
description: The safekeeping account ID is an identifier for a safekeeping account that is unique within a branch.
example: '614442644'
SID_CUSIP:
type: string
description: CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.
example: T5379P105
SID_ISIN:
type: string
description: ISIN (International Securities Identification Number) is a 12-character alpha-numerical code that does not contain information characterizing financial instruments but serves for uniform identification of a security at trading and settlement.
example: JP3049040003
ACCT_NME:
type: string
description: Account Name is the name that is assigned to the cash account and/or the safekeeping account. If an alternate account name has been specified for an account it will be displayed as the Account Name.
example: Demo - SK - Japan 2
SOLD_REMIT_INSTRS:
type: string
description: Sold Remit Instruction is text that describes the sell activity for the transaction.
example: ON MATURITY WE WILL CREDIT YOUR ACCOUNT CITIBANK, N.A.
TAX_EXT_AMT:
type: number
format: double
description: Tax Amount is the tax amount of the transaction.
example: '3095.25'
TAX_AMT_CUR_CD:
type: string
description: Tax Amount Currency is the ISO Currency Code for the tax amount.
example: EUR
LOC_CUR_TAX_AMT:
type: number
format: double
description: Tax Amount Local Currency Amount is the market tax amount of the transaction.
example: '2889.12'
TAX_LCL_CUR_CD:
type: string
description: Tax Amount Local Currency (Currency) is the ISO Currency Code for the market tax amount.
example: EUR
TAX_DEDD_IND:
type: string
description: Tax Deducted Indicator advises if taxes have been deducted.
example: null
TXWHLD_CMB_AMT:
type: number
format: double
description: Tax Withheld is the amount of money that has been held back for tax purposes.
example: '2203.13'
THREE_DAY_FLO:
type: number
format: double
description: Three Day Float is the time period between when a deposit is made and when funds become available in an account.
example: null
SID_TICKER_SYMB:
type: string
description: Ticker is the symbol used on the exchange to identify the security.
example: DARK
TRD_EXCUTD_EF_DT:
type: string
format: date
description: Trade Date is the date a transaction is effected or executed.
example: '2023-12-26'
TRN_CL_CD:
type: string
description: 'Transaction Class is the transaction type code for securities transactions. Values include: ADJ (Adjustment), BIDS, BOE, BUY, CAPD, CAPG, CAPGL, DF (Deliver Free), DIV (Dividend), DRAW, DRIP, DVCA, etc.'
example: DIV
TRN_CD:
type: string
description: Transaction Code is the specific type of transaction.
example: '874'
TRANS_CATG_NME:
type: string
description: 'Transaction Category is used in the US Cash Balance Summary report. Values include: CORPORATE ACTIONS DDA DDASEC DF DP INCOME MATURITIES MISCELLANEOUS RF RP Only applicable to the US cash transactions.'
example: DIVIDEND
US_TAX_CD:
type: string
description: US Tax Codes indicates the US tax code that is applicable to the transaction.
example: 0080
CASH_VAL_DT:
type: string
format: date
description: Value Date is the date on which the cash posting corresponding to this trade will have value.
example: '2023-04-24'
EV_CREATED_TMS:
type: string
format: date-time
description: Created Timestamp is the date and time of when an item was loaded to the source system.
example: '2024-07-03 00:00:00'
PREF_SEC_ID_TP:
type: string
description: 'Security Type identifies the Security ID. Values include: CUSIP, ISIN, SEDOL, etc.'
example: ISIN
DEAL_ID:
type: string
description: 'Security Code is the Contract # or Security Number.'
example: JP3783050002
CMPNY_NME:
type: string
description: Company Name is the name of the company which issued the security.
example: FN BS6982
TRANS_DESC:
type: string
description: A one-line text description of this cash flow activity.
example: CASH DIVIDEND , QTY
DB_CR_IND:
type: string
description: Credit/Debit Indicator shows whether the cash posting associated to the corporate action will be a credit (C) or a debit (D).
example: C
LCL_CUR_CD:
type: string
description: The CCY Code is the ISO Currency Code in which the cash will be credited and/or debited.
example: SGD
AMT:
type: number
format: double
description: Amount is the Cash Transaction amount that will be credited or debited from the cash account.
example: '15416.98'
CLNT_REF_NBR:
type: string
description: Client Reference is a unique number assigned by the client, to the transaction, for identification purposes within their organization.
example: '5516313912'
INTRNL_REF_ID:
type: string
description: Custodian Reference (internal) is the unique reference assigned by the Custodian to the record. The reference number is unique within a branch.
example: '143720728'
EOD_INTRA_IND:
type: string
description: 'EOD/intraday Indicator advises if the balance is an End of Day reported balance or if the balance is an Intraday reported balance. Values are: 1 (Intraday) 2 (End of Day)'
example: '2'
ACCT_BUS_TYP_CD:
type: string
description: 'Account Type Code indicates the type of the account. Values are: C (Cash Account), S (Safekeeping Account).'
example: C
BGHT_REMIT_INSTRS:
type: string
description: Bought Remit Instruction is text that describes the buy activity for the transaction.
example: ON MATURITY WE WILL DEBIT YOUR ACCOUNT
TRANS_REF_NBR:
type: string
description: Custodian Reference is the unique reference assigned by the Custodian to the record. The reference number is unique within a branch.
example: '156943580'
POST_SEC_DESC:
type: string
description: Posting Description is the first line of the descriptive information regarding the transaction.
example: FN CB4658
DNOMD_CUR_CD:
type: string
description: Denomination Currency Code is the ISO currency code in which the security is denominated, in the local market.
example: HKD
PFD_ID_CTXT_CD:
type: string
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID parameter. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
example: ISIN
STRK_PRC_AMT:
type: number
format: double
description: Strike Price is the specified price on an options contract at which the contract may be exercised.
example: '109.9'
DLAY_DAYS:
type: string
description: Delay Days is the number of days from the issuance of an MBS pool (or from the beginning of the interest accrual period) until the first payment is remitted/paid to the holders.
example: '13'
CNTRY_CD:
type: string
description: The Country Code (location) of the security custodian. Not applicable to the US domestic positions.
example: JE
ENTRY_TYP:
type: string
description: Entry Type
example: null
FCTR_DTE:
type: string
format: date-time
description: Factor Date is the date the current factor is applicable from for principal paying securities.
example: '2023-12-10 00:00:00'
PMT_FREQY_DESC:
type: string
description: 'Payment Frequency Description indicates how often interest is paid on the security. Values include: Annual (00001), Sem-Annual (00002), One Payment Per Year (00035), etc.'
example: Annual
ACRL_BASIS_CDE:
type: string
description: 'Accrual Basis Code is a code linked to the Accrual Basis parameter which indicates the basis on which interest accruals are calculated. Values include: 00043 (360 / 365), 00011 (360 / 360), 00063 (30 / 360 Non-EOM), etc.'
example: '00043'
ACRL_BASIS_NME:
type: string
description: Accrual Basis Description is the basis on which interest accrual is calculated, for example, 30/360 meaning nominal 30 day months and a 360 day year.
example: 360 / 365
NXT_PAY_DT:
type: string
format: date
description: Next Payable Date is the next date on which a dividend or interest payment is scheduled to be paid.
example: '2026-04-22'
PMT_FREQY:
type: string
description: 'Payment Frequency indicates how often interest is paid on the security. Values include: 00001 (Annual), 00002 (Sem-Annual), 00035 (One Payment Per Year), etc.'
example: '00001'
PREV_FCTR_RATE:
type: number
format: double
description: Previous Factor (Old) is the factor which applies to the last accrual period to determine payments and balances for principal paying securities.
example: '0.18340964'
ISS_CATG_CD:
type: string
description: 'Issue Category Code is a specific category for the security. Values include: CSTK (Common Stock), DERIV (Derivatives), MBS (Mortgage Backed Securities), etc.'
example: EQTY
ISS_CAT_NME:
type: string
description: 'Issue Category is the description for the Issue Category Code. Values include: Common Stock (CSTK), Derivatives (DERIV), Mortgage Backed Securities (MBS), etc.'
example: EQUITIES
CURR_FCTR_RATE:
type: number
format: double
description: Current Factor (Old) is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
example: '0.4515268'
INCM_PROJN_RATE:
type: number
format: double
description: Interest Rate is the coupon rate of the security.
example: '3.0946'
RECORD_DT:
type: string
format: date
description: Record Date is the date established by the issuer of a security for the purpose of determining the holders who are entitled to receive a dividend or distribution or is the cut off date to determine which holders of the security are eligible.
example: '2024-05-21'
SEC_SECURITY_CD:
type: string
description: CITI Internal Security Code is the identifier of the CITI Internal Security Identifier.
example: 000BMG6KT4
SEC_SHRT_NME:
type: string
description: Issue Name is the Security Name of the security instrument.
example: FR QN4224
LST_BUSCLS_DT:
type: string
format: date
description: The date for which End of Day data was last received for the account.
example: '2024-07-04'
ACT_SETT_DT:
type: string
format: date
description: Actual Settlement Date is the date of final settlement of the trade.
example: '2024-08-22'
CA_INCM_IND:
type: string
description: 'The CA/Income Indicator advises if the cash transaction is related to corporate actions or income. Values are: C for Corporate Action, I for Income.'
example: C
INTRNL_REF_ID_CA:
type: string
description: Custodian Reference (CA) is the unique reference assigned by the Custodian to the record. The reference number is unique within a branch.
example: '15396821'
TRN_CL_CD_CA:
type: string
description: Transaction Class Code (CA) is the transaction type code for corporate action transactions. The parameter values are CATX and (null).
example: CATX
CLIENT_ID_1:
type: string
description: Client ID 1
example: '1068'
CLIENT_ID_2:
type: string
description: Client ID 2
example: '3355'
ACCT_PLEDGE_TYPE:
type: string
description: Account Flag is a flag identifying whether the account is Free, 3rd party Pledge, Pledge HIC.
example: P
EX_DATE:
type: string
format: date
description: Ex Date (Dupe) is the trading cut off date after which position changes will no longer alter the eligibility to the corporate action.
example: '2022-06-30'
PAY_DATE:
type: string
format: date
description: Payable Date is the date on which a dividend or interest payment is scheduled to be paid.
example: '2022-01-05'
PAY_RATE:
type: number
format: double
description: This is a security Master parameter, it relates to the rate paid for the most recent Corporate Action. But It's only populated for US domestic securities (from ASTRA).
example: '0.032757'
SID_LOCAL:
type: string
description: Local ID is the Local security identifier of the associated security.
example: 0059663300
RVSL_IND:
type: string
description: 'The Reversal Indicator notes whether or not the cash transaction was processed to reverse an earlier transaction. Values include: N, R, Y, (null).'
example: Y
CASH_TRANS_TYPE:
type: string
description: A cash transaction type is a business transaction that is settled with immediate exchange of cash.
example: ACH PYMT
MKT_TRANS_TYPE:
type: string
description: Financial Market Transaction Type indicates the type of trade conducted by the Financial Institution. * Domain * Buy Sell Borrow Lend Swap Transfer Exchange.
example: TAX PAYMENT
COB_DATE:
type: string
format: date
description: Close of Business Date
example: '2024-07-10'
IOD_TIMESTAMP:
type: string
format: date-time
description: Provides the Timestamp when data is loaded in the Data Lake
example: '2024-11-12 19:30:08'
HEAD_ACCOUNT:
type: string
description: SCAR Head Account Number
example: '1234567'
SEGMENT:
type: string
description: A Cash Blotter Detail record
example: PAYMENT
f5471486-3c48-45bc-9b1f-05a7d57bdc71-xml-response-schema:
type: object
properties:
row:
type: array
items:
$ref: '#/components/schemas/f5471486-3c48-45bc-9b1f-05a7d57bdc71-data-schema'
xml:
name: data
e31d9564-2523-4b96-8144-1bc9579a7f85-data-schema:
type: object
properties:
ACCT_NME:
type: string
description: Account Name is the name that is assigned to the cash account and/or the safekeeping account. If an alternate account name has been specified for an account it will be displayed as the Account Name.
example: Demo - SK - Japan 2
BUY_CURR_CODE:
type: string
description: Provides the ISO 4217 currency code in which amout will be debited from debit account.sample values are USD/INR.
example: USD
SELL_CURR_CODE:
type: string
description: Provides the ISO 4217 currency code in which amout will be credited in credit account.sample values are USD/INR.
example: USD
BUY_AMT:
type: number
format: double
description: Total Buy amount for a FX trade.
example: 1546.98
SELL_AMT:
type: number
format: double
description: Total Sell amount for a FX trade.
example: 1416.98
TRADE_DT:
type: string
format: date
description: The date on which the actual contract is executed between the buyer and seller of a specific country.
example: '2025-04-02'
VALUE_DT:
type: string
format: date
description: Value Date is the delivery date on which counterparties to a transaction agree to settle their respective obligations by making payments and transferring ownership.
example: '2025-05-02'
BR_ID:
type: string
description: Branch Code is the identifier of the branch for the account. For the cash account the branch code is a numeric value and for the safekeeping account it is the ISO Country code.
example: '484'
ACCT_ID:
type: string
description: Account ID is an identifier for both a cash account and/or a safekeeping account that is unique within a branch.
example: DEMOSK02US
FX_RATE:
type: number
format: double
description: Client rate Includes forward points on FX rate.
example: 1.0835
SENDER_REFERENCE:
type: string
description: The Sender Reference - from the third party or the internal source system.
example: TRX20240613567
CITI_REFERENCE:
type: string
description: Custodian Reference (Internal) is a Citi generated identifier for a unique cash transaction record. This attribute is only valid within Citi and we recommend that it should not be used by clients.
example: FX98765432
FX_TYPE:
type: string
description: 'Forex traders transact in one of three distinct marketplaces: the spot, the forward, or the futures market.'
example: SPOT
FX_BRKR_BIC_CODE:
type: string
description: FX Broker bank identitfier code.
example: CITIUS33
FX_BRKR_NME:
type: string
description: FX Broker Name. A forex broker is a financial services company that provides traders access to a platform for buying and selling foreign currencies.
example: Citibank N.A
e31d9564-2523-4b96-8144-1bc9579a7f85-json-response-schema:
type: object
properties:
Count:
type: number
format: integer
PagedList:
type: array
items:
$ref: '#/components/schemas/e31d9564-2523-4b96-8144-1bc9579a7f85-data-schema'
e31d9564-2523-4b96-8144-1bc9579a7f85-xml-response-schema:
type: object
properties:
row:
type: array
items:
$ref: '#/components/schemas/e31d9564-2523-4b96-8144-1bc9579a7f85-data-schema'
xml:
name: data
4b1404f9-e30e-434d-aca0-151861edacf1-json-response-schema:
type: object
properties:
Count:
type: number
format: integer
PagedList:
type: array
items:
$ref: '#/components/schemas/4b1404f9-e30e-434d-aca0-151861edacf1-data-schema'
3de83cae-f7b8-4ba6-8f2f-4869ce6284e2-xml-response-schema:
type: object
properties:
row:
type: array
items:
$ref: '#/components/schemas/3de83cae-f7b8-4ba6-8f2f-4869ce6284e2-data-schema'
xml:
name: data
3de83cae-f7b8-4ba6-8f2f-4869ce6284e2-json-response-schema:
type: object
properties:
Count:
type: number
format: integer
PagedList:
type: array
items:
$ref: '#/components/schemas/3de83cae-f7b8-4ba6-8f2f-4869ce6284e2-data-schema'
4b1404f9-e30e-434d-aca0-151861edacf1-data-schema:
type: object
properties:
ACCT_ID:
type: string
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
example: DEMOSK02US
ACCT_NME:
type: string
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
example: Demo - SK - Japan 2
CPRT_ACCT_SER_NAME:
type: string
description: Counterparty's Account Servicer/Depository is the name of the counterparty's account servicer/depository.
example: Demo_xxxden
RPT_PER_DT_START:
type: string
format: date-time
description: The date calculated based on the Period chosen as the start date for the report.
example: '2025-10-01 00:00:00'
RPT_PER_DT_END:
type: string
format: date-time
description: The date calculated based on the Period chosen as the end date for the report.
example: '2025-04-30 00:00:00'
CASH_ACCT_ID:
type: string
description: Cash Account ID is the account number for the cash account. It is unique within a branch.
example: Demo_nnn0422
CPRT_NET_AMT_CURR:
type: string
description: Net Amount Currency is the currency of the Net Amount.
example: EUR
AGGR_AMT:
type: number
format: double
description: The global net amount for a party is the sum of all cash penalties in this currency that this party is entitled to receive minus the sum of all cash penalties in this currency that are imposed to the party. A positive amount indicates that the party will be credited with this amount; a negative amount indicates that the amount will be debited.
example: 432.51
PFOD_MESG_ID:
type: string
description: Reference of the penalty payment.
example: P2503DASI0496761
ACCT_SERVR_BIC:
type: string
description: Account Servicer/Depository BIC is the Bank Identifier code of the party which administers the account.
example: CEDELULLXXX
CURRENCY:
type: string
description: Currency in which the penalties are expressed.
example: EUR
RLTD_PARTY_BIC:
type: string
description: Identification of the party reported as party imposed with the penalties reported or party credited with the penalty(ies).
example: '5053360000'
PARTY_TYPE:
type: string
description: Specifies the role of the party in the transaction.
example: CSDP
CPRT_BIC:
type: string
description: Counterparty BIC is the Bank Identifier code of the party imposed with the penalties reported or party credited with the penalty(ies).
example: GIBAHUHBXXX
CPRT_TYPE:
type: string
description: Specifies the role of the counterparty in the transaction
example: NCSD
CPRT_NET_AMT:
type: number
format: double
description: The bilateral net amount for a party and counterpart will be the sum of all cash penalties in this currency that this party is entitled to receive (reported as credit) from the same counterpart (that is, to be paid by this counterpart) minus the sum of all cash penalties in this currency that are imposed to the party (reported as debit) and to be paid to the given counterpart.
example: 782.86
COM_REF:
type: string
description: Common Reference is assigned by the market infrastructure (for example T2S) to the penalty and that is common for both the failing and the non-failing participant.
example: Demo_nnnnnnn91783743
PENALTY_REF:
type: string
description: Reference is assigned by the market infrastructure to the penalty and is the individual identification of the penalty for the relevant account owner (that is, either for the failing participant or for the non-failing participant).
example: Demo_nnnnnnn00005816
PENALTY_TYP_CD:
type: string
description: Penalty Type indicates whether the penalty is a late matching fail penalty (LMFP) or a settlement fail penalty (SEFP).
example: SEFP
PENALTY_AMT_COMP:
type: integer
format: int32
description: Indicates whether or not the amount calculated for the reported penalty will be added to the aggregated amounts at global level. There could be several reasons for not considering the penalty amount. The flag is used to indicate an exceptional situation. If the flag is not reported in the message this means that the penalty is considered for the calculation of aggregated amounts.
example: 1
PENALTY_AMT:
type: integer
format: int32
description: Penalty Amount is calculated based on the security and instruction characteristics and the reason for the fail. For a Late Matching Fail Penalty (LMFP) that spans several business days, this amount is the sum of the amounts calculated for each applicable business day.
example: 257
CALC_METHOD:
type: string
description: Calcualtion Method indixates the calculation rule used to compute the penalty. Values are CASH, MIXE, SECU, BOTH.
example: CASH
NBR_OF_DAYS:
type: integer
format: int32
description: Number of Days is the number of days over which a late matching penalty has been calculated.
example: 16
ACCT_OWN_TX_ID:
type: string
description: Reference assigned to the reported transaction by the account owner.
example: '66176038465'
ACCT_SEC_TX_ID:
type: string
description: Reference assigned to the reported transaction by the account servicer.
example: H0000Y0ZB757CAI
PROCESSOR_TX_ID:
type: string
description: Identification of the transaction assigned by the processor of the instruction other than the account owner/the account servicer and the market infrastructure.
example: CSTDY00119545130
MKT_INFR_TX_ID:
type: string
description: Identification of a transaction assigned by a market infrastructure other than a central securities depository, for example, Target2-Securities.
example: '2503275363718075'
COMMON_ID:
type: string
description: Unique reference agreed upon by the Investment Manager and the Broker/Dealer to identify the trade. This reference should be passed down and up through the whole life cycle of the transaction.
example: 1403X34328787
CORP_ACT_EV_ID:
type: string
description: Reference assigned by the account servicer to unambiguously identify a related corporate action event.
example: AC17062532
RELATED_TX_ID:
type: string
description: Reference of the linked message which was previously received.
example: '66149993234'
PEN_PY_DT:
type: string
format: date
description: Payment Date is the date at which the last payment on the entitlement was made. Or Date/time at which the movement is due to take place (cash and/or securities).
example: '2025-02-10'
CPRT_ACCT_SER_BIC:
type: string
description: Counterparty's Account Servicer/Depository BIC is the Bank Identifier of the counterparty's account servicer/depository.
example: IBLSPTPPXXX
PENALTY_DETEC_DT:
type: string
format: date
description: 'Penalty Detection Date is the day for which the penalty was computed. /nIt is the date on which the instruction matched for Late Matching Fail Penalty (LMFP) or the date on which an instruction fails to settle for Settlement Fail Penalty (SEFP). /nNote: This date is not updated upon re-calculation of the penalty and always relates to the business day for which the penalty was initially computed.'
example: '2025-03-10'
PENALTY_STATUS:
type: string
description: Penalty status is to check if penalty is active or inactive for a given record.
example: ACTV
4b1404f9-e30e-434d-aca0-151861edacf1-xml-response-schema:
type: object
properties:
row:
type: array
items:
$ref: '#/components/schemas/4b1404f9-e30e-434d-aca0-151861edacf1-data-schema'
xml:
name: data
3de83cae-f7b8-4ba6-8f2f-4869ce6284e2-data-schema:
type: object
properties:
ACCT_ID:
type: string
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
example: DEMOSK02US
ACCT_NME:
type: string
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
example: Demo - SK - Japan 2
ACCT_OWN_NAME:
type: string
description: Account Servicer/Depository is the name of the party which administers the account.
example: Demo_d Ltd
CPRT_NAME:
type: string
description: Counterparty is the name of the party imposed with the penalties or credited with the penalty(ies).
example: ECLR/10608
PENALTY_DETEC_DT:
type: string
format: date
description: 'Penalty Detection Date is the day for which the penalty was computed. /nIt is the date on which the instruction matched for Late Matching Fail Penalty (LMFP) or the date on which an instruction fails to settle for Settlement Fail Penalty (SEFP). /nNote: This date is not updated upon re-calculation of the penalty and always relates to the business day for which the penalty was initially computed.'
example: '2025-03-10'
PENALTY_REF:
type: string
description: Reference is assigned by the market infrastructure to the penalty and is the individual identification of the penalty for the relevant account owner (that is, either for the failing participant or for the non-failing participant).
example: F260305454043360
COM_REF:
type: string
description: Common Reference is assigned by the market infrastructure (for example T2S) to the penalty and that is common for both the failing and the non-failing participant.
example: C070200015097454
PENALTY_TYP_CD:
type: string
description: Penalty Type indicating whether it is a Late Matching Fail Penalty (LMFP) or Settlement Fail Penalty (SEFP).
example: LMFP
PENALTY_AMT_CURR:
type: string
description: Penalty Currency is the ISO 4217 currency code for the currency of the penalty amount.
example: USD
PENALTY_AMT:
type: number
format: double
description: Penalty Amount is calculated based on the security and instruction characteristics and the reason for the fail. For a Late Matching Fail Penalty (LMFP) that spans several business days, this amount is the sum of the amounts calculated for each applicable business day.
example: 250.75
PFD_ID_CTXT_CD:
type: string
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID field. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
example: CUSIP
PFD_ISS_ID:
type: string
description: Security ID is the most commonly used identifier for the security in a given market.
example: CSD12345
SEC_SHRT_NME:
type: string
description: Issue Name is the Security Name of the security instrument.
example: TEMPORARY SECURITY 000BMTYVP8
SID_ISIN:
type: string
description: ISIN (International Securities Identification Number) is a 12-character alpha-numerical code governed by ISO 6166 it is a uniform identification of a security at trading and settlement. This data is sourced from multiple sources and will be provided if available.
example: US88160R1014
CLIENT_SEC_REF:
type: string
description: Custodian reference is i a unique identifier assigned to a client’s securities or accounts by the custodian
example: Demo_nnnnn086021
CLIENT_REF:
type: string
description: Client Reference is a unique number assigned by the client, to the transaction, for identification purposes within their organization.
example: Demo_xxnnn54792
TRADE_DT:
type: string
format: date
description: Date when the trade was agreed on with counterparty.
example: '2025-02-28'
SEC_PEN_RT:
type: number
format: double
description: Security penalty rate applied in the calculation of the penalty.
example: 0.005
CNTR_SETL_DT:
type: string
format: date
description: Contractual Settlement Date represents the agreed‑upon date on which a trade is supposed to settle according to market rules or contractual terms.
example: '2025-03-03'
POST_QTY:
type: number
format: double
description: Quantity provides the number of units, par value or nominal value (for fixed income instruments), amount of currency (for FX transactions), or number of shares. Indicates the contract quantity on the original transaction that was given up.
example: 1500
POST_AMT_CURR:
type: string
description: Settlement Currency is the currency name for the Settlement Amount.
example: EUR
POST_AMT:
type: number
format: double
description: Settlement Amount is the cash value of the trade in the market currency.
example: 450000
PENALTY_STATUS:
type: string
description: Penalty status is to check if penalty is active or inactive for a given record.
example: ACTV
56e333ad-6934-4a26-9924-4c74d60397f2-xml-response-schema:
type: object
properties:
row:
type: array
items:
$ref: '#/components/schemas/56e333ad-6934-4a26-9924-4c74d60397f2-data-schema'
xml:
name: data
56e333ad-6934-4a26-9924-4c74d60397f2-json-response-schema:
type: object
properties:
Count:
type: number
format: integer
PagedList:
type: array
items:
$ref: '#/components/schemas/56e333ad-6934-4a26-9924-4c74d60397f2-data-schema'
56e333ad-6934-4a26-9924-4c74d60397f2-data-schema:
type: object
properties:
ACCT_BASE_NBR:
type: string
description: Account Base Number is an internal Citi client identifier that is associated to a Safekeeping or Cash Account.
example: 8-DEMOCSH53JPY
ACCT_BUS_TYP_NME:
type: string
description: Account Type Description indicates the type of the account. Values are CASH (C), S/K (S)
example: C
ACCT_CLS_DT:
type: string
format: date
description: Account Close Date is the date when the account was closed. It will only have a value if the account is closed.
example: '2025-08-02'
ACCT_ID:
type: string
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
example: DEMOCSH53JPY
ACCT_NME:
type: string
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
example: Demo - Cash - Japan JPY 11
ACCT_OPN_DT:
type: string
format: date
description: Account Open Date is the date when the account was opened.
example: '2025-08-02'
ACCT_STS_TYP:
type: string
description: Account Status provides the current status of the Cash Account and/or the Safekeeping account. Values are Open, Closed, Frozen
example: Open
ALT_ACCT_NME:
type: string
description: Alternate Account Name is the user provided name for the account as entered using the Account Cabinet. If an Alternate Account Name is not provided this field will be blank.
example: Demo - Cash - Japan JPY 11
ALTV_CUR_CD:
type: string
description: Account Base Currency Code is the ISO Currency Code for the account.
example: JPY
BR_NME:
type: string
description: Branch Name is the name of the branch for the Cash Account and/or Safekeeping Account.
example: CITIBANK JAPAN LTD
CASH_TYPE:
type: number
format: double
description: Cash Type Code pertains to US Direct Cash Accounts and indicates whether the Cash Account has a split income and principal balance.
example: 1
GFC_ID:
type:
- string
- 'null'
description: Client ID is an identifier that is available on a Cash Account and/or a Safekeeping Account.
example: '1000123456'
IBAN:
type:
- string
- 'null'
description: IBAN ISO 13616:1997 is the International Bank Account Number for the Cash Account.
example: null
LEGAL_ENTITY:
type:
- string
- 'null'
description: This identifies the branch that is the Legal Entity for a Global Window branch.
example: null
RELATED_SAFEKEEPING_ACCT_ID:
type:
- string
- 'null'
description: This provides safekeeping account related to a cash account
example: null
1040640e-125f-41e2-a262-88dea5f338bd-xml-response-schema:
type: object
properties:
row:
type: array
items:
$ref: '#/components/schemas/1040640e-125f-41e2-a262-88dea5f338bd-data-schema'
xml:
name: data
bbe2a729-c02f-4e5c-8c56-8001d04e5933-xml-response-schema:
type: object
properties:
row:
type: array
items:
$ref: '#/components/schemas/bbe2a729-c02f-4e5c-8c56-8001d04e5933-data-schema'
xml:
name: data
1040640e-125f-41e2-a262-88dea5f338bd-data-schema:
type: object
properties:
BR_ID:
type: string
description: Branch Code is the identifier of the branch for the account. For the Cash Account the branch code is a numeric value and for the Safekeeping Account it is the ISO Country code.
example: '484'
ALTV_CUR_CD:
type: string
description: Account Base Currency Code is the ISO Currency Code for the account.
example: JPY
ACCT_BASE_NBR:
type: string
description: Account Base Number is an internal Citi client identifier that is associated to a Safekeeping or Cash Account.
example: 8-DEMOCSH53JPY
ALTN_CUR_EXCH_RATE:
type: number
format: double
description: The exchange rate used to convert Local Market Valuation to the Alternative Currency Valuation. Not applicable to the US domestic positions.
example: '8.9076'
ALTV_CUR_VAL:
type: number
format: double
description: Base Currency Valuation is the Market Valuation in the Account Base Currency of the position for the "As Of" date.
example: '138923711.7'
ISS_CAT_NME:
type: string
description: 'Issue Category is the description for the Issue Category Code. Values include: Common Stock (CSTK), Derivatives (DERIV), Mortgage Backed Securities (MBS), etc.'
example: EQUITIES
SEC_GROUP:
type: string
description: 'Asset Type is a code representing the Asset Type of the security. Values include: EQTY (Equity), FI (Fixed Income), etc.'
example: FI
BR_NME:
type: string
description: Branch Name is the name of the branch for the Cash Account and/or Safekeeping Account.
example: NEW YORK SECURITIES CB
CNTR_CD:
type: string
description: Place Of Settlement Code is a 3 digit code corresponding to the settlement location of the holding.
example: RSA
CNTR_CD_DESC:
type: string
description: The center code description applicable to securities transactions only.
example: NORTHFIELD LLC
CURR_FCTR:
type: number
format: double
description: Current Factor is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
example: '0.01580556'
GFC_ID:
type: string
description: Client ID is an identifier that is available on a Cash Account and/or a Safekeeping Account. This Client ID is referred to, internally at Citi, as a GFCID.
example: '1000012345'
DTED_TMS:
type: string
format: date-time
description: Dated Date/Time is the date that the interest begins to accrue on a fixed-income security.
example: '2019-08-26 00:00:00'
DLAY_DAYS:
type: string
description: Delay Days is the number of days from the issuance of an MBS pool (or from the beginning of the interest accrual period) until the first payment is remitted/paid to the holders.
example: '13'
DNOMD_CUR_CD:
type: string
description: Denomination Currency Code is the ISO currency code in which the security is denominated, in the local market.
example: HKD
CNTRY_CD:
type: string
description: The Country Code (location) of the security custodian. Not applicable to the US domestic positions.
example: JE
SETL_HOLD_ST:
type: string
description: How Position is Held Code is a 2 digit code corresponding to the How Position Is Held parameter which carries the status of the holding, or where it is held.
example: LE
SEC_DESC:
type: string
description: Issue Description contains the name and other details of the instrument.
example: TEMPORARY SECURITY 003263100
ISS_PRC:
type: number
format: double
description: Issue Price is the market price of the security at the "As Of" date.
example: '35.811'
SEC_SUB_TYP_CD:
type: string
description: 'Issue Type Code is a code linked to the Issue Type parameter which describes the type of security instrument. Values include: 1 (ADR Convertible), 12 (Bond), 19 (Bond Convertible), etc.'
example: '12'
SEC_SUB_TYP_NME:
type: string
description: 'Issue Type is a description of the type of the security instrument. Values include: ADR Convertible (1), Bond (12) , Bond Convertible (19), etc.'
example: BOND
ISSR_LOC_CD:
type: string
description: 'Issuer Location Code is the ISO country code where the issuer of the security is based. Values include: AR (Argentina), CA (Canada), IE (Ireland), etc.'
example: CA
ISSR_LOC_NME:
type: string
description: 'Issuer Location is the name of the country where the issuer of the security is based. Values include: Argentina (AR), Canada (CA), Ireland (IE), etc.'
example: CANADA
MKT_VAL_AMT:
type: number
format: double
description: The market price of the holding multiplied by the number of units or shares held. Usually, the monetary value of the holding. This is the indicative valuation of the position at EOD using the Issue Price supplied.
example: '927444.82'
STK_EXCHG_NME:
type: string
description: Nominee Description is the nominee name and/or other nominee information.
example: VIDACOS NOMINEES LIMITED
PMT_FREQY_DESC:
type: string
description: 'Payment Frequency Description indicates how often interest is paid on the security. Values include: Annual (00001), Sem-Annual (00002), One Payment Per Year (00035), etc.'
example: Annual
PNDNG_DELIV:
type: number
format: double
description: Pending Deliverable is the sum of the quantity of outstanding deliver trades at the "As Of" date.
example: '-34891'
PNDNG_RECV:
type: number
format: double
description: Pending Receivable is the sum of the quantity of outstanding receive trades at the "As Of" date.
example: '353400'
POOL_ID_CD:
type: string
description: Pool ID is an alphanumeric code that identifies a particular mortgage backed security.
example: AB1234
HLDNG_UPD_TMS:
type: string
format: date-time
description: Position Update Timestamp is the date/time when the holding was last updated.
example: '2019-08-27 00:00:00'
PREV_FCTR:
type: number
format: double
description: The factor which applies for the previous accrual period to determine payments and balances for principal paying securities. Currently applicable to the US intraday cash transactions.
example: '0.84824716'
PRC_CCY_NME:
type: string
description: Market Value Currency is the name of the currency used to value the holding.
example: POUND STERLING
SID_SEDOL:
type: string
description: SEDOL (Stock Exchange Daily Official List) is a unique identification code, consisting of seven alphanumeric characters, that is assigned to all securities trading on the London Stock Exchange.
example: BJ18KB6
SID_CUSIP:
type: string
description: CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.
example: T5379P105
ST_NME:
type: string
description: State is the state where this statutory deposit is placed. Applies only to US Domestic holdings.
example: CALIFORNIA
ST_CD:
type: string
description: State Code is a 2 digit code corresponding to the State where this statutory deposit is placed. Applies only to US Domestic holdings.
example: CA
STRK_PRC_AMT:
type: number
format: double
description: Strike Price is the specified price on an options contract at which the contract may be exercised.
example: '109.9'
SID_TICKER_SYMB:
type: string
description: Ticker is the symbol used on the exchange to identify the security.
example: DARK
TRDED_QTY:
type: number
format: double
description: Traded Quantity is the quantity of the security held including any open trades.
example: '755435'
MKT_PRC_CUR_CD:
type: string
description: Market Value Currency Code is the ISO currency code of the Market Value.
example: GBP
ACCT_ID:
type: string
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
example: DEMOSK02US
ACCT_NME:
type: string
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
example: Demo - SK - Japan 2
MATY_DT:
type: string
format: date-time
description: Maturity Date is the date of maturity or redemption for fixed income securities.
example: '2041-10-10 00:00:00'
PFD_ID_CTXT_CD:
type: string
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID parameter. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
example: ISIN
PFD_ISS_ID:
type: string
description: Security ID is the most commonly used identifier for the security in a given market.
example: BFXCMX
SID_ISIN:
type: string
description: ISIN (International Securities Identification Number) is a 12-character alpha-numerical code that does not contain information characterizing financial instruments but serves for uniform identification of a security at trading and settlement.
example: JP3049040003
SEC_SHRT_NME:
type: string
description: Issue Name is the Security Name of the security instrument.
example: FR QN4224
INCM_PROJN_RATE:
type: number
format: double
description: Interest Rate is the coupon rate of the security.
example: '3.0946'
SETLD_QTY:
type: number
format: double
description: Settled Quantity is the quantity that has settled or the quantity of the security that is fully settled at the "As Of" date. For partial settlements the settled quantity is the portion that has settled.
example: '165502'
HOLD_LOCN_NME:
type: string
description: How Position is Held is a description of the status of the holding, or where it is held.
example: HELD AT DEPOSITORY
ORGL_FCE_VAL:
type: number
format: double
description: Face Value is the original face value for Mortgage Backed Securities in the US domestic market. For other MBS positions this will be the current face value after amortization.
example: '6053'
ASOF_TMS:
type: string
format: date-time
description: The As Of Date is the date of the information being reported.
example: '2019-12-30 00:00:00'
EOD_INTRA_IND:
type: string
description: EOD/intraday Indicator advises if the balance is an End of Day reported balance or if the balance is an Intraday reported balance. Values are:
1 (Intraday)
2 (End of Day)
example: '2'
ACCT_BUS_TYP_CD:
type: string
description: Account Type Code indicates the type of the account. Values are:
C (Cash Account)
S (Safekeeping Account).
example: C
SEC_SECURITY_CD:
type: string
description: CITI Internal Security Code is the identifier of the CITI Internal Security Identifier.
example: 000BMG6KT4
ISS_TMS:
type: string
format: date-time
description: Issue Date is the date of first issue of the security.
example: '2019-11-26 00:00:00'
ISS_CATG_CD:
type: string
description: 'Issue Category Code is a specific category for the security. Values include: CSTK (Common Stock), DERIV (Derivatives), MBS (Mortgage Backed Securities), etc.'
example: EQTY
US_SIC_CD:
type: string
description: SIC is the Standard Industrial Classification four-digit numeric code.
example: '3544'
PMT_FREQY:
type: string
description: 'Payment Frequency indicates how often interest is paid on the security. Values include: 00001 (Annual), 00002 (Sem-Annual), 00035 (One Payment Per Year), etc.'
example: '00001'
FCTR_DTE:
type: string
format: date-time
description: Factor Date is the date the current factor is applicable from for principal paying securities.
example: '2023-12-10 00:00:00'
SID_LOCAL:
type: string
description: Local ID is the Local security identifier of the associated security.
example: 0059663300
COB_DATE:
type: string
format: date
description: Close of Business Date
example: '2024-07-10'
TRDED_QTY_MKT_EOD:
type: number
format: double
description: Traded Quantity is the quantity of the security held including any open trades as of market close date
example: '123456'
SETLD_QTY_MKT_EOD:
type: number
format: double
description: Settled Quantity is the quantity of the security that is fully settled as of market close date
example: '12345'
MKT_EOD_CL_DT:
type: string
format: date
description: This is the last close date for the position in the local market.
example: '2024-11-12'
PLACE_OF_SETLMT:
type: string
description: Place Of Settlement is the name of the settlement location for the security, applicable to securities positions , transactions only.
example: MOSCOW
ROLLED_FWD:
type: string
description: Rolled Forward indicator parameter is used to flag if position valuation has been rolled forward from last close of business.
example: N
IOD_TIMESTAMP:
type: string
format: date-time
description: Provides the Timestamp when data is loaded in the Data Lake
example: '2024-11-12 19:30:08'
bbe2a729-c02f-4e5c-8c56-8001d04e5933-data-schema:
type: object
properties:
ACCT_BASE_NBR:
type: string
description: Account Base Number is an internal Citi client identifier that is associated to a Safekeeping or Cash Account.
example: 8-DEMOCSH53JPY
ACCT_BUS_TYP_CD:
type: string
description: Account Type Code indicates the type of the account. Values are:
C (Cash Account)
S (Safekeeping Account).
example: C
ACCT_ID:
type: string
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
example: DEMOSK02US
ACCT_NME:
type: string
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
example: Demo - SK - Japan 2
ALTN_CUR_EXCH_RATE:
type: number
format: double
description: The exchange rate used to convert Local Market Valuation to the Alternative Currency Valuation. Not applicable to the US domestic positions.
example: '8.9076'
ALTV_CUR_CD:
type: string
description: Account Base Currency Code is the ISO Currency Code for the account.
example: JPY
ALTV_CUR_VAL:
type: number
format: double
description: Base Currency Valuation is the Market Valuation in the Account Base Currency of the position for the "As Of" date.
example: '138923711.7'
ASOF_TMS:
type: string
format: date-time
description: The As Of Date is the date of the information being reported.
example: '2019-12-30 00:00:00'
BR_ID:
type: string
description: Branch Code is the identifier of the branch for the account.For the Cash Account the branch code is a numeric value and for the Safekeeping Account it is the ISO Country code.
example: '484'
BR_NME:
type: string
description: Branch Name is the name of the branch for the Cash Account and/or Safekeeping Account.
example: NEW YORK SECURITIES CB
CNTR_CD:
type: string
description: Place Of Settlement Code is a 3 digit code corresponding to the settlement location of the holding.
example: RSA
CNTR_CD_DESC:
type: string
description: The center code description applicable to securities transactions only.
example: NORTHFIELD LLC
CNTRY_CD:
type: string
description: The Country Code (location) of the security custodian. Not applicable to the US domestic positions.
example: JE
COB_DATE:
type: string
format: date
description: Close of Business Date
example: '2024-07-10'
CURR_FCTR:
type: number
format: double
description: Current Factor is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
example: '0.01580556'
DLAY_DAYS:
type: string
description: Delay Days is the number of days from the issuance of an MBS pool (or from the beginning of the interest accrual period) until the first payment is remitted/paid to the holders.
example: '13'
DNOMD_CUR_CD:
type: string
description: Denomination Currency Code is the ISO currency code in which the security is denominated, in the local market.
example: HKD
DTED_TMS:
type: string
format: date-time
description: Dated Date/Time is the date that the interest begins to accrue on a fixed-income security.
example: '2019-08-26 00:00:00'
EOD_INTRA_IND:
type: string
description: 'EOD/intraday Indicator advises if the balance is an End of Day reported balance or if the balance is an Intraday reported balance. Values are:
1 (Intraday)
2 (End of Day)'
example: '2'
FCTR_DTE:
type: string
format: date-time
description: Factor Date is the date the current factor is applicable from for principal paying securities.
example: '2023-12-10 00:00:00'
GFC_ID:
type: string
description: Client ID is an identifier that is available on a Cash Account and/or a Safekeeping Account. This Client ID is referred to, internally at Citi, as a GFCID.
example: '1000012345'
HLDNG_UPD_TMS:
type: string
format: date-time
description: Position Update Timestamp is the date/time when the holding was last updated.
example: '2019-08-27 00:00:00'
HOLD_LOCN_NME:
type: string
description: How Position is Held is a description of the status of the holding, or where it is held.
example: HELD AT DEPOSITORY
INCM_PROJN_RATE:
type: number
format: double
description: Interest Rate is the coupon rate of the security.
example: '3.0946'
IOD_UPDATE_TMS:
type: string
format: date-time
description: IOD Timestamp
example: '2020-06-12 16:01:15'
ISS_CAT_NME:
type: string
description: 'Issue Category is the description for the Issue Category Code. Values include: Common Stock (CSTK), Derivatives (DERIV), Mortgage Backed Securities (MBS), etc.'
example: EQUITIES
ISS_CATG_CD:
type: string
description: 'Issue Category Code is a specific category for the security. Values include: CSTK (Common Stock), DERIV (Derivatives), MBS (Mortgage Backed Securities), etc.'
example: EQTY
ISS_PRC:
type: number
format: double
description: Issue Price is the market price of the security at the "As Of" date.
example: '35.811'
ISS_TMS:
type: string
format: date-time
description: Issue Date is the date of first issue of the security.
example: '2019-11-26 00:00:00'
ISSR_LOC_CD:
type: string
description: 'Issuer Location Code is the ISO country code where the issuer of the security is based. Values include: AR (Argentina), CA (Canada), IE (Ireland), etc.'
example: CA
ISSR_LOC_NME:
type: string
description: 'Issuer Location is the name of the country where the issuer of the security is based. Values include: Argentina (AR), Canada (CA), Ireland (IE), etc.'
example: CANADA
MATY_DT:
type: string
format: date-time
description: Maturity Date is the date of maturity or redemption for fixed income securities.
example: '2041-10-10 00:00:00'
MKT_PRC_CUR_CD:
type: string
description: Market Value Currency Code is the ISO currency code of the Market Value.
example: GBP
ORGL_FCE_VAL:
type: number
format: double
description: Face Value is the original face value for Mortgage Backed Securities in the US domestic market. For other MBS positions this will be the current face value after amortization.
example: '6053'
PFD_ID_CTXT_CD:
type: string
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID parameter. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
example: ISIN
PFD_ISS_ID:
type: string
description: Security ID is the most commonly used identifier for the security in a given market.
example: BFXCMX
PLACE_OF_SETLMT:
type: string
description: Place Of Settlement is the name of the settlement location for the security, applicable to securities positions , transactions only.
example: MOSCOW
PMT_FREQY:
type: string
description: 'Payment Frequency indicates how often interest is paid on the security. Values include: 00001 (Annual), 00002 (Sem-Annual), 00035 (One Payment Per Year), etc.'
example: '00001'
PMT_FREQY_DESC:
type: string
description: 'Payment Frequency Description indicates how often interest is paid on the security. Values include: Annual (00001), Sem-Annual (00002), One Payment Per Year (00035), etc.'
example: Annual
PNDNG_DELIV:
type: number
format: double
description: Pending Deliverable is the sum of the quantity of outstanding deliver trades at the "As Of" date.
example: '-34891'
PNDNG_RECV:
type: number
format: double
description: Pending Receivable is the sum of the quantity of outstanding receive trades at the "As Of" date.
example: '353400'
POOL_ID_CD:
type: string
description: Pool ID is an alphanumeric code that identifies a particular mortgage backed security.
example: AB1234
PRC_CCY_NME:
type: string
description: Market Value Currency is the name of the currency used to value the holding.
example: POUND STERLING
PREV_FCTR:
type: number
format: double
description: The factor which applies for the previous accrual period to determine payments and balances for principal paying securities. Currently applicable to the US intraday cash transactions.
example: '0.84824716'
SEC_DESC:
type: string
description: Issue Description contains the name and other details of the instrument.
example: TEMPORARY SECURITY 003263100
SEC_GROUP:
type: string
description: 'Asset Type is a code representing the Asset Type of the security. Values include: EQTY (Equity), FI (Fixed Income), etc.'
example: FI
SEC_SECURITY_CD:
type: string
description: CITI Internal Security Code is the identifier of the CITI Internal Security Identifier.
example: 000BMG6KT4
SEC_SHRT_NME:
type: string
description: Issue Name is the Security Name of the security instrument.
example: FR QN4224
SEC_SUB_TYP_CD:
type: string
description: 'Issue Type Code is a code linked to the Issue Type parameter which describes the type of security instrument. Values include: 1 (ADR Convertible), 12 (Bond), 19 (Bond Convertible), etc.'
example: '12'
SEC_SUB_TYP_NME:
type: string
description: 'Issue Type is a description of the type of the security instrument. Values include: ADR Convertible (1), Bond (12) , Bond Convertible (19), etc.'
example: BOND
SETL_HOLD_ST:
type: string
description: How Position is Held Code is a 2 digit code corresponding to the How Position Is Held parameter which carries the status of the holding, or where it is held.
example: LE
SETLD_QTY:
type: number
format: double
description: Settled Quantity is the quantity that has settled or the quantity of the security that is fully settled at the "As Of" date. For partial settlements the settled quantity is the portion that has settled.
example: '165502'
SID_CUSIP:
type: string
description: CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.
example: T5379P105
SID_ISIN:
type: string
description: ISIN (International Securities Identification Number) is a 12-character alpha-numerical code that does not contain information characterizing financial instruments but serves for uniform identification of a security at trading and settlement.
example: JP3049040003
SID_LOCAL:
type: string
description: Local ID is the Local security identifier of the associated security.
example: 0059663300
SID_SEDOL:
type: string
description: SEDOL (Stock Exchange Daily Official List) is a unique identification code, consisting of seven alphanumeric characters, that is assigned to all securities trading on the London Stock Exchange.
example: BJ18KB6
SID_TICKER_SYMB:
type: string
description: Ticker is the symbol used on the exchange to identify the security.
example: DARK
ST_CD:
type: string
description: State Code is a 2 digit code corresponding to the State where this statutory deposit is placed. Applies only to US Domestic holdings.
example: CA
ST_NME:
type: string
description: State is the state where this statutory deposit is placed. Applies only to US Domestic holdings.
example: CALIFORNIA
STK_EXCHG_NME:
type: string
description: Nominee Description is the nominee name and/or other nominee information.
example: VIDACOS NOMINEES LIMITED
STRK_PRC_AMT:
type: number
format: double
description: Strike Price is the specified price on an options contract at which the contract may be exercised.
example: '109.9'
TRDED_QTY:
type: number
format: double
description: Traded Quantity is the quantity of the security held including any open trades.
example: '755435'
US_SIC_CD:
type: string
description: SIC is the Standard Industrial Classification four-digit numeric code.
example: '3544'
TRDED_QTY_MKT_EOD:
type: number
format: double
description: Traded Quantity is the quantity of the security held including any open trades as of market close date
example: '123456'
SETLD_QTY_MKT_EOD:
type: number
format: double
description: Settled Quantity is the quantity of the security that is fully settled as of market close date
example: '12345'
MKT_EOD_CL_DT:
type: string
format: date
description: This is the last close date for the position in the local market.
example: '2024-11-12'
1040640e-125f-41e2-a262-88dea5f338bd-json-response-schema:
type: object
properties:
Count:
type: number
format: integer
PagedList:
type: array
items:
$ref: '#/components/schemas/1040640e-125f-41e2-a262-88dea5f338bd-data-schema'
bbe2a729-c02f-4e5c-8c56-8001d04e5933-json-response-schema:
type: object
properties:
Count:
type: number
format: integer
PagedList:
type: array
items:
$ref: '#/components/schemas/bbe2a729-c02f-4e5c-8c56-8001d04e5933-data-schema'
27d18376-6358-40f1-9f63-23a72d40196f-xml-response-schema:
type: object
properties:
row:
type: array
items:
$ref: '#/components/schemas/27d18376-6358-40f1-9f63-23a72d40196f-data-schema'
xml:
name: data
c5da44dd-2c3c-42cc-8125-711c2aadbe4f-data-schema:
type: object
properties:
ACCT_BASE_NBR:
type: string
description: Account Base Number is an internal Citi client identifier that is associated to a Safekeeping or Cash Account.
example: 8-DEMOCSH53JPY
ACCT_ID:
type: string
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
example: DEMOSK02US
ACCT_NME:
type: string
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
example: Demo - SK - US DCC Equity
ACT_SETT_DT:
type: string
format: date
description: Actual Settlement Date is the date of final settlement of the trade.
example: '2024-06-15'
BR_ID:
type: string
description: Branch Code is the identifier of the branch for the account. For the Cash Account the branch code is a numeric value and for the Safekeeping Account it is the ISO Country code.
example: '484'
BR_NME:
type: string
description: Branch Name is the name of the branch for the Cash Account and/or Safekeeping Account.
example: NEW YORK SECURITIES CB
RELATED_REF:
type: string
description: Related Reference is the value provided via RELA tag on the underlying instruction.
example: RELA123456
CLIENT_REF:
type: string
description: Client Reference is a unique number assigned by the client, to the transaction, for identification purposes within their organization.
example: '12345678'
BUYR_SELL_CD:
type: string
description: Buyer/Seller Code is the code associated to the Buyer/Seller.
example: B
CLR_BRKR_NME:
type: string
description: Clearing Broker Name is the name of the firm that guarantees the obligations of the parties in an exchange traded security or derivative transaction.
example: Goldman Sachs
CONTR_SETT_DT:
type: string
format: date-time
description: Contractual Settlement Date is the date when the clients cash account should be credited with funds on a sale (and debited on a purchase) on the due settlement date in place of when a trade actually settles in the market.
example: '2024-06-15T10:30:00Z'
CNTRY_CD:
type: string
description: The Country Code (location) of the security custodian. Not applicable to the US domestic positions.
example: US
COMP_DESC:
type: string
description: Company Description contains information regarding the company which issued the security.
example: Microsoft Corporation
CONTR_SETT_FLG:
type: string
description: Contractual Settlement Flag indicates whether the trade will settle on the Contractual Settlement Date whether or not it actually settles. Values are Y (settle on contractual settlement date) or N (settle on actual settlement date).
example: Y
CURR_FCTR_RATE:
type: number
format: double
description: Current Factor is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
example: 0.9875
DEAL_REF_NBR:
type: string
description: OTM Reference is the Order and Trade Manager Reference number that has been assigned to the order instructions.
example: OTM123456789
HOLDING_TYPE:
type: string
description: How Position is Held is a description of the status of the holding affected by the trade, or where that holding is held.
example: Held At Depot
SEC_CCY:
type: string
description: Denomination Currency Code is the ISO 4217 currency code in which the security is denominated, in the local market.
example: USD
FAIL_AGE:
type: integer
format: int32
description: Fail Age is the number of days the transaction has not settled, past the contractual settlement date.
example: 5
FAIL_DESC:
type: string
description: Fail Description provides the reason why the trade has not or is not expected to settle on the contractual settlement date.
example: Insufficient Securities
FAIL_TXT:
type: string
description: Fail Text provides additional information on the reason for failure.
example: Counterparty has not delivered securities.
FCTR_DTE:
type: string
format: date-time
description: Factor Date is the date the current factor is applicable from for principal paying securities.
example: '2024-06-01T00:00:00Z'
INST_DT:
type: string
format: date
description: Instruction Date is the date the trade was first received.
example: '2024-06-10'
ISS_TMS:
type: string
format: date-time
description: Issue Date is the date of first issue of the security.
example: '2020-01-01T00:00:00Z'
ISSR_LOC_CD:
type: string
description: 'Issuer Location Code is the ISO country code where the issuer of the security is based. Values include: AR (Argentina), CA (Canada), IE (Ireland), etc. '
example: US
ISSR_LOC_NME:
type: string
description: 'Issuer Location is the name of the country where the issuer of the security is based. Values include: Argentina (AR), Canada (CA), Ireland (IE), etc. '
example: United States
SETT_AMT:
type: number
format: double
description: Settlement Amount is the cash value of the partial settlement in the local currency.
example: 150000.25
LCL_CUR_CD:
type: string
description: Settlement Currency Code is the ISO currency code of the local currency of the Settlement Amount.
example: USD
SETT_CCY:
type: string
description: Settlement Currency is the currency name for the Settlement Amount.
example: US Dollar
LOAN_DT:
type: string
format: date
description: Loan Date is the date the loan originated.
example: '2024-01-15'
LOAN_PURPOSE_CD:
type: string
description: Loan Purpose Code is a code that identifies the purpose of the loan transaction if the position is on loan.
example: COLL
LOAN_PURPOSE_DESC:
type: string
description: Loan Purpose is the description of the purpose of the loan transaction if the position is on loan.
example: Collateral Management
LOAN_REF_ID:
type: string
description: The Loan Reference Number is the number assigned to 3rd party lending transactions. This is for US domestic only.
example: LN123456789
MATY_DT:
type: string
format: date-time
description: Maturity Date is the date of maturity or redemption for fixed income securities.
example: '2030-12-31T00:00:00Z'
PART_UNSETL_QTY:
type: number
format: double
description: Unsettled Quantity shows the quantity that is still yet to settle when there is a partial settlement of the trade.
example: 2500
PARTICIPANT_NO:
type: string
description: DTC Number is the participant or sub-account number at DTCC.
example: 0901
SEC_ID_TYPE:
type: string
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID field. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
example: ISIN
SEC_ID:
type: string
description: Security ID is the most commonly used identifier for the security in a given market.
example: US0378331005
PLACE_OF_SETLMT:
type: string
description: Place Of Settlement is the name of the settlement location for the security, applicable to securities positions, transactions only.
example: TOKYO, JAPAN
PLDG_ABA_NAM:
type: string
description: American Bankers Association Description is the name of the institution identified by the ABA number.
example: Citibank N.A.
PLDG_ABA_NO:
type: string
description: ABA Number is the American Bankers Association Transit Number used to identify a US institution.
example: 021000089
PLDG_REF_NBR:
type: string
description: Pledge Reference is the unique reference number for the pledge transaction.
example: PLG987654321
PREV_FCTR_RATE:
type: number
format: double
description: Previous Factor is the factor which applies to the last accrual period to determine payments and balances for principal paying securities.
example: 0.985
CASH_ACCT_ID:
type: string
description: Cash Account ID is the account id of the cash account which will be credited or debited at settlement for the trade.
example: '156602418'
SEC_DESC:
type: string
description: Issue Description contains the name and other details of the instrument.
example: Apple Inc. Common Stock
ASSET_TYP:
type: string
description: 'Asset Type is a code representing the Asset Type of the security. Values include: EQTY (Equity), FI (Fixed Income), etc.'
example: EQTY
SEC_LEND_FLG:
type: string
description: Securities Lending Flag indicates that the trade is a securities lending transaction.
example: Y
QUANTITY:
type: number
format: double
description: Quantity provides the number of units, par value or nominal value (for fixed income instruments), amount of currency (for FX transactions), or number of shares. Indicates the contract quantity on the original transaction that was given up.
example: 10000
SEC_SHORT_IND:
type: string
description: Short Flag indicates if the transaction can be processed or if it cannot be processed due to a short position.
example: N
ISSUE_NME:
type: string
description: Issue Name is the Security Name of the security instrument.
example: Apple Inc.
ISSUE_TYP_CD:
type: string
description: 'Issue Type Code is a code linked to the Issue Type field which describes the type of security instrument. Values include: 1 (ADR Convertible), 12 (Bond), 19 (Bond Convertible), etc. '
example: '12'
ISSUE_TYP:
type: string
description: 'Issue Type is a description of the type of the security instrument. Values include: ADR Convertible (1), Bond (12) , Bond Convertible (19), etc. '
example: Bond
SETT_QTY:
type: number
format: double
description: Settled Quantity is the quantity that has settled or the quantity of the security that is fully settled at the 'As Of' date. For partial settlements the settled quantity is the portion that has settled.
example: 7500
HOLDING_TYPE_CD:
type: string
description: Location of Where Held is a code indicating the location of a holding. Examples include HD - Held At Depot and LE - Securities Lent.
example: HD
CUSIP:
type: string
description: CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.
example: 037833100
ISIN:
type: string
description: ISIN (International Securities Identification Number) is a 12-character alpha-numerical code that does not contain information characterizing financial instruments but serves for uniform identification of a security at trading and settlement.
example: US0378331005
SEDOL:
type: string
description: SEDOL (Stock Exchange Daily Official List) is a unique identification code, consisting of seven alphanumeric characters, that is assigned to all securities trading on the London Stock Exchange.
example: '2046251'
TICKER:
type: string
description: Ticker is the symbol used on the exchange to identify the security.
example: AAPL
UPDATE_TMS:
type: string
format: date-time
description: Created Timestamp is the date and time of when an item was loaded to the source system.
example: '2024-06-15T12:30:45Z'
SWIFT_STATUS:
type: string
description: SWIFT Status is the combined SWIFT 25D and 24B status codes as would be shown in an MT537 message.
example: MATCH
TRANS_TYP:
type: string
description: Transaction Type indicates the direction of the trade. Values are Receive Free, Receive Versus Payment, Deliver Free, Delivery Versus Payment, etc.
example: Receive Versus Payment
TRANS_REF_NBR:
type: string
description: Custodian Reference is the unique reference assigned by the Custodian to the record. The reference number is unique within a branch.
example: TRX20240615001
REAG_DEAG_CD:
type: string
description: Settlement Counterparty Code is the code associated to the Settlement Counterparty.
example: CP001
REAG_DEAG:
type: string
description: Settlement Counterparty is the name associated to the underlying instruction's REAG/DEAG tag if provided.
example: JP Morgan Chase
TRADE_DT:
type: string
format: date-time
description: Trade Date is the date a transaction is effected or executed.
example: '2024-06-12T14:30:00Z'
TRN_CD:
type: string
description: 'Transaction Type reflects the code of the transaction type. Sample Values returned: SLS (Securities Lending System); CONV; ISWAP.'
example: SLS
TRANS_CLASS_CD:
type: string
description: Transaction Class is the transaction type code for securities transactions.
example: BUY
TRANS_CLASS:
type: string
description: 'Transaction Class is the transaction type code for securities transactions. Values include: ADJ (Adjustment), BIDS, BOE, BUY, CAPD, CAPG, CAPGL, DF (Deliver Free), DIV (Dividend), DRAW, DRIP, DVCA, etc.'
example: MARKET TRADES
SIGNED_QTY:
type: number
format: double
description: The signed quantity based on the type of a transaction. The value would be positive in case of a receive, and it would be negative in case of a deliver.
example: 10000
PLACE_OF_SETLMT_CD:
type: string
description: Place Of Settlement code is the code associated with the Place of Settlement or Depository Centre Code for the security.
example: DTC
VALUE_DT:
type: string
format: date
description: Value Date is the date on which the cash posting corresponding to this trade will have value.
example: '2024-06-17'
TRD_STATUS:
type: string
description: Transaction Status.
example: SETTLED
PARTIAL_SETTLEMENT_FLAG:
type: string
description: Partial Settlement Flag indicates if the trades data contains partial settlements details.
example: Y
TRADE_STATUS_VALUES:
type: string
description: It provides the logical value of the trade status.
example: Settled
LAST_CHANGE_TIMESTAMP:
type: string
format: date-time
description: Last Change Timestamp.
example: '2024-06-15T15:20:10Z'
MARKET_REF:
type: string
description: Market Reference.
example: MKT123456789
MITI_REF:
type: string
description: Market Infrastructure Transaction Identification Reference number.
example: MITI987654321
MATCHING_REF:
type: string
description: Matching reference.
example: MATCH123456
CRTD_TMS:
type: string
format: date-time
description: Created Timestamp (CR) is the date and time of when an item was loaded to the Reporting database. Applicable to intraday information only.
example: '2024-06-15T09:00:00Z'
TRAN_NOTES:
type: string
description: The transaction notes.
example: Partial settlement due to insufficient position.
DTC_FED_IDENTIFIER:
type: string
description: It describes indicator values of trades settled in DTC (Depository Trust Company) or FED (Federal) location from market via SMI (Securities Market Interface).
example: DTC
SETD_CMB_QTY:
type: number
format: double
description: Settled Quantity.
example: 7500
CONSID_AMT_P:
type: number
format: double
description: Settled Amount is the amount that has settled, corresponding to the Settled Quantity. Settled Amount will be less than Instructed Amount in partial settlements.
example: 250000.75
27d18376-6358-40f1-9f63-23a72d40196f-json-response-schema:
type: object
properties:
Count:
type: number
format: integer
PagedList:
type: array
items:
$ref: '#/components/schemas/27d18376-6358-40f1-9f63-23a72d40196f-data-schema'
27d18376-6358-40f1-9f63-23a72d40196f-data-schema:
type: object
properties:
ACCT_BASE_NBR:
type: string
description: Account Base Number is an internal Citi client identifier that is associated to a Safekeeping or Cash Account.
example: 8-DEMOCSH53JPY
ACCT_ID:
type: string
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
example: DEMOSK02US
ACCT_NME:
type: string
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
example: Demo - SK - US DCC Equity
ACT_SETT_DT:
type: string
format: date
description: Actual Settlement Date is the date of final settlement of the trade.
example: '2025-08-26'
BR_ID:
type: string
description: Branch Code is the identifier of the branch for the account. For the Cash Account the branch code is a numeric value and for the Safekeeping Account it is the ISO Country code.
example: '484'
BR_NME:
type: string
description: Branch Name is the name of the branch for the Cash Account and/or Safekeeping Account.
example: NEW YORK SECURITIES CB
RELATED_REF:
type: string
description: Related Reference is the value provided via RELA tag on the underlying instruction.
example: RELA123456
CLIENT_REF:
type: string
description: Client Reference is a unique number assigned by the client, to the transaction, for identification purposes within their organization.
example: '123456'
BUYR_SELL_CD:
type: string
description: Buyer/Seller Code is the code associated to the Buyer/Seller.
example: '0050'
BUYR_SELL:
type: string
description: Buyer/Seller is the name associated to the underlying instruction's BUYR/SELL tag if provided.
example: TEST & CO INC
CONTR_SETT_DT:
type: string
format: date-time
description: Contractual Settlement Date is the date when the clients cash account should be credited with funds on a sale (and debited on a purchase) on the due settlement date in place of when a trade actually settles in the market.
example: '2025-06-17T00:00:00Z'
CNTRY_CD:
type: string
description: The Country Code (location) of the security custodian. Not applicable to the US domestic positions.
example: US
COMP_DESC:
type: string
description: Company Description contains information regarding the company which issued the security.
example: Microsoft Corporation
CONTR_SETT_FLG:
type: string
description: Contractual Settlement Flag indicates whether the trade will settle on the Contractual Settlement Date whether or not it actually settles. Values are Y (settle on contractual settlement date) or N (settle on actual settlement date).
example: Y
CURR_FCTR_RATE:
type: number
format: double
description: Current Factor is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
example: 0.975432
DEAL_REF_NBR:
type: string
description: OTM Reference is the Order and Trade Manager Reference number that has been assigned to the order instructions.
example: OTM987654321
HOLDING_TYPE:
type: string
description: How Position is Held is a description of the status of the holding affected by the trade, or where that holding is held.
example: Held At Depot
SEC_CCY:
type: string
description: Denomination Currency Code is the ISO 4217 currency code in which the security is denominated, in the local market.
example: USD
UPDATE_TMS:
type: string
format: date-time
description: Created Timestamp is the date and time of when an item was loaded to the source system.
example: '2025-06-15T00:00:00Z'
FAIL_AGE:
type: integer
format: int32
description: Fail Age is the number of days the transaction has not settled, past the contractual settlement date.
example: 5
FAIL_DESC:
type: string
description: Fail Description provides the reason why the trade has not or is not expected to settle on the contractual settlement date.
example: Counterparty securities unavailable
FCTR_DTE:
type: string
format: date-time
description: Factor Date is the date the current factor is applicable from for principal paying securities.
example: '2025-05-01T00:00:00Z'
INST_DT:
type: string
format: date
description: Instruction Date is the date the trade was first received.
example: '2025-06-13'
ISS_TMS:
type: string
format: date-time
description: Issue Date is the date of first issue of the security.
example: '2020-01-15T00:00:00Z'
ISSR_LOC_CD:
type: string
description: 'Issuer Location Code is the ISO country code where the issuer of the security is based. Values include: AR (Argentina), CA (Canada), IE (Ireland), etc.'
example: US
ISSR_LOC_NME:
type: string
description: 'Issuer Location is the name of the country where the issuer of the security is based. Values include: Argentina (AR), Canada (CA), Ireland (IE), etc.'
example: United States
SETT_AMT:
type: number
format: double
description: Settlement Amount is the cash value of the partial settlement in the local currency.
example: 1250000.75
SETT_CCY_CD:
type: string
description: Settlement Currency Code is the ISO 4217 currency code for the Settlement Amount.
example: USD
SETT_CCY:
type: string
description: Settlement Currency is the currency name for the Settlement Amount.
example: US Dollar
LOAN_DT:
type: string
format: date
description: Loan Date is the date the loan originated.
example: '2025-04-01'
LOAN_PURPOSE_CD:
type: string
description: Loan Purpose Code is a code that identifies the purpose of the loan transaction if the position is on loan.
example: COLL
LOAN_PURPOSE_DESC:
type: string
description: Loan Purpose is the description of the purpose of the loan transaction if the position is on loan.
example: Collateral Management
LOAN_REF_ID:
type: string
description: The Loan Reference Number is the number assigned to 3rd party lending transactions. This is for US domestic
example: '100123456'
MATY_DT:
type: string
format: date-time
description: Maturity Date is the date of maturity or redemption for fixed income securities.
example: '2030-12-31T00:00:00Z'
PART_UNSETL_QTY:
type: number
format: double
description: Unsettled Quantity shows the quantity that is still yet to settle when there is a partial settlement of the trade.
example: 2500
PARTICIPANT_NO:
type: string
description: DTC Number is the participant or sub-account number at DTCC.
example: 0901
SEC_ID_TYPE:
type: string
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID field. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
example: ISIN
SEC_ID:
type: string
description: Security ID is the most commonly used identifier for the security in a given market.
example: US5949181045
PLACE_OF_SETLMT:
type: string
description: Place Of Settlement is the name of the settlement location for the security, applicable to securities positions, transactions only.
example: TOKYO, JAPAN
PLDG_ABA_NAM:
type: string
description: American Bankers Association Description is the name of the institution identified by the ABA number.
example: CITI Bank
PLDG_ABA_NO:
type: string
description: ABA Number is the American Bankers Association Transit Number - used to identify a US institution.
example: '021000021'
PLDG_REF_NBR:
type: string
description: Pledge Reference is the unique reference number for the pledge transaction.
example: PLDG123456
PREV_FCTR_RATE:
type: number
format: double
description: Previous Factor is the factor which applies to the last accrual period to determine payments and balances for principal paying securities.
example: 0.97891
CASH_ACCT_ID:
type: string
description: Cash Account ID is the account id of the cash account which will be credited or debited at settlement for the trade.
example: '156602418'
SEC_DESC:
type: string
description: Issue Description contains the name and other details of the instrument.
example: TEMPORARY SECURITY 003263100
ASSET_TYP:
type: string
description: 'Asset Type is a code representing the Asset Type of the security. Values include: EQTY (Equity), FI (Fixed Income), etc.'
example: EQTY
SEC_LEND_FLG:
type: string
description: Securities Lending Flag indicates that the trade is a securities lending transaction.
example: Y
QUANTITY:
type: number
format: double
description: Quantity provides the number of units, par value or nominal value (for fixed income instruments), amount of currency (for FX transactions), or number of shares. Indicates the contract quantity on the original transaction that was given up.
example: 10000
SEC_SHORT_IND:
type: string
description: Short Flag indicates if the transaction can be processed or if it cannot be processed due to a short position.
example: N
ISSUE_NME:
type: string
description: Issue Name is the Security Name of the security instrument.
example: Microsoft Corporation
ISSUE_TYP_CD:
type: string
description: 'Issue Type Code is a code linked to the Issue Type field which describes the type of security instrument. Values include: 1 (ADR Convertible), 12 (Bond), 19 (Bond Convertible), etc.'
example: '12'
ISSUE_TYP:
type: string
description: 'Issue Type is a description of the type of the security instrument. Values include: ADR Convertible (1), Bond (12), Bond Convertible (19), etc.'
example: Bond
SETT_QTY:
type: number
format: double
description: Settled Quantity is the quantity that has settled or the quantity of the security that is fully settled at the As Of date. For partial settlements the settled quantity is the portion that has settled.
example: 7500
HOLDING_TYPE_CD:
type: string
description: Location of Where Held is a code indicating the location of a holding. Examples include HD - Held At Depot and LE - Securities Lent.
example: HD
CUSIP:
type: string
description: CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.
example: '594918104'
ISIN:
type: string
description: ISIN (International Securities Identification Number) is a 12-character alpha-numerical code that does not contain information characterizing financial instruments but serves for uniform identification of a security at trading and settlement.
example: US5949181045
SEDOL:
type: string
description: SEDOL (Stock Exchange Daily Official List) is a unique identification code, consisting of seven alphanumeric characters, that is assigned to all securities trading on the London Stock Exchange.
example: '2588173'
TICKER:
type: string
description: Ticker is the symbol used on the exchange to identify the security.
example: MSFT
SWIFT_STATUS:
type: string
description: SWIFT Status is the combined SWIFT 25D and 24B status codes as would be shown in an MT537 message.
example: PEND-LACK
TRANS_TYP:
type: string
description: Transaction Type indicates the direction of the trade. Values are Receive Free, Receive Versus Payment, Deliver Free, Delivery Versus Payment, etc.
example: Receive Versus Payment
TRANS_REF_NBR:
type: string
description: Custodian Reference is the unique reference assigned by the Custodian to the record. The reference number is unique within a branch.
example: CUST987654321
REAG_DEAG_CD:
type: string
description: Settlement Counterparty Code is the code associated to the Settlement Counterparty.
example: CP001
REAG_DEAG:
type: string
description: Settlement Counterparty is the name associated to the underlying instruction's REAG/DEAG tag if provided.
example: Goldman Sachs
TRADE_DT:
type: string
format: date-time
description: Trade Date is the date a transaction is effected or executed.
example: '2025-06-13T10:15:00Z'
TRANS_TYP_CD:
type: string
description: Transaction Type Code is the code associated to the Transaction Type.
example: RVP
TRN_CL_CD:
type: string
description: 'Transaction Class is the transaction type code for securities transactions. Values include: ADJ (Adjustment), BIDS, BOE, BUY, CAPD, CAPG, CAPGL, DF (Deliver Free), DIV (Dividend), DRAW, DRIP, DVCA, etc.'
example: BUY
TRANS_CLASS:
type: string
description: Transaction Classification describes the category of trade. Values include MARKET TRADES, SECURITIES LENDING TRANSACTIONS, etc.
example: MARKET TRADES
SIGNED_QTY:
type: number
format: double
description: The signed quantity based on the type of a transaction. The value would be positive in case of a receive, and it would be negative in case of a deliver.
example: 10000
PLACE_OF_SETLMT_CD:
type: string
description: Place Of Settlement code is the code associated with the Place of Settlement or Depository Centre Code for the security.
example: DTC
VALUE_DT:
type: string
format: date
description: Value Date is the date on which the cash posting corresponding to this trade will have value.
example: '2025-06-17'
TRD_STATUS:
type: string
description: Transaction Status
example: SETTLED
FAIL_TEXT:
type: string
description: Fail Text provides additional information to the Fail/Market Status for failing trades.
example: Awaiting counterparty confirmation
PARTIAL_SETTLEMENT_FLAG:
type: string
description: Partial Settlement Flag indicates if the trades data contains partial settlements details.
example: Y
TRADE_STATUS_VALUES:
type: string
description: It provides the logical value of the trade status.
example: Matched and Settled
COB_DATE:
type: string
format: date
description: Close of Business Date
example: '2025-06-15'
MITI_REF:
type: string
description: Market Infrastructure Transaction Identification Reference number
example: MITI987654321
MATCHING_REF:
type: string
description: The Market Infrastructure reference under which transaction has matched
example: MATCH123456
MARKET_REF:
type: string
description: Market Infrastructure reference
example: MKT654321
CRTD_TMS:
type: string
format: date-time
description: Created Timestamp (CR) is the date and time of when an item was loaded to the Reporting database. Applicable to intraday information only.
example: '2025-06-15T14:45:00Z'
TRAN_NOTES:
type: string
description: The transaction notes
example: Settlement completed without exception
DEPOT_ID:
type: string
description: Depot code represents an account of Citi in local markets used for settlement. It can be either 3rd party agent, local Citi branch or CSD (Central Securities Depository).
example: DEP001
DTC_FED_IDENTIFIER:
type: string
description: It describes indicator values of trades settled in DTC (Depository Trust Company) or FED (Federal) location from market via SMI (Securities Market Interface).
example: DTC
c5da44dd-2c3c-42cc-8125-711c2aadbe4f-json-response-schema:
type: object
properties:
Count:
type: number
format: integer
PagedList:
type: array
items:
$ref: '#/components/schemas/c5da44dd-2c3c-42cc-8125-711c2aadbe4f-data-schema'
c5da44dd-2c3c-42cc-8125-711c2aadbe4f-xml-response-schema:
type: object
properties:
row:
type: array
items:
$ref: '#/components/schemas/c5da44dd-2c3c-42cc-8125-711c2aadbe4f-data-schema'
xml:
name: data
ba848120-2d1f-4ec0-9f5c-2aa51b5d1634-data-schema:
type: object
properties:
SK_ACCT_ID:
type: string
description: The Safekeeping Account ID is an identifier for a Safekeeping Account that is unique within a branch.
example: '0000123456'
COUNTRY:
type: string
description: Country is the reclaim market
example: GERMANY
CODE_RCLM_CURR:
type: string
description: Reclaim Currency is the currency of the reclaim (currency in which the claim is made)
example: EUR
RECLAIM_REF:
type: string
description: Reclaim Reference is the unique identifying number for each reclaim in Citi system
example: 600SE123456
BO_BATCH_NO:
type: string
description: Batch Number is Citi's unique reference for the reclaims submitted to the Tax authorities (submission may contains more than 1 reclaim
example: B910BE123456
BEN_OWNER_NAME:
type: string
description: Beneficial Owner Name is the name of the Beneficiary Owner of the reclaim
example: ABC Investments Ltd.
DEPOT_CODE:
type: string
description: Depot Code is the internal Citi identifier for the local sub account the securities are held on
example: NAY
DATE_SENT_TO_FTA:
type: string
format: date
description: Date sent to FTA is the date when the reclaim was submitted to the foreign tax authority
example: '2020-05-14'
DATE_SENT_TO_LTA:
type: string
format: date
description: Date sent to LTA is the date when the reclaim was submitted to the local tax authority
example: '2020-05-14'
GERMAN_FILE_NUMBER:
type: string
description: E-Filing Serial (Reclaim) is the reference no. for electronically filed reclaim submission
example: '1234567891'
EFILE_REF:
type: string
description: E-File Reference is Citi's unique reference for each electronic submission to Tax authorities (submission may contains more than 1 reclaim)
example: F500DE000345
ENTITLEMENT_REF:
type: string
description: Entitlement Reference is the unique reference number generated from Citi internal systems for each line of taxable income
example: '00365104513'
CODE_RATE_CURR:
type: string
description: Rate Currency is the currency of the dividend.
example: '54251700451'
DIVIDEND_RATE:
type: number
format: double
description: The Dividend Rate is the total expected dividend payments for an investment on an annualized basis.
example: 1.953100028
FX_RATE_EUR:
type: number
format: double
description: FX Rate (EUR) is the FX rate used to convert the reclaim currency into EUR.
example: 0.09401
GROSS_DIV_EUR:
type: number
format: double
description: Gross Dividend (EUR) is the value of the Gross Dividend expressed in Euro currency.
example: 1500.75
TAX_PAID_EUR:
type: number
format: double
description: Local Tax (WHT Paid) (EUR) is the value of tax withheld expressed in Euro currency.
example: 300.5
NET_DIV_EUR:
type: number
format: double
description: Net Dividend (EUR) is the value of is the dividend net of withholding tax expressed in Euro currency.
example: 1200.25
RECLM_VAL_EUR:
type: number
format: double
description: Reclaim Amount (EUR) is the value of the amount being reclaimed expressed in Euro currency.
example: 250
AMT_RECVED_EUR:
type: number
format: double
description: Reclaim Amount Received (EUR) is the value of the refund received from the Tax Authority expressed in Euro currency
example: 240
FX_RATE_GBP:
type: number
format: double
description: FX Rate (GBP) is the FX rate used to convert the reclaim currency into GBP
example: 0.8126
GROSS_DIV_GBP:
type: number
format: double
description: Gross Dividend (GBP) is the value of the Gross Dividend expressed in British pound currency
example: 1300.4
TAX_PAID_GBP:
type: number
format: double
description: Local Tax (WHT Paid) (GBP) is the value of tax withheld expressed in British pound currency
example: 260.35
NET_DIV_GBP:
type: number
format: double
description: Net Dividend (GBP) is the value of is the dividend net of withholding tax expressed in British pound currency
example: 1040.05
RECLM_VAL_GBP:
type: number
format: double
description: Reclaim Amount (GBP) is the value of the amount being reclaimed expressed in British pound currency
example: 215
AMT_RECVED_GBP:
type: number
format: double
description: Reclaim Amount Received (GBP) is the value of the refund received from the Tax Authority expressed in British pound currency
example: 210
EQUIVAL_RATE_CCY:
type: number
format: double
description: Equivalent Rate is the dividend rate per share expressed in the currency of the reclaim.
example: 1.15672
GROSS_DIV_CCY:
type: number
format: double
description: Gross Dividend is the value of the Gross Dividend expressed in the currency of the reclaim.
example: 2000
TAX_PAID_CCY:
type: number
format: double
description: Local Tax (WHT Paid) is the value of tax withheld expressed in the currency of the reclaim.
example: 400
NET_DIV_CCY:
type: number
format: double
description: Net Dividend is the value of is the dividend net of withholding tax expressed in the currency of the reclaim.
example: 1600
RECLM_VAL_RCY:
type: number
format: double
description: Reclaim Amount is the value of the amount being reclaimed expressed in the currency of the reclaim.
example: 320
AMT_RECVED_CCY:
type: number
format: double
description: Reclaim Amount Received is the value of the refund received from the Tax Authority excluding interest, expressed in the currency of the reclaim.
example: 310
FX_RATE_USD:
type: number
format: double
description: FX Rate (USD) is the FX rate used to convert the reclaim currency into USD.
example: 1.08
GROSS_DIV_USD:
type: number
format: double
description: Gross Dividend (USD) is the value of the Gross Dividend expressed in US dollar currency.
example: 1650
TAX_PAID_USD:
type: number
format: double
description: Local Tax (WHT Paid) (USD) is the value of tax withheld expressed in US dollar currency
example: 330
NET_DIV_USD:
type: number
format: double
description: Net Dividend (USD) is the value of is the dividend net of withholding tax expressed in US dollar currency.
example: 1320
RECLM_VAL_USD:
type: number
format: double
description: Reclaim Amount (USD) is the value of the amount being reclaimed expressed in US dollar currency.
example: 275
AMT_RECVED_USD:
type: number
format: double
description: Reclaim Amount Received (USD) is the value of the refund received from the Tax Authority expressed in US dollar currency.
example: 270
STATUS:
type: string
description: Reclaim Status is the current status of the reclaim.
example: Suspended
STATUS_CHANGE_DATE:
type: string
format: date
description: Status Date is the date on which the status was last changed.
example: '2023-06-05'
ISSUER_TAX_ID:
type: string
description: Security Code is the SEDOL code (Stock Exchange Daily Official List identifier) of the security
example: BW4NR74
ISIN:
type: string
description: Alternate Security Code (ISIN) is the International Securities Identification Number.
example: US0378331005
SEC_SHRTN:
type: string
description: Security Name is the stock name of the security.
example: BYSTRONIC
LOCAL_TAX_ID:
type: string
description: Tax ID is the Beneficial Owner local Tax ID.
example: A92145408
WITH_RATE:
type: number
format: double
description: WHT Rate is the rate of withholding tax applied to the income payment.
example: 15.286
CREATION_DATE:
type: string
format: date
description: Input Date is the date when the reclaim was loaded to Citi's reclaim system.
example: '2024-01-20'
ALLOCATED_HOLDING:
type: number
format: double
description: Holding Value is the number of reclaimable shares per reclaim.
example: 500
BO_DOMICILE:
type: string
description: BO Domicile (Fiscal Domicile) is the Domicile of beneficial owner
example: HUNGARY
ENTITY_TYPE:
type: string
description: 'Entity Type (Fiscal Type) is the Beneficial Owner entity type (i.e.: corporate, Pension Fund, etc.).'
example: Individual
PAY_DATE:
type: string
format: date
description: Pay Date is the pay date of the dividend payment.
example: '2024-03-31'
PAYYEAR:
type: number
format: double
description: Pay Year is the pay year of the dividend.
example: 2024
PAYQUARTER:
type: string
description: Pay Quarter is the pay quarter of the dividend.
example: '1'
EX_DATE:
type: string
format: date
description: Ex Date is the trading cut off date after which position changes will no longer alter the eligibility to the corporate action.
example: '2025-02-14'
RECLAIM_RATE:
type: number
format: double
description: Reclaim Rate is the percentage that the Ben Owner is entitled to reclaim back from the Foreign Tax Authorities (i.e. WHT Rate % less treaty rate).
example: 10.012
STATUTE_DTE:
type: string
format: date
description: Statute Date is the last day the reclaim is in statute.
example: '2025-12-31'
EVENT_REFERENCE:
type: string
description: Event Reference is the Corporate Action event ID (CAID).
example: '9304700792'
CLIENT_REF:
type: string
description: Client Reference is a unique number assigned by the client, to the transaction, for identification purposes within their organization..
example: '348888'
INCOME_ACCOUNT:
type: string
description: Cash Account is the cash account number the income was paid to.
example: 00000014168569
FUND_NAME:
type: string
description: Portfolio Name is the name of the safekeeping account.
example: FUND 501
RECONCILIATION_DATE:
type: string
format: date
description: Receipt Date is the date when the funds were credited into client's cash account.
example: '2024-05-10'
HOLDING:
type: number
format: double
description: Total Entitlement Holding Amount is the total number of shares at entitlement level.
example: 1000
INT_AMT_CCY:
type: number
format: double
description: Interest Amount Received is the amount of interest paid by the Foreign Tax Authority in addition to the tax reclaim value expressed in the currency of the reclaim
example: 45.75
INT_AMT_GBP:
type: number
format: double
description: Interest Amount (GBP) is the amount of interest paid by the Foreign Tax Authority in addition to the tax reclaim value expressed in British pound currency
example: 37.1
INT_AMT_EUR:
type: number
format: double
description: Interest Amount (EUR) is the amount of interest paid by the Foreign Tax Authority in addition to the tax reclaim value expressed in Euro currency
example: 42.5
INT_AMT_USD:
type: number
format: double
description: Interest Amount (USD) is the amount of interest paid by the Foreign Tax Authority in addition to the tax reclaim value expressed in US dollar currency
example: 48.2
OVERRIDE_CNTRY_ID_TRS:
type: number
format: double
description: Security Domicile (Stock Residency) is the country in which tax was withheld and where tax will be reclaimed
example: 1
MARKET:
type: string
description: Depot Domicile is the Depot domicile (Country where the sub-account is held).
example: AUSTRALIA
TOTAL_AMT_RECVED_CCY:
type: number
format: double
description: Reclaim Amount Received is the value of the refund received from the Tax Authority including interest, expressed in the currency of the reclaim.
example: 350
TOTAL_AMT_RECVED_EUR:
type: number
format: double
description: Reclaim Amount Received (EUR) is the value of the refund received from the Tax Authority including interest, expressed in Euro currency.
example: 325
TOTAL_AMT_RECVED_GBP:
type: number
format: double
description: Reclaim Amount Received (GBP) is the value of the refund received from the Tax Authority including interest, expressed in British pound currency.
example: 290
TOTAL_AMT_RECVED_USD:
type: number
format: double
description: Reclaim Amount Received (USD) is the value of the refund received from the Tax Authority including interest, expressed in US dollar currency.
example: 380
ACCT_BASE_NBR:
type: string
description: Account Base Number is an internal Citi client identifier that is associated to a Safekeeping or Cash Account.
example: '133611'
ACCT_BUS_TYP_CD:
type: string
description: 'Account Type Code indicates the type of the account. Values are: C (Cash Account), S (Safekeeping Account).'
example: C
ACCT_BUS_TYP_NME:
type: string
description: Account Type Description indicates the type of the account. Values are CASH (C), S/K (S).
example: CASH
ACCT_CLS_DT:
type: string
format: date
description: Account Close Date is the date when the account was closed. It will only have a value if the account is closed.
example: '2024-12-31'
ACCT_ID:
type: string
description: Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch.
example: DEMOSK02US
ACCT_NME:
type: string
description: Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name.
example: Demo - SK - US DCC Equity
ACCT_OPN_DT:
type: string
format: date
description: Account Open Date is the date when the account was opened.
example: '2020-01-15'
ACCT_STS_TYP:
type: string
description: 'Account Status provides the current status of the Cash Account and/or the Safekeeping Account. Values are: Open, Closed, Frozen'
example: Open
ALTV_CUR_CD:
type: string
description: Account Base Currency Code is the ISO Currency Code for the account.
example: JPY
BR_ID:
type: string
description: Branch Code is the identifier of the branch for the account. For the Cash Account the branch code is a numeric value and for the Safekeeping Account it is the ISO Country code.
example: SG
BR_NME:
type: string
description: Branch Name is the name of the branch for the Cash Account and/or Safekeeping Account.
example: CITIBANK JAPAN LTD
CASH_TYPE:
type: number
format: double
description: Cash Type Code pertains to US Direct Cash Accounts and indicates whether the Cash Account has a split income and principal balance.
example: 1
GFC_ID:
type: string
description: Client ID is an identifier that is available on a Cash Account and/or a Safekeeping Account. This Client ID is referred to, internally at Citi, as a GFCID.
example: '1000123456'
IBAN:
type:
- string
- 'null'
description: IBAN is the International Bank Account Number for the Cash Account.
example: 'null'
CMPNY_NME:
type: string
description: Company Name is the name of the company which issued the security.
example: ABC Capital Ltd.
SEC_DESC:
type: string
description: Issue Description contains the name and other details of the instrument.
example: SOPRA STERIA GROUP
SEC_SECURITY_CD:
type: string
description: CITI Internal Security Code is the identifier of the CITI Internal Security Identifier.
example: BVGH0K1
SEC_SHRT_NME:
type: string
description: Issue Name is the Security Name of the security instrument.
example: NESTLE
SID_BLOOMBERG:
type: string
description: Bloomberg ID is the value supplied by Bloomberg to identify the security.
example: BBG00K60SBR4
SID_CUSIP:
type: string
description: CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.
example: E00460233
SID_LOCAL:
type: string
description: Local ID is the Local security identifier of the associated security.
example: DNB
SID_TICKER_SYMB:
type: string
description: Ticker is the symbol used on the exchange to identify the security.
example: KINVB
ACRL_BASIS_CDE:
type: string
description: 'Accrual Basis Code is a code linked to the Accrual Basis field which indicates the basis on which interest accruals are calculated. Values include: 00043 (360 / 365), 00011 (360 / 360), 00063 (30 / 360 Non-EOM), etc.'
example: '00011'
ACRL_BASIS_NME:
type: string
description: Accrual Basis Description is the basis on which interest accrual is calculated, e.g. 30/360 meaning nominal 30 day months and a 360 day year.
example: Actual/360
CURR_FCTR_RATE:
type: number
format: double
description: Current Factor is the factor which applies to the current accrual period to determine payments and balances for principal paying securities.
example: 0.4515268
DLAY_DAYS:
type: string
description: Delay Days is the number of days from the issuance of an MBS pool (or from the beginning of the interest accrual period) until the first payment is remitted/paid to the holders.
example: '13'
DNOMD_CUR_CD:
type: string
description: Denomination Currency Code is the ISO currency code in which the security is denominated, in the local market.
example: USD
DTED_TMS:
type: string
format: date-time
description: Dated Date/Time is the date that the interest begins to accrue on a fixed-income security.
example: '2019-08-26 00:00:00'
FCTR_DTE:
type: string
format: date-time
description: Factor Date is the date the current factor is applicable from for principal paying securities.
example: '2023-12-10 00:00:00'
INCM_CUR_CD:
type: string
description: Income Currency Code is the ISO currency code in which income payments will be made for the security in the local market.
example: EUR
INCM_CUR_NME:
type: string
description: Income Currency Name is the name of the currency in which income payments will be made for the security in the local market.
example: Euro
INCM_PROJN_RATE:
type: number
format: double
description: Interest Rate is the coupon rate of the security.
example: 3.0946
ISS_CAT_NME:
type: string
description: 'Issue Category is the description for the Issue Category Code. Values include: Common Stock (CSTK), Derivatives (DERIV), Mortgage Backed Securities (MBS), etc.'
example: Derivatives
ISS_CATG_CD:
type: string
description: 'Issue Category Code is a specific category for the security. Values include: CSTK (Common Stock), DERIV (Derivatives), MBS (Mortgage Backed Securities), etc.'
example: DERIV
ISS_TMS:
type: string
format: date-time
description: Issue Date is the date of first issue of the security.
example: '2019-11-26 00:00:00'
ISSR_LOC_CD:
type: string
description: 'Issuer Location Code is the ISO country code where the issuer of the security is based. Values include: AR (Argentina), CA (Canada), IE (Ireland), etc.'
example: US
ISSR_LOC_NME:
type: string
description: 'Issuer Location is the name of the country where the issuer of the security is based. Values include: Argentina (AR), Canada (CA), Ireland (IE), etc.'
example: United States
MATY_DT:
type: string
format: date-time
description: Maturity Date is the date of maturity or redemption for fixed income securities.
example: '2041-10-10 00:00:00'
NXT_PAY_DT:
type: string
format: date
description: Next Payable Date is the next date on which a dividend or interest payment is scheduled to be paid.
example: '2026-07-15'
PFD_ID_CTXT_CD:
type: string
description: 'Security ID Type indicates the type of identifier of the corresponding Security ID field. Values include: CUSIP, ISIN, SEDOL, LOCAL, etc.'
example: ISIN
PFD_ISS_ID:
type: string
description: Security ID is the most commonly used identifier for the security in a given market.
example: BFXCMX4
PMT_FREQY_DESC:
type: string
description: 'Payment Frequency Description indicates how often interest is paid on the security. Values include: Annual (00001), Sem-Annual (00002), One Payment Per Year (00035), etc.'
example: Sem-Annual
POOL_ID_CD:
type: string
description: Pool ID is an alphanumeric code that identifies a particular mortgage backed security.
example: AB1234
PREV_FCTR_RATE:
type: number
format: double
description: Previous Factor is the factor which applies to the last accrual period to determine payments and balances for principal paying securities.
example: 0.9985
SEC_GROUP:
type: string
description: 'Asset Type is a code representing the Asset Type of the security. Values include: EQTY (Equity), FI (Fixed Income), etc.'
example: EQTY
SEC_SUB_TYP_CD:
type: string
description: 'Issue Type Code is a code linked to the Issue Type field which describes the type of security instrument. Values include: 1 (ADR Convertible), 12 (Bond), 19 (Bond Convertible), etc.'
example: '12'
SEC_SUB_TYP_NME:
type: string
description: 'Issue Type is a description of the type of the security instrument. Values include: ADR Convertible (1), Bond (12) , Bond Convertible (19), etc.'
example: Bond
STRK_PRC_AMT:
type: number
format: double
description: Strike Price is the specified price on an options contract at which the contract may be exercised.
example: 150.09
US_SIC_CD:
type: string
description: SIC is the Standard Industrial Classification four-digit numeric code.
example: '7372'
PAYABLE_DATE:
type: string
format: date
description: Payable Date is the date on which a dividend or interest payment is scheduled to be paid.
example: '2026-08-28'
ba848120-2d1f-4ec0-9f5c-2aa51b5d1634-json-response-schema:
type: object
properties:
Count:
type: number
format: integer
PagedList:
type: array
items:
$ref: '#/components/schemas/ba848120-2d1f-4ec0-9f5c-2aa51b5d1634-data-schema'
ba848120-2d1f-4ec0-9f5c-2aa51b5d1634-xml-response-schema:
type: object
properties:
row:
type: array
items:
$ref: '#/components/schemas/ba848120-2d1f-4ec0-9f5c-2aa51b5d1634-data-schema'
xml:
name: data
f631ab51-6333-4183-9ef7-144f5fadc9b5-data-schema:
type: object
properties:
SK_ACCT_ID:
type: string
description: The Safekeeping Account ID is an identifier for a Safekeeping Account that is unique within a branch.
example: '0000123456'
COUNTRY:
type: string
description: Country is the reclaim market.
example: GERMANY
CODE_RCLM_CURR:
type: string
description: Reclaim Currency is the currency of the reclaim (currency in which the claim is made).
example: EUR
RECLAIM_REF:
type: string
description: Reclaim Reference is the unique identifying number for each reclaim in Citi system.
example: 600SE123456
BO_BATCH_NO:
type: string
description: Batch Number is Citi's unique reference for the reclaims submitted to the Tax authorities (submission may contain more than one reclaim).
example: B910BE123456
BEN_OWNER_NAME:
type: string
description: Beneficial Owner Name is the name of the Beneficiary Owner of the reclaim.
example: ABC Investments Ltd.
DEPOT_CODE:
type: string
description: Depot Code is the internal Citi identifier for the local sub-account the securities are held on.
example: NAY
DATE_SENT_TO_FTA:
type: string
format: date
description: Date sent to FTA is the date when the reclaim was submitted to the foreign tax authority.
example: '2020-05-14'
DATE_SENT_TO_LTA:
type: string
format: date
description: Date sent to LTA is the date when the reclaim was submitted to the local tax authority.
example: '2020-05-14'
GERMAN_FILE_NUMBER:
type: string
description: E-Filing Serial (Reclaim) is the reference no. for electronically filed reclaim submission.
example: '1234567891'
EFILE_REF:
type: string
description: E-File Reference is Citi's unique reference for each electronic submission to Tax authorities (submission may contain more than 1 reclaim).
example: F500DE000345
ENTITLEMENT_REF:
type: string
description: Entitlement Reference is the unique reference number generated from Citi internal systems for each line of taxable income.
example: '00365104513'
CODE_RATE_CURR:
type: string
description: Rate Currency is the currency of the dividend.
example: '54251700451'
DIVIDEND_RATE:
type: number
format: double
description: The Dividend Rate is the total expected dividend payments for an investment on an annualized basis.
example: 1.953100028
FX_RATE_EUR:
type: number
format: double
description: FX Rate (EUR) is the FX rate used to convert the reclaim currency into EUR.
example: 0.09401
GROSS_DIV_EUR:
type: number
format: double
description: Gross Dividend (EUR) is the value of the Gross Dividend expressed in Euro currency.
example: 1500.75
TAX_PAID_EUR:
type: number
format: double
description: Local Tax (WHT Paid) (EUR) is the value of tax withheld expressed in Euro currency.
example: 300.5
NET_DIV_EUR:
type: number
format: double
description: Net Dividend (EUR) is the dividend net of withholding tax expressed in Euro currency.
example: 1200.25
RECLM_VAL_EUR:
type: number
format: double
description: Reclaim Amount (EUR) is the amount being reclaimed expressed in Euro currency.
example: 250
AMT_RECVED_EUR:
type: number
format: double
description: Reclaim Amount Received (EUR) is the refund received from the Tax Authority expressed in Euro currency.
example: 240
FX_RATE_GBP:
type: number
format: double
description: FX Rate (GBP) is the FX rate used to convert the reclaim currency into GBP.
example: 0.8126
GROSS_DIV_GBP:
type: number
format: double
description: Gross Dividend (GBP) is the value of the Gross Dividend expressed in British pound currency.
example: 1300.4
TAX_PAID_GBP:
type: number
format: double
description: Local Tax (WHT Paid) (GBP) is the value of tax withheld expressed in British pound currency.
example: 260.35
NET_DIV_GBP:
type: number
format: double
description: Net Dividend (GBP) is the dividend net of withholding tax expressed in British pound currency.
example: 1040.05
RECLM_VAL_GBP:
type: number
format: double
description: Reclaim Amount (GBP) is the amount being reclaimed expressed in British pound currency.
example: 215
AMT_RECVED_GBP:
type: number
format: double
description: Reclaim Amount Received (GBP) is the refund received from the Tax Authority expressed in British pound currency.
example: 210
EQUIVAL_RATE_CCY:
type: number
format: double
description: Equivalent Rate is the dividend rate per share expressed in the currency of the reclaim.
example: 1.15672
GROSS_DIV_CCY:
type: number
format: double
description: Gross Dividend expressed in the currency of the reclaim.
example: 2000
TAX_PAID_CCY:
type: number
format: double
description: Local Tax (WHT Paid) expressed in the currency of the reclaim.
example: 400
NET_DIV_CCY:
type: number
format: double
description: Net Dividend expressed in the currency of the reclaim.
example: 1600
RECLM_VAL_RCY:
type: number
format: double
description: Reclaim Amount expressed in the currency of the reclaim.
example: 320
AMT_RECVED_CCY:
type: number
format: double
description: Reclaim Amount Received (excluding interest), expressed in the currency of the reclaim.
example: 310
FX_RATE_USD:
type: number
format: double
description: FX Rate (USD) is the FX rate used to convert the reclaim currency into USD.
example: 1.08
GROSS_DIV_USD:
type: number
format: double
description: Gross Dividend (USD) is the value of the Gross Dividend expressed in US dollar currency.
example: 1650
TAX_PAID_USD:
type: number
format: double
description: Local Tax (WHT Paid) expressed in US dollar currency.
example: 330
NET_DIV_USD:
type: number
format: double
description: Net Dividend (USD) is the dividend net of withholding tax expressed in US dollar currency.
example: 1320
RECLM_VAL_USD:
type: number
format: double
description: Reclaim Amount (USD) is the value of the amount being reclaimed expressed in US dollar currency.
example: 275
AMT_RECVED_USD:
type: number
format: double
description: Reclaim Amount Received (USD) is the refund received from the Tax Authority expressed in US dollar currency.
example: 270
STATUS:
type: string
description: Reclaim Status is the current status of the reclaim.
example: Suspended
STATUS_CHANGE_DATE:
type: string
format: date
description: Status Date is the date on which the status was last changed.
example: '2023-06-05'
ISSUER_TAX_ID:
type: string
description: Security Code (SEDOL) of the security.
example: BW4NR74
ISIN:
type: string
description: International Securities Identification Number.
example: US0378331005
SEC_SHRTN:
type: string
description: Security Name is the stock name of the security.
example: BYSTRONIC
LOCAL_TAX_ID:
type: string
description: Tax ID is the Beneficial Owner local Tax ID.
example: A92145408
WITH_RATE:
type: number
format: double
description: WHT Rate is the rate of withholding tax applied to the income payment.
example: 15.286
CREATION_DATE:
type: string
format: date
description: Input Date is the date when the reclaim was loaded to Citi's reclaim system.
example: '2024-01-20'
ALLOCATED_HOLDING:
type: number
format: double
description: Holding Value is the number of reclaimable shares per reclaim.
example: 500
BO_DOMICILE:
type: string
description: BO Domicile (Fiscal Domicile) is the domicile of the beneficial owner.
example: HUNGARY
ENTITY_TYPE:
type: string
description: Entity Type (Fiscal Type) is the Beneficial Owner entity type (e.g., corporate, Pension Fund, etc.).
example: Individual
PAY_DATE:
type: string
format: date
description: Pay Date is the pay date of the dividend payment.
example: '2024-03-31'
PAYYEAR:
type: number
format: double
description: Pay Year is the pay year of the dividend.
example: 2024
PAYQUARTER:
type: string
description: Pay Quarter is the pay quarter of the dividend.
example: '1'
EX_DATE:
type: string
format: date
description: Ex Date is the trading cut‑off date after which position changes will no longer alter eligibility for the corporate action.
example: '2025-02-14'
RECLAIM_RATE:
type: number
format: double
description: Reclaim Rate is the percentage the Beneficial Owner is entitled to reclaim from the Foreign Tax Authorities.
example: 10.012
STATUTE_DTE:
type: string
format: date
description: Statute Date is the last day the reclaim is in statute.
example: '2025-12-31'
EVENT_REFERENCE:
type: string
description: Event Reference is the Corporate Action event ID (CAID).
example: '9304700792'
CLIENT_REF:
type: string
description: Client Reference is a unique number assigned by the client for identifying the transaction internally.
example: '348888'
INCOME_ACCOUNT:
type: string
description: Cash Account is the cash account number the income was paid to.
example: 00000014168569
FUND_NAME:
type: string
description: Portfolio Name is the name of the safekeeping account.
example: FUND 501
RECONCILIATION_DATE:
type: string
format: date
description: Receipt Date is the date when the funds were credited into the client's cash account.
example: '2024-05-10'
HOLDING:
type: number
format: double
description: Total Entitlement Holding Amount is the total number of shares at entitlement level.
example: 1000
INT_AMT_CCY:
type: number
format: double
description: Interest Amount Received expressed in the currency of the reclaim.
example: 45.75
INT_AMT_GBP:
type: number
format: double
description: Interest Amount (GBP) expressed in British pound currency.
example: 37.1
INT_AMT_EUR:
type: number
format: double
description: Interest Amount (EUR) expressed in Euro currency.
example: 42.5
INT_AMT_USD:
type: number
format: double
description: Interest Amount (USD) expressed in US dollar currency.
example: 48.2
OVERRIDE_CNTRY_ID_TRS:
type: number
format: double
description: Security Domicile (Stock Residency) is the country in which tax was withheld and where tax will be reclaimed.
example: 1
MARKET:
type: string
description: Depot Domicile is the country where the sub‑account is held.
example: AUSTRALIA
TOTAL_AMT_RECVED_CCY:
type: number
format: double
description: Reclaim Amount Received including interest, expressed in the currency of the reclaim.
example: 350
TOTAL_AMT_RECVED_EUR:
type: number
format: double
description: Reclaim Amount Received (EUR) including interest.
example: 325
TOTAL_AMT_RECVED_GBP:
type: number
format: double
description: Reclaim Amount Received (GBP) including interest.
example: 290
TOTAL_AMT_RECVED_USD:
type: number
format: double
description: Reclaim Amount Received (USD) including interest.
example: 380
ACCT_BASE_NBR:
type: string
description: Account Base Number is an internal Citi client identifier associated with a Safekeeping or Cash Account.
example: '133611'
ACCT_BUS_TYP_CD:
type: string
description: 'Account Type Code: C (Cash Account), S (Safekeeping Account).'
example: C
ACCT_BUS_TYP_NME:
type: string
description: 'Account Type Description: CASH (C), S/K (S).'
example: CASH
ACCT_CLS_DT:
type: string
format: date
description: Account Close Date, populated only if the account is closed.
example: '2024-12-31'
ACCT_ID:
type: string
description: Account ID uniquely identifies a Cash or Safekeeping Account within a branch.
example: DEMOSK02US
ACCT_NME:
type: string
description: Account Name displayed for the Cash or Safekeeping Account.
example: Demo - SK - US DCC Equity
ACCT_OPN_DT:
type: string
format: date
description: Account Open Date is the date when the account was opened.
example: '2020-01-15'
ACCT_STS_TYP:
type: string
description: 'Account Status: Open, Closed, Frozen.'
example: Open
ALTV_CUR_CD:
type: string
description: Account Base Currency Code is the ISO Currency Code of the account.
example: JPY
BR_ID:
type: string
description: Branch Code identifying the branch of the account.
example: SG
BR_NME:
type: string
description: Branch Name associated with the account.
example: CITIBANK JAPAN LTD
CASH_TYPE:
type: number
format: double
description: Cash Type Code for US Direct Cash Accounts indicating split balance configuration.
example: 1
GFC_ID:
type: string
description: Client ID (GFCID) available on Cash or Safekeeping Accounts.
example: '1000123456'
IBAN:
type: string
description: IBAN of the Cash Account (nullable).
example: 'null'
CMPNY_NME:
type: string
description: Company Name of the security issuer.
example: ABC Capital Ltd.
SEC_DESC:
type: string
description: Issue Description of the instrument.
example: SOPRA STERIA GROUP
SEC_SECURITY_CD:
type: string
description: CITI Internal Security Identifier.
example: BVGH0K1
SEC_SHRT_NME:
type: string
description: Security short name.
example: NESTLE
SID_BLOOMBERG:
type: string
description: Bloomberg Security Identifier.
example: BBG00K60SBR4
SID_CUSIP:
type: string
description: CUSIP identifier for North American securities.
example: E00460233
SID_LOCAL:
type: string
description: Local Security Identifier.
example: DNB
SID_TICKER_SYMB:
type: string
description: Security ticker symbol.
example: KINVB
ACRL_BASIS_CDE:
type: string
description: Accrual Basis Code for interest accrual calculations.
example: '00011'
ACRL_BASIS_NME:
type: string
description: Accrual Basis Description.
example: Actual/360
CURR_FCTR_RATE:
type: number
format: double
description: Current Factor for principal paying securities.
example: 0.4515268
DLAY_DAYS:
type: string
description: Delay Days for mortgage‑backed securities.
example: '13'
DNOMD_CUR_CD:
type: string
description: Denomination Currency Code.
example: USD
DTED_TMS:
type: string
format: date-time
description: Dated Date/Time when interest begins to accrue.
example: '2019-08-26 00:00:00'
FCTR_DTE:
type: string
format: date-time
description: Factor Date for principal paying securities.
example: '2023-12-10 00:00:00'
INCM_CUR_CD:
type: string
description: Income Currency Code.
example: EUR
INCM_CUR_NME:
type: string
description: Income Currency Name.
example: Euro
INCM_PROJN_RATE:
type: number
format: double
description: Interest (Coupon) Rate.
example: 3.0946
ISS_CAT_NME:
type: string
description: Issue Category description.
example: Derivatives
ISS_CATG_CD:
type: string
description: Issue Category Code.
example: DERIV
ISS_TMS:
type: string
format: date-time
description: Issue Date of the security.
example: '2019-11-26 00:00:00'
ISSR_LOC_CD:
type: string
description: Issuer Location Code (ISO country code).
example: US
ISSR_LOC_NME:
type: string
description: Issuer Location Country Name.
example: United States
MATY_DT:
type: string
format: date-time
description: Maturity Date.
example: '2041-10-10 00:00:00'
NXT_PAY_DT:
type: string
format: date
description: Next Payable Date for dividend or coupon.
example: '2026-07-15'
PFD_ID_CTXT_CD:
type: string
description: Security ID Type (e.g., CUSIP, ISIN, SEDOL, LOCAL).
example: ISIN
PFD_ISS_ID:
type: string
description: Primary Security Identifier.
example: BFXCMX4
PMT_FREQY_DESC:
type: string
description: Payment Frequency description.
example: Sem-Annual
POOL_ID_CD:
type: string
description: Pool ID for mortgage‑backed securities.
example: AB1234
PREV_FCTR_RATE:
type: number
format: double
description: Previous Factor applied to last accrual period.
example: 0.9985
SEC_GROUP:
type: string
description: Asset Type code (EQTY, FI, etc.).
example: EQTY
SEC_SUB_TYP_CD:
type: string
description: Issue Type Code.
example: '12'
SEC_SUB_TYP_NME:
type: string
description: Issue Type description.
example: Bond
STRK_PRC_AMT:
type: number
format: double
description: Strike Price for options.
example: 150.09
US_SIC_CD:
type: string
description: Standard Industrial Classification code.
example: '7372'
PAYABLE_DATE:
type: string
format: date
description: Payable Date for dividend or coupon.
example: '2026-08-28'
f631ab51-6333-4183-9ef7-144f5fadc9b5-json-response-schema:
type: object
properties:
Count:
type: number
format: integer
PagedList:
type: array
items:
$ref: '#/components/schemas/f631ab51-6333-4183-9ef7-144f5fadc9b5-data-schema'
f631ab51-6333-4183-9ef7-144f5fadc9b5-xml-response-schema:
type: object
properties:
row:
type: array
items:
$ref: '#/components/schemas/f631ab51-6333-4183-9ef7-144f5fadc9b5-data-schema'
xml:
name: data
securitySchemes:
client-Credential-Oauth-Security-Schema:
type: oauth2
description: This API uses OAuth 2 with the client credentials flow
flows:
clientCredentials:
tokenUrl: /markets/api/oauth2/token
scopes:
/dod: Access to Cash Balances Information
x-refined-from:
- cash-balances.yaml
- cash-transactions.yaml
- citi-custody-fx-transactions-openapi.yaml
- citi-custody-penalties-openapi.yaml
- citi-safekeeping-accounts-openapi.yaml
- citi-safekeeping-positions-openapi.yaml
- citi-securitytransactionsaccounts-openapi.yaml
- citi-tax-reclaims-openapi.yaml