TransactionAccountUpdatedV1v1.0.0
Holds information about when a transaction account is updated for a client in operational data store.
When firing this event make sure you set the `correlationId` in the headers. Our schemas have standard metadata make sure you read and follow it.
Details
This event can only be triggered once when a client transaction account is updated in Operational data store.
Consumer / Producer Diagram
TransactionAccountUpdatedV1 Schema (json)
{
"$id": "https://example.com/TransactionAccountUpdatedV1.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "TransactionAccountUpdatedV1",
"description": "An event raised when a transaction account is updated",
"type": "object",
"properties": {
"metadata": {
"type": "object",
"properties": {
"occurredAtUtc": {
"type": "string",
"description": "The date and time when event occurred in UTC. Date should be represented in ISO 8601 format e.g 2023-09-08T12:00:00Z"
},
"typeName": {
"type": "string",
"description": "The name of the event. E.g PersonClientCreatedV1"
},
"source": {
"type": "string",
"description": "The source of the event like was it genereated by Client using Web or WeChat"
},
"applicationBreadcrumb": {
"type": "string",
"description": "Th application path which is describing the chain of applications. For e.g my-christies-web-ui;3.0.1:follows-api;v1.1.0"
},
"version":{
"type": "string",
"description": "The version of the message in semantic versioning format ideally V{major.minor.patch}. E.g V1.0.0 or just V{majorVersion}"
},
"sentAtUtc": {
"type": "string",
"description": "When event was sent by the publishers in ISO 8601 "
},
"isTransactionalAccountAvailableForClient": {
"type": "boolean",
"description": "Indicates if the transaction account for a client is available"
}
},
"required": [ "occurredAtUtc", "typeName", "sentAtUtc", "version", "isTransactionalAccountAvailableForClient"]
},
"data": {
"type": "object",
"properties": {
"globalTransactionAccountId": {
"type": "string",
"description": "The GUID of the transaction account"
},
"accountNumber": {
"type": "string",
"description": "The account number of the transaction account"
},
"accountName": {
"type": "string",
"description": "The name of the transaction account"
},
"alternativeLanguage": {
"type": "string",
"description": "The alternative language name of the transaction account"
},
"alternativeLanguageAccountName": {
"type": "string",
"description": "The alternative language name of the transaction account"
},
"status": {
"type": "string",
"description": "The status of the transaction account, e.g. Active, Inactive"
},
"isJointAccount": {
"type": "boolean",
"description": "Indicates if the transaction account is a joint account"
},
"primaryAccountHolderClientGlobalId": {
"type": "string",
"description": "The GUID of the primary account holder"
},
"primaryAccountHolderClientNumber": {
"type": "string",
"description": "The client number of the primary account holder"
},
"accountAddress": {
"type": "object",
"description": "The address associated with the transaction account",
"properties": {
"globalClientAddressId": {
"type": "string",
"description": "Global client address ID"
},
"addressNumber": {
"type": "number",
"description": "The address number of the client"
},
"mailingNameLine1": {
"type": "string",
"description": "First line of the mailing name"
},
"mailingNameLine2": {
"type": "string",
"description": "Second line of the mailing name"
},
"line1": {
"type": "string",
"description": "First line of the address"
},
"line2": {
"type": "string",
"description": "Second line of the address"
},
"line3": {
"type": "string",
"description": "Third line of the address"
},
"city": {
"type": "string",
"description": "City of the address"
},
"state": {
"type": ["string"],
"description": "State"
},
"country": {
"type": ["string"],
"description": "Country"
},
"county": {
"type": "string",
"description": "County name"
},
"postalCode": {
"type": "string",
"description": "Postal code"
},
"alternativeLanguage": {
"type": ["string"],
"description": "Alternative language"
},
"alternativeLanguageMailingNameLine1": {
"type": "string",
"description": "First line of the mailing name in alternative language"
},
"alternativeLanguageMailingNameLine2": {
"type": "string",
"description": "Second line of the mailing name in alternative language"
},
"alternativeLanguageLine1": {
"type": "string",
"description": "First line of the address in alternative language"
},
"alternativeLanguageLine2": {
"type": "string",
"description": "Second line of the address in alternative language"
},
"alternativeLanguageLine3": {
"type": "string",
"description": "Third line of the address in alternative language"
},
"alternativeLanguageCity": {
"type": "string",
"description": "City in alternative language"
},
"alternativeLanguageState": {
"type": "string",
"description": "State in alternative language"
},
"alternativeLanguageCounty": {
"type": "string",
"description": "County in alternative language"
},
"alternativeLanguagePostalCode": {
"type": "string",
"description": "Postal code in alternative language"
},
"alternativeLanguageCountry": {
"type": "string",
"description": "Country in alternative language"
},
"addressStatus": {
"type": ["string"],
"description": "Address Status. Allowed values: Current, Do Not Use, Incorrect, Old"
},
"addressType": {
"type": ["string"],
"description": "Address Type. Allowed values: Business, Holiday Home, Home, Other Home, Registered, Residential, Temporary"
}
}
},
"invoiceAddress": {
"type": "object",
"description": "The invoice address associated with the transaction account",
"properties": {
"globalClientAddressId": {
"type": "string",
"description": "Global client address ID"
},
"addressNumber": {
"type": "number",
"description": "The address number of the client"
},
"mailingNameLine1": {
"type": "string",
"description": "First line of the mailing name"
},
"mailingNameLine2": {
"type": "string",
"description": "Second line of the mailing name"
},
"line1": {
"type": "string",
"description": "First line of the address"
},
"line2": {
"type": "string",
"description": "Second line of the address"
},
"line3": {
"type": "string",
"description": "Third line of the address"
},
"city": {
"type": "string",
"description": "City of the address"
},
"state": {
"type": ["string"],
"description": "State"
},
"country": {
"type": ["string"],
"description": "Country"
},
"county": {
"type": "string",
"description": "County name"
},
"postalCode": {
"type": "string",
"description": "Postal code"
},
"alternativeLanguage": {
"type": ["string"],
"description": "Alternative language"
},
"alternativeLanguageMailingNameLine1": {
"type": "string",
"description": "First line of the mailing name in alternative language"
},
"alternativeLanguageMailingNameLine2": {
"type": "string",
"description": "Second line of the mailing name in alternative language"
},
"alternativeLanguageLine1": {
"type": "string",
"description": "First line of the address in alternative language"
},
"alternativeLanguageLine2": {
"type": "string",
"description": "Second line of the address in alternative language"
},
"alternativeLanguageLine3": {
"type": "string",
"description": "Third line of the address in alternative language"
},
"alternativeLanguageCity": {
"type": "string",
"description": "City in alternative language"
},
"alternativeLanguageState": {
"type": "string",
"description": "State in alternative language"
},
"alternativeLanguageCounty": {
"type": "string",
"description": "County in alternative language"
},
"alternativeLanguagePostalCode": {
"type": "string",
"description": "Postal code in alternative language"
},
"alternativeLanguageCountry": {
"type": "string",
"description": "Country in alternative language"
},
"addressStatus": {
"type": ["string"],
"description": "Address Status. Allowed values: Current, Do Not Use, Incorrect, Old"
},
"addressType": {
"type": ["string"],
"description": "Address Type. Allowed values: Business, Holiday Home, Home, Other Home, Registered, Residential, Temporary"
}
}
},
"shippingAddress": {
"type": "object",
"description": "The shipping address associated with the transaction account",
"properties": {
"globalClientAddressId": {
"type": "string",
"description": "Global client address ID"
},
"addressNumber": {
"type": "number",
"description": "The address number of the client"
},
"mailingNameLine1": {
"type": "string",
"description": "First line of the mailing name"
},
"mailingNameLine2": {
"type": "string",
"description": "Second line of the mailing name"
},
"line1": {
"type": "string",
"description": "First line of the address"
},
"line2": {
"type": "string",
"description": "Second line of the address"
},
"line3": {
"type": "string",
"description": "Third line of the address"
},
"city": {
"type": "string",
"description": "City of the address"
},
"state": {
"type": ["string"],
"description": "State"
},
"country": {
"type": ["string"],
"description": "Country"
},
"county": {
"type": "string",
"description": "County name"
},
"postalCode": {
"type": "string",
"description": "Postal code"
},
"alternativeLanguage": {
"type": ["string"],
"description": "Alternative language"
},
"alternativeLanguageMailingNameLine1": {
"type": "string",
"description": "First line of the mailing name in alternative language"
},
"alternativeLanguageMailingNameLine2": {
"type": "string",
"description": "Second line of the mailing name in alternative language"
},
"alternativeLanguageLine1": {
"type": "string",
"description": "First line of the address in alternative language"
},
"alternativeLanguageLine2": {
"type": "string",
"description": "Second line of the address in alternative language"
},
"alternativeLanguageLine3": {
"type": "string",
"description": "Third line of the address in alternative language"
},
"alternativeLanguageCity": {
"type": "string",
"description": "City in alternative language"
},
"alternativeLanguageState": {
"type": "string",
"description": "State in alternative language"
},
"alternativeLanguageCounty": {
"type": "string",
"description": "County in alternative language"
},
"alternativeLanguagePostalCode": {
"type": "string",
"description": "Postal code in alternative language"
},
"alternativeLanguageCountry": {
"type": "string",
"description": "Country in alternative language"
},
"addressStatus": {
"type": ["string"],
"description": "Address Status. Allowed values: Current, Do Not Use, Incorrect, Old"
},
"addressType": {
"type": ["string"],
"description": "Address Type. Allowed values: Business, Holiday Home, Home, Other Home, Registered, Residential, Temporary"
}
}
},
"wineDeliverAddress": {
"type": "object",
"description": "The wine delivery address associated with the transaction account",
"properties": {
"globalClientAddressId": {
"type": "string",
"description": "Global client address ID"
},
"addressNumber": {
"type": "number",
"description": "The address number of the client"
},
"mailingNameLine1": {
"type": "string",
"description": "First line of the mailing name"
},
"mailingNameLine2": {
"type": "string",
"description": "Second line of the mailing name"
},
"line1": {
"type": "string",
"description": "First line of the address"
},
"line2": {
"type": "string",
"description": "Second line of the address"
},
"line3": {
"type": "string",
"description": "Third line of the address"
},
"city": {
"type": "string",
"description": "City of the address"
},
"state": {
"type": ["string"],
"description": "State"
},
"country": {
"type": ["string"],
"description": "Country"
},
"county": {
"type": "string",
"description": "County name"
},
"postalCode": {
"type": "string",
"description": "Postal code"
},
"alternativeLanguage": {
"type": ["string"],
"description": "Alternative language"
},
"alternativeLanguageMailingNameLine1": {
"type": "string",
"description": "First line of the mailing name in alternative language"
},
"alternativeLanguageMailingNameLine2": {
"type": "string",
"description": "Second line of the mailing name in alternative language"
},
"alternativeLanguageLine1": {
"type": "string",
"description": "First line of the address in alternative language"
},
"alternativeLanguageLine2": {
"type": "string",
"description": "Second line of the address in alternative language"
},
"alternativeLanguageLine3": {
"type": "string",
"description": "Third line of the address in alternative language"
},
"alternativeLanguageCity": {
"type": "string",
"description": "City in alternative language"
},
"alternativeLanguageState": {
"type": "string",
"description": "State in alternative language"
},
"alternativeLanguageCounty": {
"type": "string",
"description": "County in alternative language"
},
"alternativeLanguagePostalCode": {
"type": "string",
"description": "Postal code in alternative language"
},
"alternativeLanguageCountry": {
"type": "string",
"description": "Country in alternative language"
},
"addressStatus": {
"type": ["string"],
"description": "Address Status. Allowed values: Current, Do Not Use, Incorrect, Old"
},
"addressType": {
"type": ["string"],
"description": "Address Type. Allowed values: Business, Holiday Home, Home, Other Home, Registered, Residential, Temporary"
}
}
},
"taxCountry": {
"type": "string",
"description": "The country of the transaction account for tax purposes"
},
"taxNumber": {
"type": "string",
"description": "The tax number associated with the transaction account"
},
"hongKongConsignmentTaxStatus": {
"type": "boolean",
"description": "Indicates if the transaction account is subject to Hong Kong consignment tax"
},
"hongKongConsignmentTaxDate": {
"type": "string",
"format": "date-time",
"description": "The date when the Hong Kong consignment tax was applied"
},
"termsType": {
"type": "string",
"description": "The type of terms associated with the transaction account, e.g. Standard, Special"
},
"termsBuyerDays": {
"type": "number",
"description": "The number of days for buyer terms associated with the transaction account"
},
"termsSellerDays": {
"type": "number",
"description": "The number of days for seller terms associated with the transaction account"
},
"aicDealType":{
"type": "string",
"description": "The type of AIC deal associated with the transaction account, e.g. Standard, Special"
},
"aicRecipientType": {
"type": "string",
"description": "The type of recipient for AIC deals associated with the transaction account, e.g. Buyer, Seller"
},
"aicDealStartOn": {
"type": "string",
"format": "date-time",
"description": "The start date of the AIC deal associated with the transaction account"
},
"aicDealEndOn": {
"type": "string",
"format": "date-time",
"description": "The end date of the AIC deal associated with the transaction account"
},
"vatCountry": {
"type": "string",
"description": "The country of the transaction account for VAT purposes"
},
"vatNumber": {
"type": "string",
"description": "The VAT number associated with the transaction account"
},
"sellerVatStatus": {
"type": "boolean",
"description": "Indicates if the transaction account is a seller VAT account"
},
"isBuyerMarginScheme": {
"type": "boolean",
"description": "Indicates if the transaction account is a buyer margin scheme account"
},
"isSellerMarginScheme": {
"type": "boolean",
"description": "Indicates if the transaction account is a seller margin scheme account"
},
"isEuConsumerRightDirective": {
"type": "boolean",
"description": "Indicates if the transaction account is subject to the EU Consumer Rights Directive"
}
}
}
}
}
Edit this pageLast updated on 2026/1/30