Event Name
createBankTransactionCode.bankTransactionCodeCreated
Domain
reference
Description
an event indicating the creation of a new Transaction code, which is used to classify financial transactions.
Properties
{
"transactionCode": {
"type": "string",
"description": "Identifies the system internal transaction code applicable to the transaction"
},
"transactionNames": {
"type": "array",
"description": "The transaction description",
"items": {
"id": "urn:jsonschema:transactionNames",
"properties": {
"transactionName": {
"type": "string",
"description": "The transaction description"
}
}
}
},
"chequeTransaction": {
"type": "string",
"description": "Indicates whether the transactions using this code requires mandatory cheque number"
},
"chequeIdRequired": {
"type": "string",
"description": "Indicates whether the transactions using this code requires mandatory reference number"
},
"debitCreditIndicator": {
"type": "string",
"description": "Indicator flag which is set whenever a debit or a credit transaction happens in the account"
},
"chargeIds": {
"type": "array",
"description": "This indicates the charge code which will be triggered for payment stop instruction. Applicable when financial institutions would like to charge for stop payment of cheque etc. ",
"items": {
"id": "urn:jsonschema:chargeIds",
"properties": {
"chargeId": {
"type": "string",
"description": "This indicates the charge code which will be triggered for payment stop instruction. Applicable when financial institutions would like to charge for stop payment of cheque etc. "
}
}
}
},
"defaultValueDate": {
"type": "string",
"description": "Indicates that values date to be defaulted during the transactions using this transaction code."
},
"defaultExposureDate": {
"type": "string",
"description": "Indicates if transaction using this code will have exposure date defaulted."
},
"includeInTurnoverCharge": {
"type": "string",
"description": "Indicates whether the transaction using this code are to be included in the calculation of Debit/Credit turnover charges"
},
"swiftNarrative": {
"type": "string",
"description": "Indicates the SWIFT narrative corresponding to the transaction code as per the rules specified in the SWIFT user handbook"
},
"transactionInitiationType": {
"type": "string",
"description": "Defines the initiator type of transaction. Example - bank or customer"
},
"description": {
"type": "string",
"description": "Specifies the description of the parameter record"
},
"narrative": {
"type": "string",
"description": "The additional text printed on descriptive statements in addition to the standard narrative and/or reference"
},
"statementReferenceField": {
"type": "string",
"description": "Defines if reference has to appear as part of statement narrative."
},
"forceDefaultExposureDate": {
"type": "string",
"description": "Indicates that user wants to force in the default exposure date in a financial transaction"
},
"statementNarrativeFormatId": {
"type": "string",
"description": "Identifier of the statement narration format record."
},
"categoryId": {
"type": "string",
"description": "Unique identifier associated with the product name of the account or contract. For example: For customer/counterparty accounts, the identifier would be in the range 1000 to 9999. For ledger accounts, in the range 10000 to 19999."
},
"productId": {
"type": "string",
"description": "Contains the unique identifier of the product, e.g. the product id of the arrangement account."
},
"transactionIds": {
"type": "array",
"description": "Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc.",
"items": {
"id": "urn:jsonschema:transactionIds",
"properties": {
"transactionId": {
"type": "string",
"description": "Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."
}
}
}
},
"exposureDateConditionId": {
"type": "string",
"description": "Identifier of the exposure condition record"
},
"chequeTypeId": {
"type": "string",
"description": "Indicates the type of Cheques for which payment stop instruction is effective"
},
"exemptDispoProcessing": {
"type": "string",
"description": "Indicates if the transaction is to be excluded from dispo processing"
},
"transactionType": {
"type": "string",
"description": "Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."
},
"changedAttributes": {
"type": "array",
"description": "Indicates the changes attributes in an application",
"items": {
"id": "urn:jsonschema:changedAttributes",
"properties": {
"categoryId": {
"type": "string",
"description": "Unique identifier associated with the product name of the account or contract. For example: For customer/counterparty accounts, the identifier would be in the range 1000 to 9999. For ledger accounts, in the range 10000 to 19999."
},
"displayNames": {
"type": "array",
"description": "Contains the name used for display or enrichment purposes",
"items": {
"id": "urn:jsonschema:displayNames",
"properties": {
"displayName": {
"type": "string",
"description": "Contains the name used for display or enrichment purposes"
}
}
}
},
"categoryNames": {
"type": "array",
"description": "Name that is displayed for the product category",
"items": {
"id": "urn:jsonschema:categoryNames",
"properties": {
"categoryName": {
"type": "string",
"description": "Name that is displayed for the product category"
}
}
}
},
"systemId": {
"type": "string",
"description": "The system application identifier that could be used as entry reference or used as prefix in unique transaction identifiers"
},
"mnemonic": {
"type": "string",
"description": "Shortcut code for referring an Entity/Company/Branch."
},
"reportingType": {
"type": "string",
"description": "Defines how the balance type should be used with respect to reporting"
},
"entryConsolidationId": {
"type": "string",
"description": "Identifier of the entry consolidation rule followed"
},
"positionType": {
"type": "string",
"description": "Identifies the position type. Possible values are CAS(cash position), GAP(Interest mismatch position), FXP(Foreign exchange position)"
},
"countryIds": {
"type": "array",
"description": "ISO country code of the financial institution. ",
"items": {
"id": "urn:jsonschema:countryIds",
"properties": {
"countryId": {
"type": "string",
"description": "ISO country code of the financial institution. "
}
}
}
},
"currencyIds": {
"type": "array",
"description": "Identifier of the currency. This is the 3-letter ISO 4217 code of the currency.",
"items": {
"id": "urn:jsonschema:currencyIds",
"properties": {
"currencyId": {
"type": "string",
"description": "Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."
}
}
}
},
"countryNames": {
"type": "array",
"description": "This is the country name that the financial institution resides in.",
"items": {
"id": "urn:jsonschema:countryNames",
"properties": {
"countryName": {
"type": "string",
"description": "This is the country name that the financial institution resides in."
}
}
}
},
"geographicalBlock": {
"type": "string",
"description": "Identifier of country's geographical block"
},
"capitalGainsIndexes": {
"type": "array",
"description": "Indicates the inflation index associated with the country or currency",
"items": {
"id": "urn:jsonschema:capitalGainsIndexes",
"properties": {
"capitalGainsIndex": {
"type": "string",
"description": "Indicates the inflation index associated with the country or currency"
},
"capitalGainsIndexDate": {
"type": "string",
"description": "Indicates the date until which the inflation index is applicable for the country or currency"
}
}
}
},
"traceDays": {
"type": "string",
"description": "Indicates the period of days after which the tracer messages are recycled and resent"
},
"riskLevel": {
"type": "string",
"description": "Indicates the Numeric risk level indication from 0 to 99 to capture the risk level accessed for the customer"
},
"phoneNumber": {
"type": "string",
"description": "The phone number of the customer or prospect"
},
"countryCode": {
"type": "string",
"description": "Specifies the countries which have the same national id type in the SWIFT Bank Directory Plus"
},
"numericCountryCode": {
"type": "string",
"description": "ISO 3166-1-numeric- country code of financial institution"
},
"accountOfficer": {
"type": "string",
"description": "Identifier of Department Account Officer"
},
"accountOfficerArea": {
"type": "string",
"description": "Indicates the Area of responsibility for the Account Officer"
},
"accountOfficerName": {
"type": "string",
"description": "Name of the account or relationship officer attached to the Customer"
},
"addressLocation": {
"type": "string",
"description": "Identifies the nature of the postal address, like primary, secondary or office address"
},
"allowedCompanies": {
"type": "array",
"description": "Identifies list of companies/entities which can make use of the limit",
"items": {
"id": "urn:jsonschema:allowedCompanies",
"properties": {
"allowedCompany": {
"type": "string",
"description": "Indicates the companies where central directory record is allowed to use"
}
}
}
},
"excludedCompanies": {
"type": "array",
"description": "Indicates the companies where central directory record is excluded to use",
"items": {
"id": "urn:jsonschema:excludedCompanies",
"properties": {
"excludedCompany": {
"type": "string",
"description": "Indicates the companies where central directory record is excluded to use"
}
}
}
},
"faxId": {
"type": "string",
"description": "The fax (facsimile) number of the customer"
},
"departmentLevel": {
"type": "string",
"description": "Indicates the valid levels of the departmental hierarchy that are permitted in the system."
},
"departmentParent": {
"type": "string",
"description": "Indicates the parent of the department account officer in the departmental hierarchy."
},
"departmentId": {
"type": "string",
"description": "Department identifier."
},
"acceptMessage": {
"type": "string",
"description": "Indicates whether the account officer will accept secure message."
},
"customerId": {
"type": "string",
"description": "Identifier of the customer"
},
"roundingId": {
"type": "string",
"description": "Contains the identifier of rounding rule."
},
"rounding": {
"type": "string",
"description": "Specifies the type of rounding method to be applied, which can be one of the following: STANDARD - It will round either upwards or downwards whichever is nearer integer, to the required number of decimal places UP - It will round upwards to the required number of decimal places DOWN - It will round downwards to the required number of decimal places"
},
"useMinimumUnit": {
"type": "string",
"description": "Indicates if mimimum amount or lowest unit of currency is to be used for rounding"
},
"preRoundToSixDecimal": {
"type": "string",
"description": "Definition to set if it has to be rounded to 6 decimal places"
},
"numberofDecimal": {
"type": "string",
"description": "Indicates the applicable number of decimal positions for amount calculations and display purposes"
},
"roundingFractions": {
"type": "string",
"description": "Indicates the type of rounding fractions that can be used for rounding"
},
"regions": {
"type": "array",
"description": "Name of the region used for display or enrichment",
"items": {
"id": "urn:jsonschema:regions",
"properties": {
"region": {
"type": "string",
"description": "Name of the region used for display or enrichment"
}
}
}
},
"month01Holidays": {
"type": "string",
"description": "Indicates the holiday dates for january month of calendar year"
},
"month02Holidays": {
"type": "string",
"description": "Indicates the holiday dates for february month of calendar year"
},
"month03Holidays": {
"type": "string",
"description": "Indicates the holiday dates for march month of calendar year"
},
"month04Holidays": {
"type": "string",
"description": "Indicates the holiday dates for april month of calendar year"
},
"month05Holidays": {
"type": "string",
"description": "Indicates the holiday dates for may month of calendar year"
},
"month06Holidays": {
"type": "string",
"description": "Indicates the holiday dates for june month of calendar year"
},
"month07Holidays": {
"type": "string",
"description": "Indicates the holiday dates for july month of calendar year"
},
"month08Holidays": {
"type": "string",
"description": "Indicates the holiday dates for august month of calendar year"
},
"month09Holidays": {
"type": "string",
"description": "Indicates the holiday dates for september month of calendar year"
},
"month10Holidays": {
"type": "string",
"description": "Indicates the holiday dates for october month of calendar year"
},
"month11Holidays": {
"type": "string",
"description": "Indicates the holiday dates for november month of calendar year"
},
"month12Holidays": {
"type": "string",
"description": "Indicates the holiday dates for december month of calendar year"
},
"weekendDays": {
"type": "array",
"description": "Indicates the weekend days for the branch using this holiday record",
"items": {
"id": "urn:jsonschema:weekendDays",
"properties": {
"weekendDay": {
"type": "string",
"description": "Indicates the weekend days for the branch using this holiday record"
}
}
}
},
"month01": {
"type": "string",
"description": "Indicates January month's working days and holidays"
},
"month02": {
"type": "string",
"description": "Indicates February month's working days and holidays"
},
"month03": {
"type": "string",
"description": "Indicates March month's working days and holidays"
},
"month04": {
"type": "string",
"description": "Indicates April month's working days and holidays"
},
"month05": {
"type": "string",
"description": "Indicates May month's working days and holidays"
},
"month06": {
"type": "string",
"description": "Indicates June month's working days and holidays"
},
"month07": {
"type": "string",
"description": "Indicates July month's working days and holidays"
},
"month08": {
"type": "string",
"description": "Indicates August month's working days and holidays"
},
"month09": {
"type": "string",
"description": "Indicates September month's working days and holidays"
},
"month10": {
"type": "string",
"description": "Indicates October month's working days and holidays"
},
"month11": {
"type": "string",
"description": "Indicates November month's working days and holidays"
},
"month12": {
"type": "string",
"description": "Indicates December month's working days and holidays"
},
"transactionNames": {
"type": "array",
"description": "The transaction description",
"items": {
"id": "urn:jsonschema:transactionNames",
"properties": {
"transactionName": {
"type": "string",
"description": "The transaction description"
}
}
}
},
"chequeTransaction": {
"type": "string",
"description": "Indicates whether the transactions using this code requires mandatory cheque number"
},
"chequeIdRequired": {
"type": "string",
"description": "Indicates whether the transactions using this code requires mandatory reference number"
},
"debitCreditIndicator": {
"type": "string",
"description": "Indicator flag which is set whenever a debit or a credit transaction happens in the account"
},
"chargeIds": {
"type": "array",
"description": "This indicates the charge code which will be triggered for payment stop instruction. Applicable when financial institutions would like to charge for stop payment of cheque etc. ",
"items": {
"id": "urn:jsonschema:chargeIds",
"properties": {
"chargeId": {
"type": "string",
"description": "This indicates the charge code which will be triggered for payment stop instruction. Applicable when financial institutions would like to charge for stop payment of cheque etc. "
}
}
}
},
"defaultValueDate": {
"type": "string",
"description": "Indicates that values date to be defaulted during the transactions using this transaction code."
},
"defaultExposureDate": {
"type": "string",
"description": "Indicates if transaction using this code will have exposure date defaulted."
},
"includeInTurnoverCharge": {
"type": "string",
"description": "Indicates whether the transaction using this code are to be included in the calculation of Debit/Credit turnover charges"
},
"swiftNarrative": {
"type": "string",
"description": "Indicates the SWIFT narrative corresponding to the transaction code as per the rules specified in the SWIFT user handbook"
},
"transactionInitiationType": {
"type": "string",
"description": "Defines the initiator type of transaction. Example - bank or customer"
},
"description": {
"type": "string",
"description": "Specifies the description of the parameter record"
},
"narrative": {
"type": "string",
"description": "The additional text printed on descriptive statements in addition to the standard narrative and/or reference"
},
"statementReferenceField": {
"type": "string",
"description": "Defines if reference has to appear as part of statement narrative."
},
"forceDefaultExposureDate": {
"type": "string",
"description": "Indicates that user wants to force in the default exposure date in a financial transaction"
},
"statementNarrativeFormatId": {
"type": "string",
"description": "Identifier of the statement narration format record."
},
"productId": {
"type": "string",
"description": "Contains the unique identifier of the product, e.g. the product id of the arrangement account."
},
"transactionIds": {
"type": "array",
"description": "Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc.",
"items": {
"id": "urn:jsonschema:transactionIds",
"properties": {
"transactionId": {
"type": "string",
"description": "Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."
}
}
}
},
"exposureDateConditionId": {
"type": "string",
"description": "Identifier of the exposure condition record"
},
"chequeTypeId": {
"type": "string",
"description": "Indicates the type of Cheques for which payment stop instruction is effective"
},
"exemptDispoProcessing": {
"type": "string",
"description": "Indicates if the transaction is to be excluded from dispo processing"
},
"transactionType": {
"type": "string",
"description": "Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."
}
}
}
}
}