Reference Data Events Lifecycle Guide
This brief guide describes a sample lifecycle for reference data events, focusing on five scenarios: country-based, IBAN-based, organization-based, product and account-based, and currency-based. While not all the events are explored in this guide, the guide is intended to provide you with information on the most typical lifecycle events for reference data.
Tip: You'll find the event payload information, including code samples, for all the scenarios covered by this guide, beneath the introductions to each scenario and the lifecycle diagrams.
Legend to Lifecycle Diagrams
The following legend applies to all the lifecycle diagrams in this guide.
|
|
The API URL that's used to carry out this business process. |
 |
API request (typically, a command to perform an operation). |
 |
The event type that's emanated. |
 |
Business event emanating after the process is completed by the system. |
 |
Business process in the system. |
 |
Completion of the business process in the system. |
Country-based Scenario
This scenario starts with the creation of a country record. Creating a country group record enables us to determine residence or non-residence when applying charges. The creation of region records allows us to identify where common public holidays differ from other parts of the country. Holiday records allow us to distinguish public holidays, weekdays and weekends for each country, or a specific region within a country.
Country-based Scenario Lifecycle Diagram
Tip: Click diagram to expand.
IBAN-based Scenario
This scenario starts with the creation of a central bank directory, which has BIC and national ID related data. The IBANPLUS contains IBAN-related data for financial institutions to generate or validate the IBAN number. The IBAN structure contains the length of IBAN, along with the position identifiers for bank, branch and BIC codes. The EXCLUSIONLIST contains a list of IBAN NATIONAL IDs that are not allowed in IBANs.
IBAN-based Scenario Lifecycle Diagram
Tip: Click diagram to expand.
Organization-based Scenario
This scenario starts with the creation of an organization structure record, which captures the organization hierarchy of the bank. The organization code record helps to create an organization code at each level defined in the organization structure application. Line Of Business is used to distinguish different cost centres for the bank.
Organization-based Scenario Lifecycle Diagram
Tip: Click diagram to expand.
Product and Account-based Scenario
In this scenario, the category code is linked to a product in account product condition, which are used to classify financial transactions according to the product. Interest basis refers to the methods of calculating interest which are added to interest product conditions while creating a product. A department Account Officer code can be created for each account officer, andlinked to each account while creating a account. Transaction codes are created for each transaction to identify transaction details in an account.
Product and Account-based Scenario Lifecycle Diagram
Tip: Click diagram to expand.
Currency-based Scenario
In this scenario, the rounding rule which is used to define the number of decimals, rounding type, rounding fractions, and so on for the currency. The currency parameter contains salient details about the currency, such as the numeric currency code, the currency name, and the number of decimal places it should be displayed to.
Currency-based Scenario Lifecycle Diagram
Tip: Click diagram to expand.
Country-based Scenario Details
Note: The following sections provide salient details for this scenario, including sample event payloads.
Country Id Creation
The COUNTRY application contains the static details for each individual country, for example, the name of the country and the local currency.
API
The API that's used to create the new country Id.
POST /v1.0.0/reference/countries/{countryId}
Event
The event that's emanated at country Id creation.
createCountry.countryCreated
Event Payload
countryId |
Carries the unique code by which the static country details can be identified. |
currencyIds |
Identifies the local currency code(s) for the country. |
countryNames |
Indicates the country name(s), used for enrichments and reporting purposes. |
geographicalBlock |
The country's geographical block. |
traceDays |
The period of days after which the tracer messages are recycled and resent. |
riskLevel |
Indicates whether this country is considered high risk. |
phoneNumber |
International call prefix, or dial out code, for a specific country. |
countryCode |
3 character country code, for a specific country. |
numericCountryCode |
Numeric country code, for a specific country. |
Note: All the subsequent fields mentioned in
changedAttributesare common to all the tables in the reference data, such as country, category, region, country group, and so on,and are therefore not described.
- Sample Code: Country Id Creation Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "countryId": "dddddddd", " currencyIds ": [ { "currencyId": "DDDDDD" } ],"countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": {}, "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "changedAttributes": [ { { "categoryId": "DDDDDD" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "countryIds": [ { "countryId": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": "ddddddddd", "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "roundingId": "EEEE", "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "regions": [ { "region": "DDDDDD" } ], "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "bbbb", "chequeIdRequired": "CCCCC", "debitCreditIndicator": "DDDDDD", "chargeIds": [ { "chargeId": "DDDDDD" } ], "defaultValueDate": "bbbb", "defaultExposureDate": "CCCCC", "includeInTurnoverCharge": "DDDDDD", "swiftNarrative": "bbbb", "transactionInitiationType": "CCCCC", "description": "DDDDDD", "narrative": "bbbb", "statementReferenceField": "CCCCC", "forceDefaultExposureDate": "DDDDDD", "statementNarrativeFormatId": "bbbb", "productId": "CCCCC", "transactionIds": [ { "transactionId": "DDDDDD" } ], "exposureDateConditionId": "DDDDDD", "chequeTypeId": "bbbb", "exemptDispoProcessing": "CCCCC", "transactionType": "DDDDDD" } } }
Country Modification
API
The API that's used for modifying the country record.
PUT /v1.0.0/reference/countries/{countryId}
Event
The event that's emanated when the country is modified.
modifyCountry.countryModified
Event Payload
Note: The event payload fields are the same as the country creation event. See previous section.
- Sample Code: Country Modification Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "countryId": "dddddddd", "currencyIds": [ { "currencyId": "DDDDDD" } ],"countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": {}, "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "changedAttributes": [ { { "categoryId": "DDDDDD" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "countryIds": [ { "countryId": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": "ddddddddd", "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "roundingId": "EEEE", "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "regions": [ { "region": "DDDDDD" } ], "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "bbbb", "chequeIdRequired": "CCCCC", "debitCreditIndicator": "DDDDDD", "chargeIds": [ { "chargeId": "DDDDDD" } ], "defaultValueDate": "bbbb", "defaultExposureDate": "CCCCC", "includeInTurnoverCharge": "DDDDDD", "swiftNarrative": "bbbb", "transactionInitiationType": "CCCCC", "description": "DDDDDD", "narrative": "bbbb", "statementReferenceField": "CCCCC", "forceDefaultExposureDate": "DDDDDD", "statementNarrativeFormatId": "bbbb", "productId": "CCCCC", "transactionIds": [ { "transactionId": "DDDDDD" } ], "exposureDateConditionId": "DDDDDD", "chequeTypeId": "bbbb", "exemptDispoProcessing": "CCCCC", "transactionType": "DDDDDD" } } }
Country Group Creation
The COUNTRY.GROUP table allows countries to be grouped together for use in determining residence or non-residence when applying charges.
API
The API that's used to create the country group.
POST /v1.0.0/reference/countries/countryGroups/{groupId}
Event
The event that's emanated at country group creation.
createCountryGroup.countryGroupCreated
Event Payload
groupId |
Carries the unique Id of the country group. |
displayNames |
Contains the name used for display or enrichment purposes. |
countryIds |
Carries the Country codes which belong to this country group. |
- Sample Code: Country Group Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "groupId": "dddddddd", "displayNames": [ { " displayName ": "DDDDDD" } ],"countryIds": [ { "countryId": "DDDDDD" } ], "changedAttributes": [ { { "categoryId": "DDDDDD" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "countryIds": [ { "countryId": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": "ddddddddd", "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "roundingId": "EEEE", "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "regions": [ { "region": "DDDDDD" } ], "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "bbbb", "chequeIdRequired": "CCCCC", "debitCreditIndicator": "DDDDDD", "chargeIds": [ { "chargeId": "DDDDDD" } ], "defaultValueDate": "bbbb", "defaultExposureDate": "CCCCC", "includeInTurnoverCharge": "DDDDDD", "swiftNarrative": "bbbb", "transactionInitiationType": "CCCCC", "description": "DDDDDD", "narrative": "bbbb", "statementReferenceField": "CCCCC", "forceDefaultExposureDate": "DDDDDD", "statementNarrativeFormatId": "bbbb", "productId": "CCCCC", "transactionIds": [ { "transactionId": "DDDDDD" } ], "exposureDateConditionId": "DDDDDD", "chequeTypeId": "bbbb", "exemptDispoProcessing": "CCCCC", "transactionType": "DDDDDD" } } }
Country Group Modification
API
The API that's used to modify the country group.
PUT /v1.0.0/reference/countries/{countryId}
Event
The event that's emanated when the country group is modified.
modifyCountryGroup.countryGroupModified
Event Payload
Note: The event payload fields are the same as the country group creation event. See previous section.
- Sample Code: Country Group Modification Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "groupId": "dddddddd", "displayNames": [ { "displayName": "DDDDDD" } ],"countryIds": [ { "countryId": "DDDDDD" } ], "changedAttributes": [ { { "categoryId": "DDDDDD" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "countryIds": [ { "countryId": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": "ddddddddd", "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "roundingId": "EEEE", "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "regions": [ { "region": "DDDDDD" } ], "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "bbbb", "chequeIdRequired": "CCCCC", "debitCreditIndicator": "DDDDDD", "chargeIds": [ { "chargeId": "DDDDDD" } ], "defaultValueDate": "bbbb", "defaultExposureDate": "CCCCC", "includeInTurnoverCharge": "DDDDDD", "swiftNarrative": "bbbb", "transactionInitiationType": "CCCCC", "description": "DDDDDD", "narrative": "bbbb", "statementReferenceField": "CCCCC", "forceDefaultExposureDate": "DDDDDD", "statementNarrativeFormatId": "bbbb", "productId": "CCCCC", "transactionIds": [ { "transactionId": "DDDDDD" } ], "exposureDateConditionId": "DDDDDD", "chequeTypeId": "bbbb", "exemptDispoProcessing": "CCCCC", "transactionType": "DDDDDD" } } }
Delete Country Group
API
The API that's used to delete the country group record.
DELETE /v1.0.0/reference/countries/countryGroups/{groupId}
Event
The event that's emanated at country group deletion.
deleteCountryGroup.countryGroupDeleted
Event Payload
groupId |
Unique Id of the country group record that's deleted. |
- Sample Code: Delete Country Group Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "groupId": "dddddddd", } }
Region Creation
The purpose of this table is to distinguish regions within a country, where the public holidays differ from other parts of the country.
API
The API that's used to create the region record.
POST /v1.0.0/reference/countries/regions/{regionId}
Event
The event that's emanated when the region record is created.
createRegion.regionCreated
Event Payload
- Sample Code: Region Creation Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "regionId": "dddddddd", "regions": [ { "region": "DDDDDD" } ], "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "changedAttributes": [ { { "categoryId": "DDDDDD" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "countryIds": [ { "countryId": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": "ddddddddd", "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "roundingId": "EEEE", "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "regions": [ { "region": "DDDDDD" } ], "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "bbbb", "chequeIdRequired": "CCCCC", "debitCreditIndicator": "DDDDDD", "chargeIds": [ { "chargeId": "DDDDDD" } ], "defaultValueDate": "bbbb", "defaultExposureDate": "CCCCC", "includeInTurnoverCharge": "DDDDDD", "swiftNarrative": "bbbb", "transactionInitiationType": "CCCCC", "description": "DDDDDD", "narrative": "bbbb", "statementReferenceField": "CCCCC", "forceDefaultExposureDate": "DDDDDD", "statementNarrativeFormatId": "bbbb", "productId": "CCCCC", "transactionIds": [ { "transactionId": "DDDDDD" } ], "exposureDateConditionId": "DDDDDD", "chequeTypeId": "bbbb", "exemptDispoProcessing": "CCCCC", "transactionType": "DDDDDD" } } }
Region Modification
API
The API that's used to modify the region record.
PUT /v1.0.0/reference/countries/regions/{regionId}
Event
The event that's emanated at region modification.
modifyRegion.regionModified
Event Payload
- Sample Code: Region Modification Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "regionId": "dddddddd", "regions": [ { "region": "DDDDDD" } ], "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "changedAttributes": [ { { "categoryId": "DDDDDD" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "countryIds": [ { "countryId": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": "ddddddddd", "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "roundingId": "EEEE", "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "regions": [ { "region": "DDDDDD" } ], "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "bbbb", "chequeIdRequired": "CCCCC", "debitCreditIndicator": "DDDDDD", "chargeIds": [ { "chargeId": "DDDDDD" } ], "defaultValueDate": "bbbb", "defaultExposureDate": "CCCCC", "includeInTurnoverCharge": "DDDDDD", "swiftNarrative": "bbbb", "transactionInitiationType": "CCCCC", "description": "DDDDDD", "narrative": "bbbb", "statementReferenceField": "CCCCC", "forceDefaultExposureDate": "DDDDDD", "statementNarrativeFormatId": "bbbb", "productId": "CCCCC", "transactionIds": [ { "transactionId": "DDDDDD" } ], "exposureDateConditionId": "DDDDDD", "chequeTypeId": "bbbb", "exemptDispoProcessing": "CCCCC", "transactionType": "DDDDDD" } } }
Holiday Creation
The purpose of HOLIDAY table is to indicate the public holidays for each country, or region within a country, for the calendar years over which the bank's current business is spread.
API
The API that's used to create the holiday record.
POST /v1.0.0/reference/dates/holidays/{holidayId}
Event
The event that's emanated at holiday record creation.
createHoliday.holidayCreated
Event Payload
holidayId |
Identifies the annual holiday details of the country or region. |
month01Holidays |
Indicates the holiday dates for January month of calendar year. |
weekendDays |
Identifies the non-working weekend days for the country/region. |
month01 |
Shows which days in the month are working days and which are non-working days in January. |
- Sample Code: Holiday Creation Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "holidayId": "EEEE", "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "changedAttributes":{ [ { "categoryId": "DDDDDD" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "countryIds": [ { "countryId": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": "ddddddddd", "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "roundingId": "EEEE", "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "regions": [ { "region": "DDDDDD" } ], "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "bbbb", "chequeIdRequired": "CCCCC", "debitCreditIndicator": "DDDDDD", "chargeIds": [ { "chargeId": "DDDDDD" } ], "defaultValueDate": "bbbb", "defaultExposureDate": "CCCCC", "includeInTurnoverCharge": "DDDDDD", "swiftNarrative": "bbbb", "transactionInitiationType": "CCCCC", "description": "DDDDDD", "narrative": "bbbb", "statementReferenceField": "CCCCC", "forceDefaultExposureDate": "DDDDDD", "statementNarrativeFormatId": "bbbb", "productId": "CCCCC", "transactionIds": [ { "transactionId": "DDDDDD" } ], "exposureDateConditionId": "DDDDDD", "chequeTypeId": "bbbb", "exemptDispoProcessing": "CCCCC", "transactionType": "DDDDDD" } } }
Holiday Modification
API
The API that's used to modidfy the holiday record.
PUT /v1.0.0/reference/dates/holidays/{holidayId}
Event
The event that's emanated at holiday modification.
modifyHoliday.holidayModified
Event Payload
Note: The event payload fields are the same as the country group creation event. See previous section.
- Sample Code: Holiday Modification Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "holidayId": "EEEE", "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "changedAttributes":{ [ { "categoryId": "DDDDDD" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "countryIds": [ { "countryId": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": "ddddddddd", "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "roundingId": "EEEE", "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "regions": [ { "region": "DDDDDD" } ], "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "bbbb", "chequeIdRequired": "CCCCC", "debitCreditIndicator": "DDDDDD", "chargeIds": [ { "chargeId": "DDDDDD" } ], "defaultValueDate": "bbbb", "defaultExposureDate": "CCCCC", "includeInTurnoverCharge": "DDDDDD", "swiftNarrative": "bbbb", "transactionInitiationType": "CCCCC", "description": "DDDDDD", "narrative": "bbbb", "statementReferenceField": "CCCCC", "forceDefaultExposureDate": "DDDDDD", "statementNarrativeFormatId": "bbbb", "productId": "CCCCC", "transactionIds": [ { "transactionId": "DDDDDD" } ], "exposureDateConditionId": "DDDDDD", "chequeTypeId": "bbbb", "exemptDispoProcessing": "CCCCC", "transactionType": "DDDDDD" } } }
IBAN-based Scenario Details
Note: The following sections provide salient details for this scenario, including sample event payloads.
Central Bank Directory Record Creation
The RD.CENTRAL.BANK.DIR file contains the BIC and national Id related data for the financial institutions.
API
The API that's used to create the central bank directory record.
POST /v1.0.0/reference/bankCodes/centralBankDirectories
Event
The event that's emanated at central bank directory record creation.
createRdCentralBankDir.rdCentralBankDirCreated
Event Payload
centralBankDirectoryId |
Carries the ID of the central bank directory record. |
recordStatus |
Specifies the status of the record. |
beneficiaryInstituteNames |
Indicates the name of financial institution where the beneficiary account is held. |
beneficiaryInstituteCity |
Indicates the City of financial institution where the beneficiary account is held. |
beneficiaryInstituteBranchNames |
Indicates the branch name of the financial institution where the beneficiary account is held. |
- Sample Code: Central Bank Directory Record Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "centralBankDirectoryId": "bbbb", "recordStatus": "DDDDDD", "resourceId": "CCCCC", "beneficiaryInstituteNames": [ { "beneficiaryInstituteName": "DDDDDD" } ], "beneficiaryInstituteCity": "CCCCC", "beneficiaryInstituteBranchNames": [ { "beneficiaryInstituteBranchName": "DDDDDD" } ], "branch": "bbbbbbb", "bicbranchCode": "BBBBB", "bicId": "cccccc", "routingBiccode": "ee", "parentBicCode": "cc", "countryId": "bbbbbbbb", "nationalId": "cccccc", "nationalIdtype": "DDDDDDDDD", "chipsuid": "ffffff", "subtypeInd": "ccccccccc", "serviceCodes": [ { "serviceCode": "DDDDDD" } ], "branchQualifier": "eee", "addresses": [ { "address": "DDDDDD" } ], "postCode": "eee", "bicLocations": [ { "bicLocation": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "postBoxNumber": "bbbbbbb", "validFrom": "BBBBB", "officeType": "cccccc", "parentOfficeKey": "ee", "headOfficeKey": "cc", "legalType": "bbbbbbbb", "legalParentKey": "cccccc", "groupType": "DDDDDDDDD", "institutionStatus": 1, "cooperativeGroupKey": "ccccccccc", "bankLegalEntityIdentifier": "eee", "timeZone": "ccc", "networkConnection": "cccccc", "groupId": "DDDDDDDDD", "ssiRecordKey": 1, "uploadType": "ccccccccc", "bicUploadLocation": "eee", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "status": "ccc", "changedAttributes": { "recordStatus": "DDDDDD", "resourceId": "CCCCC", "beneficiaryInstituteNames": [ { "beneficiaryInstituteName": "DDDDDD" } ], "beneficiaryInstituteCity": "CCCCC", "beneficiaryInstituteBranchNames": [ { "beneficiaryInstituteBranchName": "DDDDDD" } ], "beneficiaryInstituteCity": "CCCCC", "beneficiaryInstituteBranchNames": [ { "beneficiaryInstituteBranchName": "DDDDDD" } ], "branch": "bbbbbbb", "bicbranchCode": "BBBBB", "bicId": "cccccc", "routingBiccode": "ee", "parentBicCode": "cc", "countryId": "bbbbbbbb", "nationalId": "cccccc", "nationalIdtype": "DDDDDDDDD", "chipsuid": "ffffff", "subtypeInd": "ccccccccc", "serviceCodes": [ { "serviceCode": "DDDDDD" } ], "branchQualifier": "eee", "addresses": [ { "address": "DDDDDD" } ], "postCode": "eee", "bicLocations": [ { "bicLocation": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "postBoxNumber": "bbbbbbb", "validFrom": "BBBBB", "officeType": "cccccc", "parentOfficeKey": "ee", "headOfficeKey": "cc", "legalType": "bbbbbbbb", "legalParentKey": "cccccc", "groupType": "DDDDDDDDD", "institutionStatus": 1, "cooperativeGroupKey": "ccccccccc", "bankLegalEntityIdentifier": "eee", "timeZone": "ccc", "networkConnection": "cccccc", "groupId": "DDDDDDDDD", "ssiRecordKey": 1, "uploadType": "ccccccccc", "bicUploadLocation": "eee", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "status": "ccc" } } }
Central Bank Directory Record Modification
API
The API that's used for modifying the Central Bank Directory record.
PUT /v1.0.0/reference/bankCodes/centralBankDirectories/{centralBankDirectoryId}
Event
The event that's emanated at Central Bank Directory record modification.
modifyRdCentralBankDir.rdCentralBankDirModified
Event Payload
Note: The event payload fields are the same as the Central Bank Directory record creation event. See previous section.
- Sample Code: Central Bank Directory Record Modification Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "centralBankDirectoryId": "bbbb", "recordStatus": "DDDDDD", "resourceId": "CCCCC", "beneficiaryInstituteNames": [ { "beneficiaryInstituteName": "DDDDDD" } ], "beneficiaryInstituteCity": "CCCCC", "beneficiaryInstituteBranchNames": [ { "beneficiaryInstituteBranchName": "DDDDDD" } ], "branch": "bbbbbbb", "bicbranchCode": "BBBBB", "bicId": "cccccc", "routingBiccode": "ee", "parentBicCode": "cc", "countryId": "bbbbbbbb", "nationalId": "cccccc", "nationalIdtype": "DDDDDDDDD", "chipsuid": "ffffff", "subtypeInd": "ccccccccc", "serviceCodes": [ { "serviceCode": "DDDDDD" } ], "branchQualifier": "eee", "addresses": [ { "address": "DDDDDD" } ], "postCode": "eee", "bicLocations": [ { "bicLocation": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "postBoxNumber": "bbbbbbb", "validFrom": "BBBBB", "officeType": "cccccc", "parentOfficeKey": "ee", "headOfficeKey": "cc", "legalType": "bbbbbbbb", "legalParentKey": "cccccc", "groupType": "DDDDDDDDD", "institutionStatus": 1, "cooperativeGroupKey": "ccccccccc", "bankLegalEntityIdentifier": "eee", "timeZone": "ccc", "networkConnection": "cccccc", "groupId": "DDDDDDDDD", "ssiRecordKey": 1, "uploadType": "ccccccccc", "bicUploadLocation": "eee", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "status": "ccc", "changedAttributes": { "recordStatus": "DDDDDD", "resourceId": "CCCCC", "beneficiaryInstituteNames": [ { "beneficiaryInstituteName": "DDDDDD" } ], "beneficiaryInstituteCity": "CCCCC", "beneficiaryInstituteBranchNames": [ { "beneficiaryInstituteBranchName": "DDDDDD" } ], "beneficiaryInstituteCity": "CCCCC", "beneficiaryInstituteBranchNames": [ { "beneficiaryInstituteBranchName": "DDDDDD" } ], "branch": "bbbbbbb", "bicbranchCode": "BBBBB", "bicId": "cccccc", "routingBiccode": "ee", "parentBicCode": "cc", "countryId": "bbbbbbbb", "nationalId": "cccccc", "nationalIdtype": "DDDDDDDDD", "chipsuid": "ffffff", "subtypeInd": "ccccccccc", "serviceCodes": [ { "serviceCode": "DDDDDD" } ], "branchQualifier": "eee", "addresses": [ { "address": "DDDDDD" } ], "postCode": "eee", "bicLocations": [ { "bicLocation": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "postBoxNumber": "bbbbbbb", "validFrom": "BBBBB", "officeType": "cccccc", "parentOfficeKey": "ee", "headOfficeKey": "cc", "legalType": "bbbbbbbb", "legalParentKey": "cccccc", "groupType": "DDDDDDDDD", "institutionStatus": 1, "cooperativeGroupKey": "ccccccccc", "bankLegalEntityIdentifier": "eee", "timeZone": "ccc", "networkConnection": "cccccc", "groupId": "DDDDDDDDD", "ssiRecordKey": 1, "uploadType": "ccccccccc", "bicUploadLocation": "eee", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "status": "ccc" } } }
IBAN Plus Record Creation
API
The API that's used to create an IBAN plus record.
POST /v1.0.0/reference/bankCodes/ibans/ibanPlusDirectories
Event
The event that's emanated at IBAN plus record creation.
createInIbanPlus.inIbanPlusCreated
Event Payload
ibanPlusDirectoryId |
Carries the unique id of the IBAN plus directory. |
countryId |
Specifies the Residence Country Name of the financial institution that issued the IBAN. |
countryCode |
Specifies the country code of the IBANs that the institution issued. |
ibanBic |
Specifies the BIC code issued together with the IBANs to the institution's clients. |
routingBiccode |
Indicates the routing number of BIC code used to identify the financial institution. |
ibanNationalId |
Specifies the National ID that is included in the IBAN. |
- Sample Code: IBAN Plus Event Creation Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "ibanPlusDirectoryId": "EEEE", "countryId": "bbbb", "countryCode": "bbbb", "ibanBic": "DDDDDD", "routingBiccode": "EEEE", "ibanNationalId": "aaaa", "modificationDetail": "bbbb", "status": "bbbb", "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "changedAttributes": { "countryId": "DDDDDD" "countryCode": "CCCCC", "ibanBic": "DDDDDD", "routingBiccode": "EEEE", "ibanNationalId": "aaaa", "modificationDetail": "bbbb", "bicId": "CCCCC", "validFrom": "DDDDDD", "status": "EEEE", "countryCodePosition": "aaaa", "countryCodeLength": "bbbb", "checkDigitsPosition": "CCCCC", "checkDigitsLength": "DDDDDD", "bankIdentifierPosition": "EEEE", "bankIdentifierLength": "aaaa", "branchIdentifierPosition": "bbbb", "branchIdentifierLength": "CCCCC", "accountNumberPosition": "EEEE", "accountNumberLength": "aaaa", "totalLength": "bbbb", "bankIdApplication": "CCCCC", "bankIdField": "DDDDDD", "branchIdApplication": "EEEE", "branchIdField": "aaaa", "accountNumberApplication": "bbbb", "accountNumberField": "CCCCC", "sepa": "CCCC", "optionalCommenceDate": "BBBBB", "mandatoryCommenceDate": "", "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ] } } }
IBAN Plus Record Modification
API
The API that's used to modify the IBAN Plus record.
PUT /v1.0.0/reference/bankCodes/ibans/ibanPlusDirectories/{ibanPlusDirectoryId}
Event
The event that's emanated at IBAN Plus record creation.
modifyInIbanPlus.inIbanPlusModified
Event Payload
Note: The event payload fields are the same as the IBAN Plus record creation event. See previous section.
- Sample Code: IBAN Pluse Modification Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "ibanPlusDirectoryId": "EEEE", "countryId": "bbbb", "countryCode": "bbbb", "ibanBic": "DDDDDD", "routingBiccode": "EEEE", "ibanNationalId": "aaaa", "modificationDetail": "bbbb", "status": "bbbb", "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "changedAttributes": { "countryId": "DDDDDD" "countryCode": "CCCCC", "ibanBic": "DDDDDD", "routingBiccode": "EEEE", "ibanNationalId": "aaaa", "modificationDetail": "bbbb", "bicId": "CCCCC", "validFrom": "DDDDDD", "status": "EEEE", "countryCodePosition": "aaaa", "countryCodeLength": "bbbb", "checkDigitsPosition": "CCCCC", "checkDigitsLength": "DDDDDD", "bankIdentifierPosition": "EEEE", "bankIdentifierLength": "aaaa", "branchIdentifierPosition": "bbbb", "branchIdentifierLength": "CCCCC", "accountNumberPosition": "EEEE", "accountNumberLength": "aaaa", "totalLength": "bbbb", "bankIdApplication": "CCCCC", "bankIdField": "DDDDDD", "branchIdApplication": "EEEE", "branchIdField": "aaaa", "accountNumberApplication": "bbbb", "accountNumberField": "CCCCC", "sepa": "CCCC", "optionalCommenceDate": "BBBBB", "mandatoryCommenceDate": "", "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ] } } }
IBAN Structure Creation
The IN.IBAN.STRUCTURE records contain the IBAN structure (IS files) information downloaded from SWIFT. This application holds the information such as length of IBAN along with the position identifiers for bank, branch and BIC codes.
API
The API that's used to create the IBAN structure record.
POST /v1.0.0/reference/bankCodes/countries/{countryId}/ibanStructures
Event
The event that's emanated at IBAN structure record creation.
createInIbanStructure.inIbanStructureCreated
Event Payload
countryCodePosition |
Specifies the start position of country code in IBAN. |
countryCodeLength |
Specifies the number of characters of country code in IBAN. |
checkDigitsPosition |
Specifies the start position of check digit in IBAN. |
checkDigitsLength |
Specifies the number of check digits in IBAN. |
bankIdentifierPosition |
Specifies the start position of Bank identifier in IBAN. |
branchIdentifierLength |
Specifies the number of characters of branch identifier in IBAN. |
accountNumberPosition |
Specifies the start position of domestic account number in IBAN. |
accountNumberField |
Specifies the field from where account number can be fetched to build IBAN. |
sepa |
Indicates whether the IBAN is used in one of the SEPA schemes. |
- Sample Code: IBAN Structure Creation Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "countryId": "bbbb", "countryCode": "bbbb", "countryCodePosition": "aaaa", "countryCodeLength": "bbbb", " checkDigitsPosition ": "CCCCC", "checkDigitsLength": "DDDDDD", "bankIdentifierPosition": "EEEE", "bankIdentifierLength": "aaaa", "branchIdentifierPosition": "bbbb", "branchIdentifierLength": "CCCCC", "accountNumberPosition": "EEEE", "accountNumberLength": "aaaa", "totalLength": "bbbb", "bankIdApplication": "CCCCC", "bankIdField": "DDDDDD", "branchIdApplication": "EEEE", "branchIdField": "aaaa", "accountNumberApplication": "bbbb", "accountNumberField": "CCCCC", "sepa": "CCCC", "optionalCommenceDate": "BBBBB", "mandatoryCommenceDate": "", "changedAttributes": { "countryId": "DDDDDD", "countryCode": "CCCCC", "ibanBic": "DDDDDD", "routingBiccode": "EEEE", "ibanNationalId": "aaaa", "modificationDetail": "bbbb", "bicId": "CCCCC", "validFrom": "DDDDDD", "status": "EEEE", "countryCodePosition": "aaaa", "countryCodeLength": "bbbb", "checkDigitsPosition": "CCCCC", "checkDigitsLength": "DDDDDD", "bankIdentifierPosition": "EEEE", "bankIdentifierLength": "aaaa", "branchIdentifierPosition": "bbbb", "branchIdentifierLength": "CCCCC", "accountNumberPosition": "EEEE", "accountNumberLength": "aaaa", "totalLength": "bbbb", "bankIdApplication": "CCCCC", "bankIdField": "DDDDDD", "branchIdApplication": "EEEE", "branchIdField": "aaaa", "accountNumberApplication": "bbbb", "accountNumberField": "CCCCC", "sepa": "CCCC", "optionalCommenceDate": "BBBBB", "mandatoryCommenceDate": "", "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ] } } }
IBAN Structure Modification
API
The API that's used to modify the IBAN structure.
PUT /v1.0.0/reference/bankCodes/countries/{countryId}/ibanStructures
Event
The event that's emanated at IBAN structure modification.
modifyInIbanStructure.inIbanStructureModified
Event Payload
Note: The event payload fields are the same as the IBAN structure record creation event. See previous section.
- Sample Code: IBAN Structure Modification Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "countryId": "bbbb", "countryCode": "bbbb", "countryCodePosition": "aaaa", "countryCodeLength": "bbbb", "checkDigitsPosition": "CCCCC", "checkDigitsLength": "DDDDDD", "bankIdentifierPosition": "EEEE", "bankIdentifierLength": "aaaa", "branchIdentifierPosition": "bbbb", "branchIdentifierLength": "CCCCC", "accountNumberPosition": "EEEE", "accountNumberLength": "aaaa", "totalLength": "bbbb", "bankIdApplication": "CCCCC", "bankIdField": "DDDDDD", "branchIdApplication": "EEEE", "branchIdField": "aaaa", "accountNumberApplication": "bbbb", "accountNumberField": "CCCCC", "sepa": "CCCC", "optionalCommenceDate": "BBBBB", "mandatoryCommenceDate": "", "changedAttributes": { "countryId": "DDDDDD", "countryCode": "CCCCC", "ibanBic": "DDDDDD", "routingBiccode": "EEEE", "ibanNationalId": "aaaa", "modificationDetail": "bbbb", "bicId": "CCCCC", "validFrom": "DDDDDD", "status": "EEEE", "countryCodePosition": "aaaa", "countryCodeLength": "bbbb", "checkDigitsPosition": "CCCCC", "checkDigitsLength": "DDDDDD", "bankIdentifierPosition": "EEEE", "bankIdentifierLength": "aaaa", "branchIdentifierPosition": "bbbb", "branchIdentifierLength": "CCCCC", "accountNumberPosition": "EEEE", "accountNumberLength": "aaaa", "totalLength": "bbbb", "bankIdApplication": "CCCCC", "bankIdField": "DDDDDD", "branchIdApplication": "EEEE", "branchIdField": "aaaa", "accountNumberApplication": "bbbb", "accountNumberField": "CCCCC", "sepa": "CCCC", "optionalCommenceDate": "BBBBB", "mandatoryCommenceDate": "", "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ] } } }
IBAN Structure Deletion
API
The API that's used to delete the IBAN structure.
DELETE /v1.0.0/reference/bankCodes/countries/{countryId}/ibanStructures
Event
The event that's emanated at IBAN structure deletion.
deleteInIbanStructure.inIbanStructureDeleted
Event Payload
countryId |
Indicates the country Id for which the IBAN structure record deleted. |
- Sample Code: IBAN Structure Deletion Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { ""countryId": ": "dddddddd", } }
InExclusion List Creation
The IN.EXCLUSION.LIST table contains a list of IBAN NATIONAL IDs that are not allowed in IBANs.
API
The API that's used to create the InExclusion list record.
POST /v1.0.0/reference/bankCodes/ibans/ibanExclusionLists
Event
The event that's emanated at InExclusion list record creation.
createInExclusionList.inExclusionListCreated
Event Payload
ibanExclusionListId |
Contains a list of IBAN national ids that are not allowed in IBANs. |
countryCode |
Country code of the invalid National Id. |
bicId |
Carries the BIC of the financial institution that holds this National Id. |
validFrom |
The future date from which the IBAN National Id will be invalid. |
status |
Captures the status of the Exclusion List record. |
excludedCompanies |
BIC code is available for all the companies, but not for the one being excluded. |
allowedCompanies |
Indicates that the BIC code is available only for those companies. |
modificationDetail |
Indicates whether there is a change in the record, since the last release of the IBAN structure file. |
- Sample Code: InExclusion List Creation Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "ibanExclusionListId": "EEEE", " countryCode ": "bbbb", "ibanNationalId": "bbbb", "bicId": "bbbb", "validFrom": "bbbb", "status": "bbbb", "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], " allowedCompanies ": [ { "allowedCompany": "DDDDDD" } ], "modificationDetail": "bbbb", "changedAttributes": { "countryId": "DDDDDD" "countryCode": "CCCCC", "ibanBic": "DDDDDD", "routingBiccode": "EEEE", "ibanNationalId": "aaaa", "modificationDetail": "bbbb", "bicId": "CCCCC", "validFrom": "DDDDDD", "status": "EEEE", "countryCodePosition": "aaaa", "countryCodeLength": "bbbb", "checkDigitsPosition": "CCCCC", "checkDigitsLength": "DDDDDD", "bankIdentifierPosition": "EEEE", "bankIdentifierLength": "aaaa", "branchIdentifierPosition": "bbbb", "branchIdentifierLength": "CCCCC", "accountNumberPosition": "EEEE", "accountNumberLength": "aaaa", "totalLength": "bbbb", "bankIdApplication": "CCCCC", "bankIdField": "DDDDDD", "branchIdApplication": "EEEE", "branchIdField": "aaaa", "accountNumberApplication": "bbbb", "accountNumberField": "CCCCC", "sepa": "CCCC", "optionalCommenceDate": "BBBBB", "mandatoryCommenceDate": "", "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ] } } }
InExclusion List Modification
API
The API that's used to modify the InExclusion list record.
PUT /v1.0.0/reference/bankCodes/ibans/ibanExclusionLists/{ibanExclusionListId}
Event
The event that's emanated at InExclusion list record modification.
modifyInExclusionList.inExclusionListModified
Event Payload
Note: The event payload fields are the same as the InExclusion List creation event. See previous section.
- Sample Code: InExclusion List Creation Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "ibanExclusionListId": "EEEE", "countryCode": "bbbb", "ibanNationalId": "bbbb", "bicId": "bbbb", "validFrom": "bbbb", "status": "bbbb", "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "modificationDetail": "bbbb", "changedAttributes": { "countryId": "DDDDDD" "countryCode": "CCCCC", "ibanBic": "DDDDDD", "routingBiccode": "EEEE", "ibanNationalId": "aaaa", "modificationDetail": "bbbb", "bicId": "CCCCC", "validFrom": "DDDDDD", "status": "EEEE", "countryCodePosition": "aaaa", "countryCodeLength": "bbbb", "checkDigitsPosition": "CCCCC", "checkDigitsLength": "DDDDDD", "bankIdentifierPosition": "EEEE", "bankIdentifierLength": "aaaa", "branchIdentifierPosition": "bbbb", "branchIdentifierLength": "CCCCC", "accountNumberPosition": "EEEE", "accountNumberLength": "aaaa", "totalLength": "bbbb", "bankIdApplication": "CCCCC", "bankIdField": "DDDDDD", "branchIdApplication": "EEEE", "branchIdField": "aaaa", "accountNumberApplication": "bbbb", "accountNumberField": "CCCCC", "sepa": "CCCC", "optionalCommenceDate": "BBBBB", "mandatoryCommenceDate": "", "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ] } } }
Organization-based Scenario Details
Organization Code Record Creation
The ST.ORGANIZATION.CODE table contains the definition of each element in the organization, along with its hierarchy details.
API
The API that's used to create the StOrganizationCode record.
POST/V1.0.0/reference/organizationStructures/{organizationId}
Event
The event that's emanated at StOrganizationCode record creation.
createStOrganizationCode.stOrganizationCodeCreated
Event Payload
|
Indicates the organization code. |
|
Indicates the name of the organization. |
|
Indicates the parent organization code. |
|
Defines the organization level of the code. The organization level determines the default value of the code. |
- Sample Code: Organization Code Creation Event Payload
-
>
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "organizationCode": "dddddddd", "organizationNames": [ { "organizationName": "DDDDDD" } ], "organizationParent": "DDDDDD", "organizationLevel":"DDDD", "changedAttributes": { "lineOfBusinessNames": [ { "lineOfBusinessName": "DDDDDD" } ], "organizationNames": [ { "organizationName": "DDDDDD" } ], "organizationParent": "CCCCCC", "organizationLevel": "eeeeee", "organizationLevels": [ { "organizationLevel": "DDDDDD", "characterType": "DDDDDD", "length": "DDDDD", "checkFile": "DDDDD" } ] } }
Organization Code Record Modification
API
The API that's used to modify the StOrganizationCode record.
PUT /v1.0.0/reference/organizationStructures/{organizationId}
Event
The event that's emanated at StOrganizationCode record modification.
modifyStOrganizationCode.stOrganizationCodeModified
Event Payload
Note: The event payload fields are the same as the organization code creation event. See previous section.
- Sample Code: Organization Code Modification Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "organizationCode": "dddddddd", "organizationNames": [ { "organizationName": "DDDDDD" } ], "organizationParent": "DDDDDD", "organizationLevel":"DDDD", "changedAttributes": { "lineOfBusinessNames": [ { "lineOfBusinessName": "DDDDDD" } ], "organizationNames": [ { "organizationName": "DDDDDD" } ], "organizationParent": "CCCCCC", "organizationLevel": "eeeeee", "organizationLevels": [ { "organizationLevel": "DDDDDD", "characterType": "DDDDDD", "length": "DDDDD", "checkFile": "DDDDD" } ] } }
Organization Structure Creation
The ST.ORGANIZATION.STRUCTURE stores the hierarchy of the bank's organization. For example, Bank, Region, Market ,Area and Branch.
API
The API that's used to create the StOrganizationStructure record.
PUT /v1.2.0/reference/organizationStructures/branches/{branchId}
Event
The event that's emanated at StOrganizationStructure record creation.
modifyStOrganizationStructure.stOrganizationStructureModified
Event Payload
|
Indicates the organization hierarchy. The allowed value is |
|
Specifies the organizational levels in their hierarchical order. |
|
Indicates the character type, such as |
|
Specifies the length of the organization code Id. |
|
Contains a valid application to be used as the checkfile for the organization code Id. |
- Sample Code: Organization Structure Creation Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "hierarchyId": "dddddddd", "organizationLevels": [ { "organizationLevel": "DDDDDD", "characterType": "DDDDDD", "length": "eeeeee", "checkFile": "ddddd" } ], "changedAttributes": { "lineOfBusinessNames": [ { "lineOfBusinessName": "DDDDDD" } ], "organizationNames": [ { "organizationName": "DDDDDD" } ], "organizationParent": "CCCCCC", "organizationLevel": "eeeeee", "organizationLevels": [ { "organizationLevel": "DDDDDD", "characterType": "DDDDDD", "length": "DDDDD", "checkFile": "DDDDD" } ] } }
Line of Business Creation
The table ST.LINE.OF.BUSINESS defines the distinct business lines or cost centres within the bank organisation.
API
The API that's used to create the StLineOfBusiness record.
POST /v1.0.0/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}
Event
The event that's emanated at StLineOfBusiness record creation.
createStLineOfBusiness.stLineOfBusinessCreated
Event Payload
|
Carries the Id of the line of business provided by the branch. |
|
Specifies the name of the line of business that is defined to represent the cost centre of an organization hierarchy. |
- Sample Code: Line Of Business Creation Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "lineOfBusinessId": "dddddddd", "lineOfBusinessNames": [ { "lineOfBusinessName": "DDDDDD" } ], "changedAttributes": { "lineOfBusinessNames": [ { "lineOfBusinessName": "DDDDDD" } ], "organizationNames": [ { "organizationName": "DDDDDD" } ], "organizationParent": "CCCCCC", "organizationLevel": "eeeeee", "organizationLevels": [ { "organizationLevel": "DDDDDD", "characterType": "DDDDDD", "length": "DDDDD", "checkFile": "DDDDD" } ] } }
Line of Business Modification
API
The API that's used to modify the StLineOfBusiness record.
PUT /v1.0.0/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}
Event
The event that's emanated at StLineOfBusiness record modification.
modifyStLineOfBusiness.stLineOfBusinessModified
Event Payload
Note: The event payload fields are the same as the Line of Business creation event. See previous section.
- Sample Code: Line Of Business Modification Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "lineOfBusinessId": "dddddddd", "lineOfBusinessNames": [ { "lineOfBusinessName": "DDDDDD" } ], "changedAttributes": { "lineOfBusinessNames": [ { "lineOfBusinessName": "DDDDDD" } ], "organizationNames": [ { "organizationName": "DDDDDD" } ], "organizationParent": "CCCCCC", "organizationLevel": "eeeeee", "organizationLevels": [ { "organizationLevel": "DDDDDD", "characterType": "DDDDDD", "length": "DDDDD", "checkFile": "DDDDD" } ] } }
Product and Account-based Scenario
Category Code Creation
The purpose of CATEGORY codes is to classify financial transactions, and to consolidate balances for reporting purposes.
API
The API that's used to create the new category Id.
POST /v1.0.0/reference/categories/{categoryId}
Event
The event that's emanated at category Id creation.
createCategory.categoryCreated
Event Payload
|
Carries the unique code by which category details can be identified. |
|
Contains the name used for display or enrichment purposes. |
|
Carries the name that is displayed for the product category. |
|
Identifies the system to which the category code belongs. |
|
Specifies an alternative means of referencing the category. |
|
Defines how the balance type should be used with respect to reporting. |
|
This must be set for consolidating entries raised for PL category. |
|
The position that accounts related to the category. |
- Sample Code: Category Code Creation Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "categoryId": "dddddddd", " displayNames ": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "changedAttributes": { [ { "categoryId": "DDDDDD" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "countryIds": [ { "countryId": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": "ddddddddd", "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "roundingId": "EEEE", "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "regions": [ { "region": "DDDDDD" } ], "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "bbbb", "chequeIdRequired": "CCCCC", "debitCreditIndicator": "DDDDDD", "chargeIds": [ { "chargeId": "DDDDDD" } ], "defaultValueDate": "bbbb", "defaultExposureDate": "CCCCC", "includeInTurnoverCharge": "DDDDDD", "swiftNarrative": "bbbb", "transactionInitiationType": "CCCCC", "description": "DDDDDD", "narrative": "bbbb", "statementReferenceField": "CCCCC", "forceDefaultExposureDate": "DDDDDD", "statementNarrativeFormatId": "bbbb", "productId": "CCCCC", "transactionIds": [ { "transactionId": "DDDDDD" } ], "exposureDateConditionId": "DDDDDD", "chequeTypeId": "bbbb", "exemptDispoProcessing": "CCCCC", "transactionType": "DDDDDD" } } }
Category Code Modification
API
The API that's used to modify the category Id.
PUT /v1.0.0/reference/categories/{categoryId}
>Event
The event that's emanated at category Id modification.
modifyCategory.categoryModified
Event Payload
Note: The event payload fields are the same as the Line of Business creation event. See previous section.
- Sample Code: Category Code Modification Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "categoryId": "dddddddd", " displayNames ": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "changedAttributes": { [ { "categoryId": "DDDDDD" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "countryIds": [ { "countryId": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": "ddddddddd", "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "roundingId": "EEEE", "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "regions": [ { "region": "DDDDDD" } ], "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "bbbb", "chequeIdRequired": "CCCCC", "debitCreditIndicator": "DDDDDD", "chargeIds": [ { "chargeId": "DDDDDD" } ], "defaultValueDate": "bbbb", "defaultExposureDate": "CCCCC", "includeInTurnoverCharge": "DDDDDD", "swiftNarrative": "bbbb", "transactionInitiationType": "CCCCC", "description": "DDDDDD", "narrative": "bbbb", "statementReferenceField": "CCCCC", "forceDefaultExposureDate": "DDDDDD", "statementNarrativeFormatId": "bbbb", "productId": "CCCCC", "transactionIds": [ { "transactionId": "DDDDDD" } ], "exposureDateConditionId": "DDDDDD", "chequeTypeId": "bbbb", "exemptDispoProcessing": "CCCCC", "transactionType": "DDDDDD" } } }
Interest Basis Creation
Interest basis refers to the methods of calculating interest.
API
The API that's used to create interest basis.
POST /v1.0.0/reference/interestBases/{interestBasisId}Event
The event that's emanated at interest basis creation.
createInterestBasis.interestBasisCreated
Event Payload
|
Carries the Id for the interest basis. |
|
Specifies the description of the interest basis. |
- Sample Code: Interest Basis Creation Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "interestBasisId": "bbbb", "interestBasisNames": [ { "interestBasisName": "DDDDDD" } ], "interestBasis": "bbbb", "changedAttributes": { "interestBasisNames": [ { "interestBasisName": "DDDDDD" } ], "interestBasis": "DDDDDD", "interestRate": "CCCCC", "negativeInterestRate": "DDDDDD", "rateNames": [ { "rateName": "DDDDDD" } ], "defaultMisRateId": "EEEE", "interestCondition": { "period": "DDDDDD", "rateDate": "DDDDDD", "daysSinceStart": "EEEE", "rates": [ { "bandAmount": "DDDDDD", "bidRate": "DDDDDD", "offerRate": "DDDDDD" } ], "buildForwardRate": "aaaa", "tolerancePercentage": "bbbb", "maximumInterestRate": "aaaa", "spreadCalcuationRoutines": [ { "spreadCalcuationRoutine": "DDDDDD" } ], "useLastWorkingDay": "bbbb", "negativeRateApplicationIds": [ { "negativeRateApplicationId": "DDDDDD" } ], "historyDetails": [ { "historyCompanyId": "DDDDDD", "historyNumbers": [ { "historyNumbers": "DDDDDD", "historyCompanyId": "DDDDDD" } ] } ], "versionNumber": "CCCCC", "riskFreeRate": "DDDDDD", "receivedDate": "EEEE", "displayNames": [ { "displayName": "DDDDDD" } ], "rateTextName": "aaaa", "rateKey": "bbbb", "swiftCodeWord": "CCCCC" } } } }
Interest Basis Modification
API
The API that's used to modify interest basis.
PUT /v1.0.0/reference/interestBases/{interestBasisId}
Event
The event that's emanated at interest basis modification.
modifyInterestBasis.interestBasisModifiedEvent Payload
Note: The event payload fields are the same as the interest basis creation event. See previous section.
- Sample Code: Interest Basis Modification Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "interestBasisId": "bbbb", "interestBasisNames": [ { "interestBasisName": "DDDDDD" } ], "interestBasis": "bbbb", "changedAttributes": { "interestBasisNames": [ { "interestBasisName": "DDDDDD" } ], "interestBasis": "DDDDDD", "interestRate": "CCCCC", "negativeInterestRate": "DDDDDD", "rateNames": [ { "rateName": "DDDDDD" } ], "defaultMisRateId": "EEEE", "interestCondition": { "period": "DDDDDD", "rateDate": "DDDDDD", "daysSinceStart": "EEEE", "rates": [ { "bandAmount": "DDDDDD", "bidRate": "DDDDDD", "offerRate": "DDDDDD" } ], "buildForwardRate": "aaaa", "tolerancePercentage": "bbbb", "maximumInterestRate": "aaaa", "spreadCalcuationRoutines": [ { "spreadCalcuationRoutine": "DDDDDD" } ], "useLastWorkingDay": "bbbb", "negativeRateApplicationIds": [ { "negativeRateApplicationId": "DDDDDD" } ], "historyDetails": [ { "historyCompanyId": "DDDDDD", "historyNumbers": [ { "historyNumbers": "DDDDDD", "historyCompanyId": "DDDDDD" } ] } ], "versionNumber": "CCCCC", "riskFreeRate": "DDDDDD", "receivedDate": "EEEE", "displayNames": [ { "displayName": "DDDDDD" } ], "rateTextName": "aaaa", "rateKey": "bbbb", "swiftCodeWord": "CCCCC" } } } }
Interest Basis Deletion
API
The API that's used to delete interest basis.
DELETE /v1.0.0/reference/interestBases/{interestBasisId}
Event
The event that's emanated at interest basis deletion.
deleteInterestBasis.interestBasisDeleted
Event Payload
interestBasisId |
Carries the Id for the interest basis. |
- Sample Code: Interest Basis Deletion Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "interestBasisId": ": "dddddddd", } }
Department Account Officer Creation
The purpose of the DEPT.ACCT.OFFICER table is to identify each Department and Account Officer in the bank.
API
The API that's used to create a new account officer.
POST /v1.0.0/reference/accountOfficers/{accountOfficerId}
Event
The event that's emanated at account officer creation.
createDeptAcctOfficer.deptAcctOfficerCreated
Event Payload
accountOfficer |
Contains the Id of the |
accountOfficerArea |
Free format description of the area of responsibility for the account officer. |
accountOfficerName |
Indicates the name of the account officer. |
addressLocation |
Identifies the nature of the postal address. |
phoneNumber |
Free format field for the entry of an account officers phone number. |
faxId |
Free format field for the entry of an account officer's fax number. |
departmentLevel |
Indicates the level of this department within the departmental hierarchy. |
departmentParent |
Indicates the line manager of the department account officer in the departmental hierarchy. |
mnemonic |
Specifies an alternative method of referencing the Department Account Officer. |
departmentId |
Identifies the department. |
acceptMessage |
Specifies whether this account officer will accept secure messages. |
- Sample Code: Account Officer Creation Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "phoneNumber": "DDDDDD", "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "mnemonic": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "changedAttributes": [ { { "categoryId": "DDDDDD" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "countryIds": [ { "countryId": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": "ddddddddd", "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "roundingId": "EEEE", "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "regions": [ { "region": "DDDDDD" } ], "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "bbbb", "chequeIdRequired": "CCCCC", "debitCreditIndicator": "DDDDDD", "chargeIds": [ { "chargeId": "DDDDDD" } ], "defaultValueDate": "bbbb", "defaultExposureDate": "CCCCC", "includeInTurnoverCharge": "DDDDDD", "swiftNarrative": "bbbb", "transactionInitiationType": "CCCCC", "description": "DDDDDD", "narrative": "bbbb", "statementReferenceField": "CCCCC", "forceDefaultExposureDate": "DDDDDD", "statementNarrativeFormatId": "bbbb", "productId": "CCCCC", "transactionIds": [ { "transactionId": "DDDDDD" } ], "exposureDateConditionId": "DDDDDD", "chequeTypeId": "bbbb", "exemptDispoProcessing": "CCCCC", "transactionType": "DDDDDD" } } }
Transaction Creation
The TRANSACTION table defines the main characteristics of the transaction codes associated to transactions.
API
The API that's used to create a transaction record.
POST /v1.0.0/reference/transactionCodes/{transactionCode}
Event
The event that's emanated at transaction record creation.
createTransaction.transactionCreated
Event Payload
transactionCode |
Identifies the transaction details. |
transactionNames |
Description of the transaction code. |
chequeTransaction |
Indicates whether the transactions using this code requires mandatory cheque number. |
chequeIdRequired |
Indicates whether the transactions using this code requires mandatory reference number. |
debitCreditIndicator |
Indicates if the Transaction code is to be used for debit or credit entries. |
chargeIds |
Indicates the charge code which will be triggered for payment stop instruction. |
defaultValueDate |
Indicates that values date to be defaulted during the transactions using this transaction code. |
departmentParent |
Indicates the line manager of the department account officer in the departmental hierarchy. |
defaultExposureDate |
Indicates if transaction using this code will have exposure date defaulted. |
includeInTurnoverCharge |
Indicates whether the transaction using this code are to be included in the calculation of Debit/Credit turnover charges. |
swiftNarrative |
Indicates the SWIFT narrative corresponding to the transaction code as per the rules specified in the SWIFT user handbook. |
transactionInitiationType |
Defines the initiator type of transaction. |
description |
Contains the description of purpose of the payment. |
narrative |
The additional text printed on descriptive statements in addition to the standard narrative and/or reference. |
statementReferenceField |
Defines if reference has to appear as part of statement narrative. |
forceDefaultExposureDate |
Indicates that user wants to force in the default exposure date in a financial transaction. |
statementNarrativeFormatId |
Identifier of the statement narration format record. |
categoryId |
Unique identifier associated with the product name of the account or contract. |
productId |
Contains the unique identifier of the product, for example, the product Id of the arrangement account. |
transactionIds |
Unique transaction identifier for retrieving the details of the transaction. |
exposureDateConditionId |
Identifier of the exposure condition record. |
chequeTypeId |
Indicates the type of cheques for which payment stop instruction is effective. |
exemptDispoProcessing |
Indicates if the transaction is to be excluded from dispo processing. |
transactionType |
Identifies the transaction type applicable to the transaction being processed, that is, outward or inward payment. |
- Sample Code: Transaction Creation Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "transactionCode": "dddddddd", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "cccccc", "chequeIdRequired": "EEEEE", "debitCreditIndicator": "ddddd" "chargeIds": { { "chargeId": "DDDDDD", } }, "defaultValueDate": "DDDDDD", "defaultExposureDate": "CCCC", "includeInTurnoverCharge": "BBBBB", "swiftNarrative": "ddddd", "transactionInitiationType": "b", "description": "dddddd", "narrative": "ddddd", "statementReferenceField": "ddddd", "forceDefaultExposureDate": "eeee", "statementNarrativeFormatId":"ddddd", "categoryId": "ccccc", "productId": "DDDDD", "transactionIds": { { "transactionId": "DDDDDD" }, "exposureDateConditionId": "DDDDD", "chequeTypeId": "eeee", "exemptDispoProcessing": "eeeee", "transactionType":"cccccc", "changedAttributes": { "displayNames": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "countryIds": [ { "countryId": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": "ddddddddd", "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "roundingId": "EEEE", "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "regions": [ { "region": "DDDDDD" } ], "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "bbbb", "chequeIdRequired": "CCCCC", "debitCreditIndicator": "DDDDDD", "chargeIds": [ { "chargeId": "DDDDDD" } ], "defaultValueDate": "bbbb", "defaultExposureDate": "CCCCC", "includeInTurnoverCharge": "DDDDDD", "swiftNarrative": "bbbb", "transactionInitiationType": "CCCCC", "description": "DDDDDD", "narrative": "bbbb", "statementReferenceField": "CCCCC", "forceDefaultExposureDate": "DDDDDD", "statementNarrativeFormatId": "bbbb", "productId": "CCCCC", "transactionIds": [ { "transactionId": "DDDDDD" } ], "exposureDateConditionId": "DDDDDD", "chequeTypeId": "bbbb", "exemptDispoProcessing": "CCCCC", "transactionType": "DDDDDD" } } }
Transaction Modification
API
The API that's used to modify a transaction record.
PUT /v1.0.0/reference/transactionCodes/{transactionCode}
Event
The event that's emanated at transaction record modification.
modifyTransaction.transactionModified
Event Payload
Note: The event payload fields are the same as the transaction creation event. See previous section.
- Sample Code: Transaction Creation Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "transactionCode": "dddddddd", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "cccccc", "chequeIdRequired": "EEEEE", "debitCreditIndicator": "ddddd" "chargeIds": { { "chargeId": "DDDDDD", } }, "defaultValueDate": "DDDDDD", "defaultExposureDate": "CCCC", "includeInTurnoverCharge": "BBBBB", "swiftNarrative": "ddddd", "transactionInitiationType": "b", "description": "dddddd", "narrative": "ddddd", "statementReferenceField": "ddddd", "forceDefaultExposureDate": "eeee", "statementNarrativeFormatId":"ddddd", "categoryId": "ccccc", "productId": "DDDDD", "transactionIds": { { "transactionId": "DDDDDD" }, "exposureDateConditionId": "DDDDD", "chequeTypeId": "eeee", "exemptDispoProcessing": "eeeee", "transactionType":"cccccc", "changedAttributes": { "displayNames": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "countryIds": [ { "countryId": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": "ddddddddd", "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "roundingId": "EEEE", "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "regions": [ { "region": "DDDDDD" } ], "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "bbbb", "chequeIdRequired": "CCCCC", "debitCreditIndicator": "DDDDDD", "chargeIds": [ { "chargeId": "DDDDDD" } ], "defaultValueDate": "bbbb", "defaultExposureDate": "CCCCC", "includeInTurnoverCharge": "DDDDDD", "swiftNarrative": "bbbb", "transactionInitiationType": "CCCCC", "description": "DDDDDD", "narrative": "bbbb", "statementReferenceField": "CCCCC", "forceDefaultExposureDate": "DDDDDD", "statementNarrativeFormatId": "bbbb", "productId": "CCCCC", "transactionIds": [ { "transactionId": "DDDDDD" } ], "exposureDateConditionId": "DDDDDD", "chequeTypeId": "bbbb", "exemptDispoProcessing": "CCCCC", "transactionType": "DDDDDD" } } }
Currency-related Scenario Details
Rounding Rule Record Creation
The EB.ROUNDING.RULE application allows a rounding rule such as number of decimals, rounding fractions, rounding type, and so on, to be set at application level instead of the currency level.
API
The API that's used to create the rounding rule record.
POST /v1.0.0/reference/roundingRules/{ruleId}
Event
The event that's emanated at rounding rule record creation.
createEbRoundingRule.ebRoundingRuleCreated
Event Payload
roundingId |
Carries the unique Id of rounding rule. |
displayNames |
Contains the name used for display or enrichment purposes. |
useMinimumUnit |
Defines whether the minimum amount, or the lowest unit of currency, is to be used when rounding is in effect for the currency. |
preRoundToSixDecimal |
Setup to do a pre rounding of 6 decimal points before applying actual rounding rule. |
numberofDecimal |
Specifies the number of decimals for rounding interest rate. |
roundingFractions |
Specifies the types of rounding fractions that can be used for rounding interest rates. |
- Sample Code: Rounding Rule Creation Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "roundingId": "EEEE", "displayNames": [ { "displayName": "DDDDDD" } ], "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "changedAttributes":{ [ { "categoryId": "DDDDDD" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "countryIds": [ { "countryId": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": "ddddddddd", "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "roundingId": "EEEE", "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "regions": [ { "region": "DDDDDD" } ], "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "bbbb", "chequeIdRequired": "CCCCC", "debitCreditIndicator": "DDDDDD", "chargeIds": [ { "chargeId": "DDDDDD" } ], "defaultValueDate": "bbbb", "defaultExposureDate": "CCCCC", "includeInTurnoverCharge": "DDDDDD", "swiftNarrative": "bbbb", "transactionInitiationType": "CCCCC", "description": "DDDDDD", "narrative": "bbbb", "statementReferenceField": "CCCCC", "forceDefaultExposureDate": "DDDDDD", "statementNarrativeFormatId": "bbbb", "productId": "CCCCC", "transactionIds": [ { "transactionId": "DDDDDD" } ], "exposureDateConditionId": "DDDDDD", "chequeTypeId": "bbbb", "exemptDispoProcessing": "CCCCC", "transactionType": "DDDDDD" } } }
Rounding Rule Record Modification
API
The API that's used to modify the rounding rule record.
PUT /v1.0.0/reference/roundingRules/{ruleId}
Event
The event that's emanated at rounding rule record modification.
modifyEbRoundingRule.ebRoundingRuleModified
Event Payload
Note: The event payload fields are the same as the interest basis creation event. See previous section.
- Sample Code: Rounding Rule Modification Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "roundingId": "EEEE", "displayNames": [ { "displayName": "DDDDDD" } ], "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "changedAttributes":{ [ { "categoryId": "DDDDDD" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "categoryNames": [ { "categoryName": "DDDDDD" } ], "systemId": "DDDDDD", "mnemonic": "CCCC", "reportingType": "BBBBB", "entryConsolidationId": "", "positionType": "b", "countryIds": [ { "countryId": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "countryNames": [ { "countryName": "DDDDDD" } ], "geographicalBlock": "ddddddddd", "capitalGainsIndexes": [ { "capitalGainsIndex": "DDDDDD", "capitalGainsIndexDate": "DDDDDD" } ], "traceDays": "EEEE", "riskLevel": "aaaa", "phoneNumber": "bbbb", "countryCode": "CCCCC", "numericCountryCode": "DDDDDD", "accountOfficer": "EEEE", "accountOfficerArea": "aaaa", "accountOfficerName": "bbbb", "addressLocation": "CCCCC", "allowedCompanies": [ { "allowedCompany": "DDDDDD" } ], "excludedCompanies": [ { "excludedCompany": "DDDDDD" } ], "faxId": "DDDDDD", "departmentLevel": "EEEE", "departmentParent": "aaaa", "departmentId": "bbbb", "acceptMessage": "CCCCC", "customerId": "DDDDDD", "roundingId": "EEEE", "rounding": "aaaa", "useMinimumUnit": "bbbb", "preRoundToSixDecimal": "DDDDDD", "numberofDecimal": "EEEE", "roundingFractions": "aaaa", "regions": [ { "region": "DDDDDD" } ], "month01Holidays": "bbbb", "month02Holidays": "bbbb", "month03Holidays": "bbbb", "month04Holidays": "bbbb", "month05Holidays": "bbbb", "month06Holidays": "bbbb", "month07Holidays": "bbbb", "month08Holidays": "bbbb", "month09Holidays": "bbbb", "month10Holidays": "bbbb", "month11Holidays": "bbbb", "month12Holidays": "bbbb", "weekendDays": [ { "weekendDay": "DDDDDD" } ], "month01": "bbbb", "month02": "bbbb", "month03": "bbbb", "month04": "bbbb", "month05": "bbbb", "month06": "bbbb", "month07": "bbbb", "month08": "bbbb", "month09": "bbbb", "month10": "bbbb", "month11": "bbbb", "month12": "bbbb", "transactionNames": [ { "transactionName": "DDDDDD" } ], "chequeTransaction": "bbbb", "chequeIdRequired": "CCCCC", "debitCreditIndicator": "DDDDDD", "chargeIds": [ { "chargeId": "DDDDDD" } ], "defaultValueDate": "bbbb", "defaultExposureDate": "CCCCC", "includeInTurnoverCharge": "DDDDDD", "swiftNarrative": "bbbb", "transactionInitiationType": "CCCCC", "description": "DDDDDD", "narrative": "bbbb", "statementReferenceField": "CCCCC", "forceDefaultExposureDate": "DDDDDD", "statementNarrativeFormatId": "bbbb", "productId": "CCCCC", "transactionIds": [ { "transactionId": "DDDDDD" } ], "exposureDateConditionId": "DDDDDD", "chequeTypeId": "bbbb", "exemptDispoProcessing": "CCCCC", "transactionType": "DDDDDD" } } }
Rounding Rule Record Deletion
API
The API that's used to delete the rounding rule record.
DELETE /v1.0.0/reference/roundingRules/{ruleId}
Event
The event that's emanated at rounding rule record deletion.
deleteEbRoundingRule.ebRoundingRuleDeleted
Event Payload
roundingId |
Unique Id of the rounding rule record that is deleted. |
- Sample Code: Rounding Rule Deletion Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "roundingId": "dddddddd", } }
Currency Parameter Creation
API
The API that's used to create the currency parameter record.
POST /v2.2.0/reference/currencies/{currencyId}/profiles
Event
The event that's emanated when the currency parameter record is created.
createCurrencyParam.currencyParamCreated
Event Payload
currencyId |
Identifier of the currency. |
numericCurrencyCode |
Numeric code for the currency. |
displayNames |
Contains the name used for display or enrichment purposes. |
preciousMetal |
Identifies if the currency is a precious metal or not. |
- Sample Code: Currency Parameter Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "currencyId": "dddddddd", "numericCurrencyCode": "dddddd", "displayNames": [ { "displayName": "DDDDDD" } ], "numberofDecimal": "cccccc", "dayBasis": "EEEEE", "preciousMetal": "ddddd", "equivalentCurrencyIds": [ { "equivalentCurrencyId": "DDDDDD" } ], "countryId": "DDDDDD", "baseCurrencyRank": "CCCC", "spreadRate": "BBBBB", "decimalNames": { [ { "decimalName": "DDDDDD" } ], "changedAttributes": { "currencyId": "eeeee", "numericCurrencyCode": "ddddd", "displayNames": [ { "displayName": "DDDDDD" } ], "numberofDecimal": "DDDDDD", "dayBasis": "CCCC", "preciousMetal": "BBBBB", "equivalentCurrencyIds": [ { "equivalentCurrencyId": "DDDDDD" } ], "countryId": "dddddd", "baseCurrencyRank": "eeeee", "decimalNames": [ { "decimalName": "DDDDDD" } ], "spreadRate": "cccccc", "currencyMarketNames": [ { "currencyMarketName": "DDDDDD" } ], "spreadCalcuationRoutine": "EEEE", "rank": "aaaa", "quotationCode": "bbbb", "quotationPips": "CCCCC", "noticeDay": "DDDDDD", "nostroProjectionDay": "EEEE", "interestDayBasis": "aaaa", "allowedVariance": "bbbb", "fixedRateDate": "CCCCC", "markets": [ { "market": "DDDDDD", "buyRate": "ddddd", "sellRate": "DDDDD" } ], "rateInformation": [ { "midRate": "DDDDDD", "defaultSpread": "bbbb", "uptoSmallAmount": "aaaaa", "treasurySmallSpread":"eeeee", "customerSmallSpread":"ccccc", "negotiableAmount":"ddddd", "treasuryMediumSpread": "bbbb", "customerMediumSpread":"bbbb", "revalrate":"eeee", "treasuryLimitAmount":"ddddd" } ], "minAmount": "DDDDDD", "cashOnlyRounding": "EEEE", "minimumRoundType": "aaaa", "cashRoundType": "bbbb", "equivalentCurrencies": [ { "equivalentCurrencyId": "DDDDDD" } ], "countryCode": "bbbb", "fixedRate": "bbbb", "fixedCurrencyId": "bbbb", "startDate": "bbbb", "availableDate": "bbbb", "blockedDateTime": "bbbb", "cutOffTime": "bbbb", "clsCurrencyId": "bbbb", "currencyIds": [ { "currencyId": "DDDDDD", } ], } } }
Currency Parameter Modification
API
The API that's used to modify the currency parameter record.
PUT /v2.2.0/reference/currencies/{currencyId}/profiles
Event
The event that's emanated when the currency parameter record is modified.
modifyCurrencyParam.currencyParamModified
Event Payload
Note: The event payload fields are the same as the currency parameter creation event. See previous section.
- Sample Code: Currency Parameter Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "currencyId": "dddddddd", "numericCurrencyCode": "dddddd", "displayNames": [ { "displayName": "DDDDDD" } ], "numberofDecimal": "cccccc", "dayBasis": "EEEEE", "preciousMetal": "ddddd", "equivalentCurrencyIds": [ { "equivalentCurrencyId": "DDDDDD" } ], "countryId": "DDDDDD", "baseCurrencyRank": "CCCC", "spreadRate": "BBBBB", "decimalNames": { [ { "decimalName": "DDDDDD" } ], "changedAttributes": { "currencyId": "eeeee", "numericCurrencyCode": "ddddd", "displayNames": [ { "displayName": "DDDDDD" } ], "numberofDecimal": "DDDDDD", "dayBasis": "CCCC", "preciousMetal": "BBBBB", "equivalentCurrencyIds": [ { "equivalentCurrencyId": "DDDDDD" } ], "countryId": "dddddd", "baseCurrencyRank": "eeeee", "decimalNames": [ { "decimalName": "DDDDDD" } ], "spreadRate": "cccccc", "currencyMarketNames": [ { "currencyMarketName": "DDDDDD" } ], "spreadCalcuationRoutine": "EEEE", "rank": "aaaa", "quotationCode": "bbbb", "quotationPips": "CCCCC", "noticeDay": "DDDDDD", "nostroProjectionDay": "EEEE", "interestDayBasis": "aaaa", "allowedVariance": "bbbb", "fixedRateDate": "CCCCC", "markets": [ { "market": "DDDDDD", "buyRate": "ddddd", "sellRate": "DDDDD" } ], "rateInformation": [ { "midRate": "DDDDDD", "defaultSpread": "bbbb", "uptoSmallAmount": "aaaaa", "treasurySmallSpread":"eeeee", "customerSmallSpread":"ccccc", "negotiableAmount":"ddddd", "treasuryMediumSpread": "bbbb", "customerMediumSpread":"bbbb", "revalrate":"eeee", "treasuryLimitAmount":"ddddd" } ], "minAmount": "DDDDDD", "cashOnlyRounding": "EEEE", "minimumRoundType": "aaaa", "cashRoundType": "bbbb", "equivalentCurrencies": [ { "equivalentCurrencyId": "DDDDDD" } ], "countryCode": "bbbb", "fixedRate": "bbbb", "fixedCurrencyId": "bbbb", "startDate": "bbbb", "availableDate": "bbbb", "blockedDateTime": "bbbb", "cutOffTime": "bbbb", "clsCurrencyId": "bbbb", "currencyIds": [ { "currencyId": "DDDDDD", } ], } } }
Currency Parameter Deletion
API
The API that's used to delete the currency parameter record.
DELETE /v2.2.0/reference/currencies/{currencyId}/profiles
Event
The event that's emanated when the currency parameter record is deleted.
deleteCurrencyParam.currencyParamDeleted
Event Payload
currencyId |
Indicates the currency parameter record Id which is deleted. |
- Sample Code: Currency Parameter Deletion Event Payload
-
{ "specversion": "BBBBBBB", "type": "AAAAAAAAA", "subject": "DDDDDDDD", "source": "eeeee", "id": "bbbbbbb", "time": "BBBBB", "correlationid": "cccccc", "serviceid": "ee", "channelid": "cc", "organizationid": "bbbbbbbb", "tenantid": "cccccc", "businesskey": "DDDDDDDDD", "sequenceno": 1, "authorization": "ccccccccc", "customfilterid": "eee", "operationinstanceid": "ccc", "sequenceinstanceid": "e", "priority": 1, "data": { "currencyId": "jjjjj" } }
