Market Data Event Lifecycle Guide
This brief guide describes a sample lifecycle for market data events, including basic and periodic interest, currency, and currency group and currency market events. While not all the events are explored in this guide, the guide is intended to provide you with information on the most typical life-cycle events of market data.
Lifecycle Diagram
Legend
|
|
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. |
Tip: Click diagram to expand.
Basic Interest Rate Text
This text provides a description of the basic interest rate.
API
The API that's used to create the basic interest rate text.
POST/reference/interestRates/{rateId}/floatingRates/names
Event
The event that's emanated at basic interest rate text creation.
createBasicRateText.basicRateTextCreated
Event Payload
rateId |
Identifies the periodic or floating interest rate. |
rateNames |
Specifies the name displayed for the interest rate. |
- Sample Code: Basic Rate Text 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": { "rateId": "dddddddd", "rateNames": [ { "rateName": "DDDDDD" } ], "changedAttributes": { "interestBasisNames": [ { "interestBasisName": "DDDDDD" } ], "interestBasis": "DDDDDD", "interestRate": "CCCC", "negativeInterestRate": "BBBBB", "rateNames": [ { "rateName": "DDDDDD" } ], "defaultMisRateId": "ddddddddd", "interestCondition": [ { "period": "dddddd", "rateDate": "DDDDDD", "daysSinceStart": "DDDDDD", "rates": [ { "bandAmount": "DDDDDDD", "bidRate": "DDDDDDDD", "offerRate": "EEEEE", } ], } ], "buildForwardRate": "EEEE", "tolerancePercentage": "aaaa", "maximumInterestRate": "bbbb", "spreadCalcuationRoutines": [ { "spreadCalcuationRoutine": "DDDDDD" } ], "useLastWorkingDay": "EEEEEE", "negativeRateApplicationIds": [ { "negativeRateApplicationId": "DDDDDD" } ], "historyDetails": [ { "historyCompanyId": "DDDDDD", } "historyNumbers" : [ { "historyDate": "dddddddd", "historyNumber": "dddddd", } ], ], "versionNumber": "bbbb", "riskFreeRate": "bbbb", "receivedDate": "bbbb", "allowAmount": "bbbb", "displayNames": [ { "displayName": "DDDDDD" } ], "rateTextName": "bbbb", "rateKey": "bbbb", "swiftCodeWord": "bbbb", } } }
Basic Interest Rate Text Modification
API
The API that's used for modifying the basic interest rate text.
PUT/reference/interestRates/{rateId}/floatingRates/names
Event
The event that's emanated when the basic interest rate text is modified.
modifyBasicRateText.basicRateTextModified
Event Payload
Note: The event payload fields are the same as the basic interest rate text creation event. See previous section.
- Sample Code: Basic Interest Rate 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": { "rateId": "dddddddd", "rateNames": [ { "rateName": "DDDDDD" } ], "changedAttributes": { "interestBasisNames": [ { "interestBasisName": "DDDDDD" } ], "interestBasis": "DDDDDD", "interestRate": "CCCC", "negativeInterestRate": "BBBBB", "rateNames": [ { "rateName": "DDDDDD" } ], "defaultMisRateId": "ddddddddd", "interestCondition": [ { "period": "dddddd", "rateDate": "DDDDDD", "daysSinceStart": "DDDDDD", "rates": [ { "bandAmount": "DDDDDDD", "bidRate": "DDDDDDDD", "offerRate": "EEEEE", } ], } ], "buildForwardRate": "EEEE", "tolerancePercentage": "aaaa", "maximumInterestRate": "bbbb", "spreadCalcuationRoutines": [ { "spreadCalcuationRoutine": "DDDDDD" } ], "useLastWorkingDay": "EEEEEE", "negativeRateApplicationIds": [ { "negativeRateApplicationId": "DDDDDD" } ], "historyDetails": [ { "historyCompanyId": "DDDDDD", } "historyNumbers" : [ { "historyDate": "dddddddd", "historyNumber": "dddddd", } ], ], "versionNumber": "bbbb", "riskFreeRate": "bbbb", "receivedDate": "bbbb", "allowAmount": "bbbb", "displayNames": [ { "displayName": "DDDDDD" } ], "rateTextName": "bbbb", "rateKey": "bbbb", "swiftCodeWord": "bbbb", } } }
Basic Interest Creation
Creates and maintains frequently used floating rates, such as Base Rate, Prime Rate, and Overnight Rate.
API
The API that's used to create basic interest.
POST/reference/interestRates/{rateId}/floatingRates
Event
The event that's emanated at basic interest creation.
createBasicInterest.basicInterestCreated
Event Payload
rateId |
Identifies the periodic or floating interest rates. |
interestRate |
Identifies the bid rate of the related currency for the defined time period.; |
negativeInterestRate |
Contains the negative rate of interest that can be used for a contract. This is currently only supported for Swaps, Money Market and Derivatives.; |
- Sample Code: Basic Interest 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": { "rateId": "dddddddd", "interestRate":"CCCCCCC", "negativeInterestRate": "DDDDDDD", "changedAttributes": [ "interestBasisNames" [ { "interestBasisName":"DDDDDD", } ], "interestBasis": "DDDDDD", "interestRate": "CCCC", "negativeInterestRate": "BBBBB", "rateNames": { { "rateName": "DDDDDD", } }, "defaultMisRateId":"eeeee", "interestCondition": [ { "rateDate": "DDDDDD", "daysSinceStart": "BBBBBB", "rates": [ { "bandAmount":"DDDDDD", "bidRate": "eeeee", "offerRate": "ccccccc" } ], "buildForwardRate": "EEEE", "tolerancePercentage": "aaaa", "maximumInterestRate": "bbbb", "spreadCalcuationRoutines": [ { "spreadCalcuationRoutine": "DDDDDD" } ], "useLastWorkingDay": "DDDDDD", "negativeRateApplicationIds": [ { "negativeRateApplicationId": "DDDDDD" } ], "historyDetails": [ { "historyCompanyId": "DDDDDD" } ], "historyNumbers": [ { "historyDate": "DDDDDD", "historyNumber": "eeeeee" } ], "versionNumber": "bbbb", "riskFreeRate": "bbbb", "receivedDate": "bbbb", "allowAmount": "bbbb", "displayNames": [ { "displayName": "DDDDDD" } ], "rateTextName": "bbbb", "rateKey": "bbbb", "swiftCodeWord": "bbbb" } } }
Basic Interest Modification
API
The API that's used to modify basic interest.
PUT/reference/interestRates/{rateId}/floatingRates
Event
The event that's emanated when basic interest is modified.
modifyBasicInterest.basicInterestModified
Event Payload
Note: The event payload fields are the same as the basic interest creation event. See previous section.
- Sample Code: Basic Interest 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": { "rateId": "dddddddd", "interestRate":"CCCCCCC", "negativeInterestRate": "DDDDDDD", "changedAttributes": [ "interestBasisNames" [ { "interestBasisName":"DDDDDD", } ], "interestBasis": "DDDDDD", "interestRate": "CCCC", "negativeInterestRate": "BBBBB", "rateNames": { { "rateName": "DDDDDD", } }, "defaultMisRateId":"eeeee", "interestCondition": [ { "rateDate": "DDDDDD", "daysSinceStart": "BBBBBB", "rates": [ { "bandAmount":"DDDDDD", "bidRate": "eeeee", "offerRate": "ccccccc" } ], "buildForwardRate": "EEEE", "tolerancePercentage": "aaaa", "maximumInterestRate": "bbbb", "spreadCalcuationRoutines": [ { "spreadCalcuationRoutine": "DDDDDD" } ], "useLastWorkingDay": "DDDDDD", "negativeRateApplicationIds": [ { "negativeRateApplicationId": "DDDDDD" } ], "historyDetails": [ { "historyCompanyId": "DDDDDD" } ], "historyNumbers": [ { "historyDate": "DDDDDD", "historyNumber": "eeeeee" } ], "versionNumber": "bbbb", "riskFreeRate": "bbbb", "receivedDate": "bbbb", "allowAmount": "bbbb", "displayNames": [ { "displayName": "DDDDDD" } ], "rateTextName": "bbbb", "rateKey": "bbbb", "swiftCodeWord": "bbbb" } } }
Periodic Interest Creation
Enables the user to create interest rates for each currency for any time period.
API
The API that's used to create the periodic interest.
POST/reference/interestRates/{rateId}/periodicRates
Event
The event that's emanated at periodic interest creation.
createPeriodicInterest.periodicInterestCreated
Event Payload
rateId |
Identifies the periodic or floating interest rate. |
rateNames |
Specifies the name displayed for the interest rate. |
defaultMisRateId |
Identifies the default Management Information System (M.I.S.) rate to be used for the transaction. |
interestCondition |
Indicates the interest condition information such as interest period, rate date and interest days since start. |
- Sample Code: Periodic Interest 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": { "rateId": "dddddddd", "rateNames": [ { "rateName": "DDDDDD" } ], "defaultMisRateId": "DDDDD", "interestCondition": [ { "period": "DDDDDD", "rateDate": "ddddd", "daysSinceStart": "aaaaaa" } ], "rates": { [ { "bandAmount": "DDDDDD", "bidRate": "ddddd", "offerRate":"ddddd" } ], "buildForwardRate": "DDDDD", "tolerancePercentage": "eeeee", "maximumInterestRate": "ddddd" , "spreadCalcuationRoutines": [ { "spreadCalcuationRoutine": "DDDDDD" } ], "useLastWorkingDay": "DDDDDD", "negativeRateApplicationIds": [ { "negativeRateApplicationId": "DDDDDD" } ], "historyDetails": [ { "historyCompanyId": "DDDDDD" } ], "historyNumbers": [ { "historyDate": "DDDDDD", "historyNumber": "DDDDD" } ], "versionNumber": "EEEE", "riskFreeRate": "aaaa", "receivedDate": "bbbb", "changedAttributes": [ { "interestBasisNames": [ { "interestBasisName": "dddd" } ], "interestBasis": "DDDD", "interestRate": "eeeeee", "negativeInterestRate": "dddddd", "rateNames": [ { "rateName": "DDDDDD" } ], "interestCondition": [ { "period": "DDDDDD", "rateDate": "ddddd", "daysSinceStart": "ddddd" } ], "rates": [ { "bandAmount": "DDDDDD", "bidRate": "dddd", "offerRate": "eeeeee" } ], "buildForwardRate": "eeeee", "tolerancePercentage": "dddd", "maximumInterestRate": "eeeee", "spreadCalcuationRoutines": [ { "spreadCalcuationRoutine": "DDDDDD" } ], "useLastWorkingDay": "eeeee", "negativeRateApplicationIds": [ { "negativeRateApplicationId": "DDDDDD" } ], "historyDetails": [ { "historyCompanyId": "DDDDDD" } ], "historyNumbers": [ { "historyDate": "DDDDDD", "historyNumber": "ddddd" } ], "versionNumber": "bbbb", "riskFreeRate": "bbbb", "receivedDate": "bbbb", "allowAmount": "bbbb", "displayNames": [ { "displayName": "DDDDDD" } ], "rateTextName":"eeee", "rateKey": "eeeee", "swiftCodeWord":"DDDDD" } ], } } }
Periodic Interest Modification
API
The API that's used to modify the periodic interest.
PUT/reference/interestRates/{rateId}/periodicRates
Event
The event that's emanated at periodic interest modification.
modifyPeriodicInterest.periodicInterestModified
Event Payload
Note: The event payload fields are the same as the basic interest creation event. See previous section.
- Sample Code: Periodic Interest 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": { "rateId": "dddddddd", "rateNames": [ { "rateName": "DDDDDD" } ], "defaultMisRateId": "DDDDD", "interestCondition": [ { "period": "DDDDDD", "rateDate": "ddddd", "daysSinceStart": "aaaaaa" } ], "rates": { [ { "bandAmount": "DDDDDD", "bidRate": "ddddd", "offerRate":"ddddd" } ], "buildForwardRate": "DDDDD", "tolerancePercentage": "eeeee", "maximumInterestRate": "ddddd" , "spreadCalcuationRoutines": [ { "spreadCalcuationRoutine": "DDDDDD" } ], "useLastWorkingDay": "DDDDDD", "negativeRateApplicationIds": [ { "negativeRateApplicationId": "DDDDDD" } ], "historyDetails": [ { "historyCompanyId": "DDDDDD" } ], "historyNumbers": [ { "historyDate": "DDDDDD", "historyNumber": "DDDDD" } ], "versionNumber": "EEEE", "riskFreeRate": "aaaa", "receivedDate": "bbbb", "changedAttributes": [ { "interestBasisNames": [ { "interestBasisName": "dddd" } ], "interestBasis": "DDDD", "interestRate": "eeeeee", "negativeInterestRate": "dddddd", "rateNames": [ { "rateName": "DDDDDD" } ], "interestCondition": [ { "period": "DDDDDD", "rateDate": "ddddd", "daysSinceStart": "ddddd" } ], "rates": [ { "bandAmount": "DDDDDD", "bidRate": "dddd", "offerRate": "eeeeee" } ], "buildForwardRate": "eeeee", "tolerancePercentage": "dddd", "maximumInterestRate": "eeeee", "spreadCalcuationRoutines": [ { "spreadCalcuationRoutine": "DDDDDD" } ], "useLastWorkingDay": "eeeee", "negativeRateApplicationIds": [ { "negativeRateApplicationId": "DDDDDD" } ], "historyDetails": [ { "historyCompanyId": "DDDDDD" } ], "historyNumbers": [ { "historyDate": "DDDDDD", "historyNumber": "ddddd" } ], "versionNumber": "bbbb", "riskFreeRate": "bbbb", "receivedDate": "bbbb", "allowAmount": "bbbb", "displayNames": [ { "displayName": "DDDDDD" } ], "rateTextName":"eeee", "rateKey": "eeeee", "swiftCodeWord":"DDDDD" } ], } } }
Currency Creation
Contains details of each currency, such as currency name, buying rate, selling rate, and so on.
API
The API that's used to create the currency.
POST/reference/currencies/{currencyId}
Event
The event that's emanated at currency creation.
createCurrency.currencyCreated
Event Payload
currencyId |
Identifies the currency. |
rank |
Indicates the rank of the payment order product within the group. |
- Sample Code: Currency 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": { "currencyId": "dddddddd", "rank": "eeeeeee", "numericCurrencyCode":"dddddddd", "displayNames": [ { "displayName": "DDDDDD" } ], "numberofDecimal":"CCCCCCCC", "quotationCode":"eeeeeee", "quotationPips":"dddddd", "noticeDay":"dddddddd", "nostroProjectionDay":"dddddd", "interestDayBasis":"ccc", "allowedVariance":"eeeeee", "fixedRateDate":"ddddddddd", "markets": [ { "market": "DDDDDD", "buyRate": "EEEE", "sellRate":"EEEEE" } ], "rateInformation": { [ { "midRate": "DDDDDD", "defaultSpread":"DDDD", "uptoSmallAmount": "eeeeeee", "treasurySmallSpread":"eee", "customerSmallSpread": "ddddd", "negotiableAmount":"ccccccc", "treasuryMediumSpread":"dddd", "customerMediumSpread":"dddd", "revalrate":"eeee", "treasuryLimitAmount":"eeeeeeee", } ], "minAmount": "DDDDDD", "cashOnlyRounding": "CCCC", "minimumRoundType": "BBBBB", "cashRoundType": "BBBBB", "preciousMetal": "b", "equivalentCurrencies": [ { "equivalentCurrencyId": "DDDDDD" } ], "countryCode": "EEEE", "fixedRate": "aaaa", "fixedCurrencyId": "bbbb", "startDate": "CCCCC", "baseCurrencyRank": "DDDDDD", "availableDate": "EEEE", "blockedDateTime": "aaaa", "cutOffTime": "bbbb", "clsCurrencyId": "CCCCC", "changedAttributes": [ { "currencyId": "DDDDDD", "numericCurrencyCode":"eeeee" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "numberofDecimal": "DDDDDD", "dayBasis": "EEEE", "preciousMetal": "aaaa", "equivalentCurrencyIds": [ { "equivalentCurrencyId": "DDDDDD" } ], "countryId": "bbbb", "baseCurrencyRank": "bbbb", "decimalNames": [ { "decimalName": "DDDDDD" } ], "spreadRate": "bbbb", "currencyMarketNames": [ { "currencyMarketName": "DDDDDD" } ], "spreadCalcuationRoutine": "bbbb", "rank": "CCCCC", "quotationCode": "DDDDDD", "quotationPips":"DDDDDD", "noticeDay": "DDDD", "nostroProjectionDay":"DDDDDDD", "interestDayBasis": "eeeee", "allowedVariance": "ddddd", "fixedRateDate": "eeee", "markets": [ { "market": "DDDDDD", "buyRate": "DDDDD", "sellRate": "DDDDD", } ], "rateInformation": [ { "midRate": "DDDDDD", "defaultSpread": "DDDDD", "uptoSmallAmount": "DDDD", "treasurySmallSpread": "DDDDD", "customerSmallSpread": "DDDDDD", "negotiableAmount": "eeeeeee", "treasuryMediumSpread": "eeeee", "customerMediumSpread": "ddddd", "revalrate": "eeee", "treasuryLimitAmount": "eeee", } ], "minAmount": "DDDDDD", "cashOnlyRounding": "bbbb", "cashRoundType": "CCCCC", "equivalentCurrencies": [ { "equivalentCurrencyId": "DDDDDD", } ], "countryCode": "EEEEE", "fixedRate": "DDDDDD", "fixedCurrencyId": "EEEEE", "startDate": "CCCC", "availableDate":"CCCCC", "blockedDateTime":"DDDD", "cutOffTime":"dddd", "clsCurrencyId":"eeee", "currencyIds": [ { "currencyId": "DDDDDD", } ], } } }
Currency Modification
API
The API that's used to modify the currency.
PUT/reference/currencies/{currencyId}
Event
The event that's emanated at currency modification.
modifyCurrency.currencyModified
Event Payload
Note: The event payload fields are the same as the currency creation event. See previous section.
- Sample Code: Currency 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": { "currencyId": "dddddddd", "rank": "eeeeeee", "numericCurrencyCode":"dddddddd", "displayNames": [ { "displayName": "DDDDDD" } ], "numberofDecimal":"CCCCCCCC", "quotationCode":"eeeeeee", "quotationPips":"dddddd", "noticeDay":"dddddddd", "nostroProjectionDay":"dddddd", "interestDayBasis":"ccc", "allowedVariance":"eeeeee", "fixedRateDate":"ddddddddd", "markets": [ { "market": "DDDDDD", "buyRate": "EEEE", "sellRate":"EEEEE" } ], "rateInformation": { [ { "midRate": "DDDDDD", "defaultSpread":"DDDD", "uptoSmallAmount": "eeeeeee", "treasurySmallSpread":"eee", "customerSmallSpread": "ddddd", "negotiableAmount":"ccccccc", "treasuryMediumSpread":"dddd", "customerMediumSpread":"dddd", "revalrate":"eeee", "treasuryLimitAmount":"eeeeeeee", } ], "minAmount": "DDDDDD", "cashOnlyRounding": "CCCC", "minimumRoundType": "BBBBB", "cashRoundType": "BBBBB", "preciousMetal": "b", "equivalentCurrencies": [ { "equivalentCurrencyId": "DDDDDD" } ], "countryCode": "EEEE", "fixedRate": "aaaa", "fixedCurrencyId": "bbbb", "startDate": "CCCCC", "baseCurrencyRank": "DDDDDD", "availableDate": "EEEE", "blockedDateTime": "aaaa", "cutOffTime": "bbbb", "clsCurrencyId": "CCCCC", "changedAttributes": [ { "currencyId": "DDDDDD", "numericCurrencyCode":"eeeee" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "numberofDecimal": "DDDDDD", "dayBasis": "EEEE", "preciousMetal": "aaaa", "equivalentCurrencyIds": [ { "equivalentCurrencyId": "DDDDDD" } ], "countryId": "bbbb", "baseCurrencyRank": "bbbb", "decimalNames": [ { "decimalName": "DDDDDD" } ], "spreadRate": "bbbb", "currencyMarketNames": [ { "currencyMarketName": "DDDDDD" } ], "spreadCalcuationRoutine": "bbbb", "rank": "CCCCC", "quotationCode": "DDDDDD", "quotationPips":"DDDDDD", "noticeDay": "DDDD", "nostroProjectionDay":"DDDDDDD", "interestDayBasis": "eeeee", "allowedVariance": "ddddd", "fixedRateDate": "eeee", "markets": [ { "market": "DDDDDD", "buyRate": "DDDDD", "sellRate": "DDDDD", } ], "rateInformation": [ { "midRate": "DDDDDD", "defaultSpread": "DDDDD", "uptoSmallAmount": "DDDD", "treasurySmallSpread": "DDDDD", "customerSmallSpread": "DDDDDD", "negotiableAmount": "eeeeeee", "treasuryMediumSpread": "eeeee", "customerMediumSpread": "ddddd", "revalrate": "eeee", "treasuryLimitAmount": "eeee", } ], "minAmount": "DDDDDD", "cashOnlyRounding": "bbbb", "cashRoundType": "CCCCC", "equivalentCurrencies": [ { "equivalentCurrencyId": "DDDDDD", } ], "countryCode": "EEEEE", "fixedRate": "DDDDDD", "fixedCurrencyId": "EEEEE", "startDate": "CCCC", "availableDate":"CCCCC", "blockedDateTime":"DDDD", "cutOffTime":"dddd", "clsCurrencyId":"eeee", "currencyIds": [ { "currencyId": "DDDDDD", } ], } } }
Currency Deletion
API
The API that's used for currency deletion.
DELETE/reference/currencies/{currencyId}
Event
The event that's emanated at currency deletion.
deleteCurrency.currencyDeleted
Event Payload
currencyId |
Identifies the currency. |
- Sample Code: Currency 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": "dddddddd", } }
Currency Group Creation
Allows the currencies to be grouped together for various operational and reporting purposes of the bank.
API
The API that's used for creating a currency group.
POST/reference/currencies/currencyGroups/{currencyGroupId}
Event
The event that's emanated at currency group creation.
createCurrencyGroup.currencyGroupCreated
Event Payload
currencyGroupId |
Identifies the currency group. |
displayNames |
Contains the name used for display or enrichment purposes. |
- Sample Code: Currency Group 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": { "currencyGroupId": "dddddddd", "displayNames": [ { "displayName": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "changedAttributes": { [ { "currencyId": "DDDDDD", "numericCurrencyCode": "ddddd", } ], "displayNames": [ { "displayName": "DDDDDD" } ], "numberofDecimal": "DDDDDD", "dayBasis": "CCCC", "preciousMetal": "BBBBB", "equivalentCurrencyIds": [ { "equivalentCurrencyId": "DDDDDD" } ], "countryId": "ddddd", "baseCurrencyRank": "dddddd", "decimalNames": [ { "decimalName": "DDDDDD" } ], "spreadRate": "eeeee", "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": "dddd", "sellRate": "eeee" } ], "rateInformation": [ { "midRate": "DDDDDD", "defaultSpread": "eeee", "uptoSmallAmount": "eeeeee", "treasurySmallSpread": "ddddd", "customerSmallSpread": "eeee", "negotiableAmount": "dddd", "treasuryMediumSpread": "ddddd", "customerMediumSpread": "eeeee", "revalrate": "dddd", "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 Group Modification
API
The API that's used for modifying a currency group.
PUT/reference/currencies/currencyGroups/{currencyGroupId}
Event
The event that's emanated at currency group modification.
modifyCurrencyGroup.currencyGroupModified
Event Payload
Note: The event payload fields are the same as the currency creation event. See previous section.
- Sample Code: Currency 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": { "currencyGroupId": "dddddddd", "displayNames": [ { "displayName": "DDDDDD" } ], "currencyIds": [ { "currencyId": "DDDDDD" } ], "changedAttributes": { [ { "currencyId": "DDDDDD", "numericCurrencyCode": "ddddd", } ], "displayNames": [ { "displayName": "DDDDDD" } ], "numberofDecimal": "DDDDDD", "dayBasis": "CCCC", "preciousMetal": "BBBBB", "equivalentCurrencyIds": [ { "equivalentCurrencyId": "DDDDDD" } ], "countryId": "ddddd", "baseCurrencyRank": "dddddd", "decimalNames": [ { "decimalName": "DDDDDD" } ], "spreadRate": "eeeee", "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": "dddd", "sellRate": "eeee" } ], "rateInformation": [ { "midRate": "DDDDDD", "defaultSpread": "eeee", "uptoSmallAmount": "eeeeee", "treasurySmallSpread": "ddddd", "customerSmallSpread": "eeee", "negotiableAmount": "dddd", "treasuryMediumSpread": "ddddd", "customerMediumSpread": "eeeee", "revalrate": "dddd", "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 Group Deletion
API
The API that's used to delete a currency group.
DELETE/reference/currencies/currencyGroups/{currencyGroupId}
Event
The event that's emanated at currency group deletion.
deleteCurrency.currencyDeleted
Event Payload
currencyGroupId |
Identifies the currency group (the idj of the group that's being deleted). |
- Sample Code: Currency Group 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": { "currencyGroupId": "dddddddd" } }
Currency Market Creation
Enables the creation of markets, to identify the correct exchange and revaluation rates to be applied to each currency.
API
The API that's used to create the currency market.
POST/reference/currencies/markets/{currencyMarketId}
Event
The event that's emanated at currency market creation.
createCurrencyMarket.currencyMarketCreated
Event Payload
currencyMarketId |
Specifies the code which identifies the currency market. |
currencyMarketNames |
Specifies the name displayed for the currency market. |
spreadCalculationRoutine |
Specifies the name of the routine that's used for customised spread calculation. |
- Sample Code: Currency Market 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": { "currencyMarketId": "dddddddd", "currencyMarketNames": [ { "currencyMarketName": "DDDDDD" } ], "spreadCalcuationRoutine": "DDDDD", "changedAttributes": [ { "currencyId": "DDDDDD", "numericCurrencyCode": "DDDD" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "numberofDecimal": "DDDDDD", "dayBasis": "CCCC", "preciousMetal": "BBBBB", "equivalentCurrencyIds": [ { "equivalentCurrencyId": "DDDDDD" } ], "countryId": "eeee", "baseCurrencyRank": "eeeee", "decimalNames": [ { "decimalName": "DDDDDD" } ], "spreadRate": "ddddddddd", "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": "ddddd", "uptoSmallAmount": "eeee", "treasurySmallSpread": "EEEEEE", "customerSmallSpread": "dddddd", "negotiableAmount": "dddd", "treasuryMediumSpread": "EEEE", "customerMediumSpread":"eeee", "revalrate":"ddddd", "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 Market Modification
API
The API that's used to modify the currency market.
PUT/reference/currencies/markets/{currencyMarketId}
Event
The event that's emanated at currency market modification.
modifyCurrencyMarket.currencyMarketModified
Event Payload
Note: The event payload fields are the same as the currency market creation event. See previous section.
- Sample Code: Currency Market 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": { "currencyMarketId": "dddddddd", "currencyMarketNames": [ { "currencyMarketName": "DDDDDD" } ], "spreadCalcuationRoutine": "DDDDD", "changedAttributes": [ { "currencyId": "DDDDDD", "numericCurrencyCode": "DDDD" } ], "displayNames": [ { "displayName": "DDDDDD" } ], "numberofDecimal": "DDDDDD", "dayBasis": "CCCC", "preciousMetal": "BBBBB", "equivalentCurrencyIds": [ { "equivalentCurrencyId": "DDDDDD" } ], "countryId": "eeee", "baseCurrencyRank": "eeeee", "decimalNames": [ { "decimalName": "DDDDDD" } ], "spreadRate": "ddddddddd", "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": "ddddd", "uptoSmallAmount": "eeee", "treasurySmallSpread": "EEEEEE", "customerSmallSpread": "dddddd", "negotiableAmount": "dddd", "treasuryMediumSpread": "EEEE", "customerMediumSpread":"eeee", "revalrate":"ddddd", "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" } ], } } }
