{"openapi":"3.0.4","info":{"title":"Get transaction settlement status","description":"Gets the Transaction Settlement Status for the requested transaction.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/transactionportfolios/{scope}/{code}/transactions/{transactionId}/settlementstatus":{"get":{"tags":["Transaction Portfolios"],"summary":"Get transaction settlement status","description":"Gets the Transaction Settlement Status for the requested transaction.","operationId":"GetTransactionSettlementStatus","parameters":[{"name":"scope","in":"path","description":"The scope of the transaction portfolio.","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}},{"name":"code","in":"path","description":"The code of the transaction portfolio. This together with the scope uniquely identifies the transaction portfolio.","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}},{"name":"transactionId","in":"path","description":"The ID of the transaction.","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}},{"name":"effectiveAt","in":"query","description":"The effective date and time or cut label to get the transaction settlement status.\r\n            This defaults to the current LUSID system time if not specified.","schema":{"type":"string","format":"dateorcutlabel"}},{"name":"asAt","in":"query","description":"The asAt date and time to get the transaction settlement status. \r\n            This defaults to return the latest status if not specified.","schema":{"type":"string","format":"date-time"},"x-nullable":true},{"name":"propertyKeys","in":"query","description":"A list of property keys from the 'SettlementInstruction', 'Instrument' or 'Portfolio' domains to decorate onto\r\n            settlement instructions. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name' or 'SettlementInstruction/strategy/quantsignal'.","schema":{"type":"array","items":{"type":"string","description":"The key that uniquely identifies the property. It has the format {domain}/{scope}/{code}."}},"x-nullable":true}],"responses":{"200":{"description":"The Transaction Settlement Status for the requested transaction.","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/TransactionSettlementStatus"},"example":{"transactionId":"TXN-1","settlementBuckets":[{"settlementCategory":"StockSettlement","lusidInstrumentId":"LUID_Equity","instrumentScope":"default","contractualSettlementDate":"2025-02-28T00:00:00.0000000+00:00","contractedUnits":1000,"settledUnits":1000,"unsettledUnits":0,"overdueUnits":0,"configuredSettlement":"Automatic","settlementInstructions":[],"movements":[{"name":"ReceiveStock","type":"StockMovement","units":1000,"direction":1,"settlementMode":"External"}]},{"settlementCategory":"CashSettlement","lusidInstrumentId":"CCY_GBP","instrumentScope":"default","contractualSettlementDate":"2025-02-28T00:00:00.0000000+00:00","contractedUnits":-101000,"settledUnits":-101000,"unsettledUnits":0,"overdueUnits":0,"configuredSettlement":"Instructed","settlementInstructions":[{"settlementInstructionId":"inst-1","instructionType":"Complete","actualSettlementDate":"2025-03-01T00:00:00.0000000+00:00","units":-101000,"isActive":true}],"movements":[{"name":"GrossConsideration","type":"CashCommitment","units":100000,"direction":-1,"settlementMode":"External"},{"name":"Fees","type":"CashCommitment","units":1000,"direction":-1,"settlementMode":"External"}]}]}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/TransactionSettlementStatus"},"example":{"transactionId":"TXN-1","settlementBuckets":[{"settlementCategory":"StockSettlement","lusidInstrumentId":"LUID_Equity","instrumentScope":"default","contractualSettlementDate":"2025-02-28T00:00:00.0000000+00:00","contractedUnits":1000,"settledUnits":1000,"unsettledUnits":0,"overdueUnits":0,"configuredSettlement":"Automatic","settlementInstructions":[],"movements":[{"name":"ReceiveStock","type":"StockMovement","units":1000,"direction":1,"settlementMode":"External"}]},{"settlementCategory":"CashSettlement","lusidInstrumentId":"CCY_GBP","instrumentScope":"default","contractualSettlementDate":"2025-02-28T00:00:00.0000000+00:00","contractedUnits":-101000,"settledUnits":-101000,"unsettledUnits":0,"overdueUnits":0,"configuredSettlement":"Instructed","settlementInstructions":[{"settlementInstructionId":"inst-1","instructionType":"Complete","actualSettlementDate":"2025-03-01T00:00:00.0000000+00:00","units":-101000,"isActive":true}],"movements":[{"name":"GrossConsideration","type":"CashCommitment","units":100000,"direction":-1,"settlementMode":"External"},{"name":"Fees","type":"CashCommitment","units":1000,"direction":-1,"settlementMode":"External"}]}]}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/TransactionSettlementStatus"},"example":{"transactionId":"TXN-1","settlementBuckets":[{"settlementCategory":"StockSettlement","lusidInstrumentId":"LUID_Equity","instrumentScope":"default","contractualSettlementDate":"2025-02-28T00:00:00.0000000+00:00","contractedUnits":1000,"settledUnits":1000,"unsettledUnits":0,"overdueUnits":0,"configuredSettlement":"Automatic","settlementInstructions":[],"movements":[{"name":"ReceiveStock","type":"StockMovement","units":1000,"direction":1,"settlementMode":"External"}]},{"settlementCategory":"CashSettlement","lusidInstrumentId":"CCY_GBP","instrumentScope":"default","contractualSettlementDate":"2025-02-28T00:00:00.0000000+00:00","contractedUnits":-101000,"settledUnits":-101000,"unsettledUnits":0,"overdueUnits":0,"configuredSettlement":"Instructed","settlementInstructions":[{"settlementInstructionId":"inst-1","instructionType":"Complete","actualSettlementDate":"2025-03-01T00:00:00.0000000+00:00","units":-101000,"isActive":true}],"movements":[{"name":"GrossConsideration","type":"CashCommitment","units":100000,"direction":-1,"settlementMode":"External"},{"name":"Fees","type":"CashCommitment","units":1000,"direction":-1,"settlementMode":"External"}]}]}}}},"400":{"description":"The details of the input related failure","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidProblemDetails"}}}}},"security":[{"BearerAuth":[]}],"x-fbn-apistatus":"EarlyAccess"}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}