TransactionAccountRestrictionUpdatedV1

v1.0.0

{
  "$id": "https://example.com/TransactionAccountRestrictionAddedV1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "TransactionAccountRestrictionAddedV1",
  "description": "An event raised when a transaction account restriction is added",
  "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 TransactionAccountRestrictionAddedV1"
        },
        "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 transaction account"
        },
        "accountNumber": {
          "type": "string",
          "description": "The account number of the transaction account"
        },
        "globalTransactionAccountRestrictionId": {
          "type": "string",
          "description": "The GUID of the transaction account restriction"
        },
        "restrictionDetails":{
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "description": "The type of restriction added to the transaction account. Allowed values are 01, 03, 06, 11, 02, 04, 05. The values descriptions 01-Account Full Restriction, 03-No Bidding, 06-No Payment, 11-No Collection, 02-No Consigning, 04-Consignment Warning, 05-Bidding Warning"
            },
            "reason": {
              "type": "string",
              "description": "The reason for the restriction on the transaction account. Allowed values are AA, A, CO, CR, FR, KYC, L, O, R, ST. The values descriptions are AA-Abuse of Account, A-Anti-Money Laundering, CO-Commercial Office, CR-Credit, FR-Fraud, KYC-Know Your Client, L-Legal, O-Other, R-Restitution, ST-Settlements."
            },
            "status": {
              "type": "string",
              "description": "The status of the restriction on the transaction account. Allowed values Active,Removed."
            },
            "placedOn": {
              "type": "string",
              "description": "The date and time when the restriction was placed on the transaction account"
            },
            "confidentialNote": {
              "type": "string",
              "description": "Any confidential note regarding the restriction"
            },
            "nonConfidentialNote": {
              "type": "string",
              "description": "Any non-confidential note regarding the restriction"
            }
          }
        }
      }
    }
  }
}