Event Name
modifyCentralBankDirectory.centralBankDirectoryModified
Domain
reference
Description
Indicates the modification of a record in the Central bank directory, which contains details of the financial institutions required for processing payments.
Properties
{
"centralBankDirectoryId": {
"type": "string",
"description": "Indicates the central bank directory identifier."
},
"recordStatus": {
"type": "string",
"description": "General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not authorised with blocking overrides - RNAU - reversed, not authorised - RNAO - reversed, not authorised with blocking overrides"
},
"resourceId": {
"type": "string",
"description": "Denotes the identifier of the resource"
},
"beneficiaryInstituteNames": {
"type": "array",
"description": "Indicates the name of financial institution where the beneficiary account is held",
"items": {
"id": "urn:jsonschema:beneficiaryInstituteNames",
"properties": {
"beneficiaryInstituteName": {
"type": "string",
"description": "Indicates the name of financial institution where the beneficiary account is held"
}
}
}
},
"beneficiaryInstituteCity": {
"type": "string",
"description": "Indicates the City of financial institution where the beneficiary account is held"
},
"beneficiaryInstituteBranchNames": {
"type": "array",
"description": "Indicates the Branch name of the financial institution where the beneficiary account is held",
"items": {
"id": "urn:jsonschema:beneficiaryInstituteBranchNames",
"properties": {
"beneficiaryInstituteBranchName": {
"type": "string",
"description": "Indicates the Branch name of the financial institution where the beneficiary account is held"
}
}
}
},
"branch": {
"type": "string",
"description": "Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"
},
"bicbranchCode": {
"type": "string",
"description": "Indicates the branch Code associated to the BIC Code"
},
"bicId": {
"type": "string",
"description": "Bank Identifier Code (BIC) of the financial institution"
},
"routingBiccode": {
"type": "string",
"description": "us:Indicates the routing number of BIC code used to identify the financial institution"
},
"parentBicCode": {
"type": "string",
"description": "Contains the Bank Identifier Code (BIC) of the parent entity."
},
"countryId": {
"type": "string",
"description": "ISO country code of the financial institution. "
},
"nationalId": {
"type": "string",
"description": "Indicates the national id of a financial institution under national clearing system"
},
"nationalIdtype": {
"type": "string",
"description": "Indicates the national bank code of the financial institution"
},
"chipsuid": {
"type": "string",
"description": "Indicates the Clearing House Interbank Payments System Universal Identifier (CHIPS) of the institution"
},
"subtypeInd": {
"type": "string",
"description": "Indicates the type of financial institution"
},
"serviceCodes": {
"type": "array",
"description": "Indicates the Value added services that the financial institution has subscribed to",
"items": {
"id": "urn:jsonschema:serviceCodes",
"properties": {
"serviceCode": {
"type": "string",
"description": "Indicates the Value added services that the financial institution has subscribed to"
}
}
}
},
"branchQualifier": {
"type": "string",
"description": "Indicates the branch qualifiers of the Bank Identifier Code (BIC). Branch Qualifiers are the operational type of the entity. Eg: ADM-Administration, BKO for Back Office"
},
"addresses": {
"type": "array",
"description": "Contains the communication address of the customer or full address of the property",
"items": {
"id": "urn:jsonschema:addresses",
"properties": {
"address": {
"type": "string",
"description": "Contains the communication address of the customer or full address of the property"
}
}
}
},
"postCode": {
"type": "string",
"description": "Identifies the address postal code for the customer or the property"
},
"bicLocations": {
"type": "array",
"description": "Location of the branch of the financial institution",
"items": {
"id": "urn:jsonschema:bicLocations",
"properties": {
"bicLocation": {
"type": "string",
"description": "Location of the branch of the financial institution"
}
}
}
},
"countryNames": {
"type": "array",
"description": "This is the country name that the financial institution resides in.",
"items": {
"id": "urn:jsonschema:countryNames",
"properties": {
"countryName": {
"type": "string",
"description": "This is the country name that the financial institution resides in."
}
}
}
},
"postBoxNumber": {
"type": "string",
"description": "Post Office Box (POB) number that relates to financial institution"
},
"validFrom": {
"type": "string",
"description": "Indicates the date from which the data set becomes effective due to a change of its attributes e.g. BIC activates/deactivates in future, collateral becomes legal."
},
"officeType": {
"type": "string",
"description": "Indicates the status of the entity in the office hierarchy e.g. Head Office, Main Payments Office"
},
"parentOfficeKey": {
"type": "string",
"description": "Indicates the key of the closest entity upwards in the entities hierarchy."
},
"headOfficeKey": {
"type": "string",
"description": "Indicates the key of the ‘HO - Head Office’ in the entities hierarchy."
},
"legalType": {
"type": "string",
"description": "Indicates the status of the entity in the legal hierarchy eg. L - Legal Entity"
},
"legalParentKey": {
"type": "string",
"description": "Indicates the key of the ‘L - Legal Entity’ in the legal hierarchy."
},
"groupType": {
"type": "string",
"description": "Indicates the type of entity that identifies the group eg. Parent or Member"
},
"institutionStatus": {
"type": "string",
"description": "Indicates the status of the institution like Bank, Money Exchange, Payment institution etc.,"
},
"cooperativeGroupKey": {
"type": "string",
"description": "Indicates the key of the cooperative central bank for that group."
},
"bankLegalEntityIdentifier": {
"type": "string",
"description": "Legal entity identifier for the bank."
},
"timeZone": {
"type": "string",
"description": "Defines the time zone of the entity"
},
"networkConnection": {
"type": "string",
"description": "Indicates the status of the entity being connected to SWIFT"
},
"groupId": {
"type": "string",
"description": "Unique ID of the group"
},
"ssiRecordKey": {
"type": "string",
"description": "Record key of the Standing Settlement Instruction (SSI) in SWIFTRef's SSI Plus directory for this participant and currency. An SSI can list which correspondent bank and which account number at that correspondent bank to use to cover payments in a given currency directed to the participant or directed at the intermediary."
},
"uploadType": {
"type": "string",
"description": "Indicates if the record is created or maintained through an upload or manually. It can contain the following values: Upload – The record is created through upload. Custom – The record is created manually."
},
"bicUploadLocation": {
"type": "string",
"description": "Indicates the directory location where files from SWIFT will be placed in order to start executing the BIC upload job"
},
"allowedCompanies": {
"type": "array",
"description": "Identifies list of companies/entities which can make use of the limit",
"items": {
"id": "urn:jsonschema:allowedCompanies",
"properties": {
"allowedCompany": {
"type": "string",
"description": "Indicates the companies where central directory record is allowed to use"
}
}
}
},
"excludedCompanies": {
"type": "array",
"description": "Indicates the companies where central directory record is excluded to use",
"items": {
"id": "urn:jsonschema:excludedCompanies",
"properties": {
"excludedCompany": {
"type": "string",
"description": "Indicates the companies where central directory record is excluded to use"
}
}
}
},
"status": {
"type": "string",
"description": "Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."
},
"changedAttributes": {
"type": "array",
"description": "Indicates the changes attributes in an application",
"items": {
"id": "urn:jsonschema:changedAttributes",
"properties": {
"recordStatus": {
"type": "string",
"description": "General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not authorised with blocking overrides - RNAU - reversed, not authorised - RNAO - reversed, not authorised with blocking overrides"
},
"resourceId": {
"type": "string",
"description": "Denotes the identifier of the resource"
},
"beneficiaryInstituteNames": {
"type": "array",
"description": "Indicates the name of financial institution where the beneficiary account is held",
"items": {
"id": "urn:jsonschema:beneficiaryInstituteNames",
"properties": {
"beneficiaryInstituteName": {
"type": "string",
"description": "Indicates the name of financial institution where the beneficiary account is held"
}
}
}
},
"beneficiaryInstituteCity": {
"type": "string",
"description": "Indicates the City of financial institution where the beneficiary account is held"
},
"beneficiaryInstituteBranchNames": {
"type": "array",
"description": "Indicates the Branch name of the financial institution where the beneficiary account is held",
"items": {
"id": "urn:jsonschema:beneficiaryInstituteBranchNames",
"properties": {
"beneficiaryInstituteBranchName": {
"type": "string",
"description": "Indicates the Branch name of the financial institution where the beneficiary account is held"
}
}
}
},
"branch": {
"type": "string",
"description": "Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"
},
"bicbranchCode": {
"type": "string",
"description": "Indicates the branch Code associated to the BIC Code"
},
"bicId": {
"type": "string",
"description": "Bank Identifier Code (BIC) of the financial institution"
},
"routingBiccode": {
"type": "string",
"description": "us:Indicates the routing number of BIC code used to identify the financial institution"
},
"parentBicCode": {
"type": "string",
"description": "Contains the Bank Identifier Code (BIC) of the parent entity."
},
"countryId": {
"type": "string",
"description": "ISO country code of the financial institution. "
},
"nationalId": {
"type": "string",
"description": "Indicates the national id of a financial institution under national clearing system"
},
"nationalIdtype": {
"type": "string",
"description": "Indicates the national bank code of the financial institution"
},
"chipsuid": {
"type": "string",
"description": "Indicates the Clearing House Interbank Payments System Universal Identifier (CHIPS) of the institution"
},
"subtypeInd": {
"type": "string",
"description": "Indicates the type of financial institution"
},
"serviceCodes": {
"type": "array",
"description": "Indicates the Value added services that the financial institution has subscribed to",
"items": {
"id": "urn:jsonschema:serviceCodes",
"properties": {
"serviceCode": {
"type": "string",
"description": "Indicates the Value added services that the financial institution has subscribed to"
}
}
}
},
"branchQualifier": {
"type": "string",
"description": "Indicates the branch qualifiers of the Bank Identifier Code (BIC). Branch Qualifiers are the operational type of the entity. Eg: ADM-Administration, BKO for Back Office"
},
"addresses": {
"type": "array",
"description": "Contains the communication address of the customer or full address of the property",
"items": {
"id": "urn:jsonschema:addresses",
"properties": {
"address": {
"type": "string",
"description": "Contains the communication address of the customer or full address of the property"
}
}
}
},
"postCode": {
"type": "string",
"description": "Identifies the address postal code for the customer or the property"
},
"bicLocations": {
"type": "array",
"description": "Location of the branch of the financial institution",
"items": {
"id": "urn:jsonschema:bicLocations",
"properties": {
"bicLocation": {
"type": "string",
"description": "Location of the branch of the financial institution"
}
}
}
},
"countryNames": {
"type": "array",
"description": "This is the country name that the financial institution resides in.",
"items": {
"id": "urn:jsonschema:countryNames",
"properties": {
"countryName": {
"type": "string",
"description": "This is the country name that the financial institution resides in."
}
}
}
},
"postBoxNumber": {
"type": "string",
"description": "Post Office Box (POB) number that relates to financial institution"
},
"validFrom": {
"type": "string",
"description": "Indicates the date from which the data set becomes effective due to a change of its attributes e.g. BIC activates/deactivates in future, collateral becomes legal."
},
"officeType": {
"type": "string",
"description": "Indicates the status of the entity in the office hierarchy e.g. Head Office, Main Payments Office"
},
"parentOfficeKey": {
"type": "string",
"description": "Indicates the key of the closest entity upwards in the entities hierarchy."
},
"headOfficeKey": {
"type": "string",
"description": "Indicates the key of the ‘HO - Head Office’ in the entities hierarchy."
},
"legalType": {
"type": "string",
"description": "Indicates the status of the entity in the legal hierarchy eg. L - Legal Entity"
},
"legalParentKey": {
"type": "string",
"description": "Indicates the key of the ‘L - Legal Entity’ in the legal hierarchy."
},
"groupType": {
"type": "string",
"description": "Indicates the type of entity that identifies the group eg. Parent or Member"
},
"institutionStatus": {
"type": "string",
"description": "Indicates the status of the institution like Bank, Money Exchange, Payment institution etc.,"
},
"cooperativeGroupKey": {
"type": "string",
"description": "Indicates the key of the cooperative central bank for that group."
},
"bankLegalEntityIdentifier": {
"type": "string",
"description": "Legal entity identifier for the bank."
},
"timeZone": {
"type": "string",
"description": "Defines the time zone of the entity"
},
"networkConnection": {
"type": "string",
"description": "Indicates the status of the entity being connected to SWIFT"
},
"groupId": {
"type": "string",
"description": "Unique ID of the group"
},
"ssiRecordKey": {
"type": "string",
"description": "Record key of the Standing Settlement Instruction (SSI) in SWIFTRef's SSI Plus directory for this participant and currency. An SSI can list which correspondent bank and which account number at that correspondent bank to use to cover payments in a given currency directed to the participant or directed at the intermediary."
},
"uploadType": {
"type": "string",
"description": "Indicates if the record is created or maintained through an upload or manually. It can contain the following values: Upload – The record is created through upload. Custom – The record is created manually."
},
"bicUploadLocation": {
"type": "string",
"description": "Indicates the directory location where files from SWIFT will be placed in order to start executing the BIC upload job"
},
"allowedCompanies": {
"type": "array",
"description": "Identifies list of companies/entities which can make use of the limit",
"items": {
"id": "urn:jsonschema:allowedCompanies",
"properties": {
"allowedCompany": {
"type": "string",
"description": "Indicates the companies where central directory record is allowed to use"
}
}
}
},
"excludedCompanies": {
"type": "array",
"description": "Indicates the companies where central directory record is excluded to use",
"items": {
"id": "urn:jsonschema:excludedCompanies",
"properties": {
"excludedCompany": {
"type": "string",
"description": "Indicates the companies where central directory record is excluded to use"
}
}
}
},
"status": {
"type": "string",
"description": "Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."
}
}
}
}
}