{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/citi/json-schema/citi-4b1404f9-e30e-434d-aca0-151861edacf1-json-response-schema-schema.json", "title": "4b1404f9-e30e-434d-aca0-151861edacf1-json-response-schema", "x-generated": "2026-11-10", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/citi-services-api-openapi.yml#/components/schemas/4b1404f9-e30e-434d-aca0-151861edacf1-json-response-schema", "type": "object", "properties": { "Count": { "type": "number", "format": "integer" }, "PagedList": { "type": "array", "items": { "$ref": "#/$defs/4b1404f9-e30e-434d-aca0-151861edacf1-data-schema" } } }, "$defs": { "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." }, "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." }, "CPRT_ACCT_SER_NAME": { "type": "string", "description": "Counterparty's Account Servicer/Depository is the name of the counterparty's account servicer/depository." }, "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." }, "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." }, "CASH_ACCT_ID": { "type": "string", "description": "Cash Account ID is the account number for the cash account. It is unique within a branch." }, "CPRT_NET_AMT_CURR": { "type": "string", "description": "Net Amount Currency is the currency of the Net Amount." }, "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." }, "PFOD_MESG_ID": { "type": "string", "description": "Reference of the penalty payment." }, "ACCT_SERVR_BIC": { "type": "string", "description": "Account Servicer/Depository BIC is the Bank Identifier code of the party which administers the account." }, "CURRENCY": { "type": "string", "description": "Currency in which the penalties are expressed." }, "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)." }, "PARTY_TYPE": { "type": "string", "description": "Specifies the role of the party in the transaction." }, "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)." }, "CPRT_TYPE": { "type": "string", "description": "Specifies the role of the counterparty in the transaction" }, "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." }, "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." }, "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)." }, "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)." }, "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." }, "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." }, "CALC_METHOD": { "type": "string", "description": "Calcualtion Method indixates the calculation rule used to compute the penalty. Values are CASH, MIXE, SECU, BOTH." }, "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." }, "ACCT_OWN_TX_ID": { "type": "string", "description": "Reference assigned to the reported transaction by the account owner." }, "ACCT_SEC_TX_ID": { "type": "string", "description": "Reference assigned to the reported transaction by the account servicer." }, "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." }, "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." }, "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." }, "CORP_ACT_EV_ID": { "type": "string", "description": "Reference assigned by the account servicer to unambiguously identify a related corporate action event." }, "RELATED_TX_ID": { "type": "string", "description": "Reference of the linked message which was previously received." }, "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)." }, "CPRT_ACCT_SER_BIC": { "type": "string", "description": "Counterparty's Account Servicer/Depository BIC is the Bank Identifier of the counterparty's account servicer/depository." }, "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." }, "PENALTY_STATUS": { "type": "string", "description": "Penalty status is to check if penalty is active or inactive for a given record." } } } } }