Event Name
updateSettlement.settlementUpdated
Domain
holdings
Description

Indicates amendment to the settlement condition.

Properties
{
    "baseDetails": {
        "type": "object",
        "description": "Indicates the identifier for base details in which system reference, base contract reference, event name, effective date and other related details are defined",
        "id": "urn:jsonschema:MCYBaseDetails",
        "properties": {
            "contractReference": {
                "type": "string",
                "description": "Contains the contract reference"
            },
            "systemReference": {
                "type": "string",
                "description": "Contains the identifier for the system in which the event originated from. For ex, ‘Hogan’ or ‘TransactAccounts’ etc"
            },
            "companyReference": {
                "type": "string",
                "description": "Contains the identifier of the underlying Entity or Company or Branch"
            },
            "eventName": {
                "type": "string",
                "description": "The name that is displayed for the event"
            },
            "baseEventIdentifier": {
                "type": "string",
                "description": "Indicates the name of the event that is happening in the core system"
            },
            "effectiveDate": {
                "type": "string",
                "description": "Contains the identifier for the transaction date. Dates are expected in ‘YYYYMMDD’ format"
            },
            "bookingDate": {
                "type": "string",
                "description": "Indicates the date on which this business activity is booked in the underlying system. The effective date and booking date could be different if systems allow forward/back dated business transactions. Dates are expected in YYYYMMDD format. If booking date is not passed, effective date would be assumed as booking date."
            },
            "contractCurrency": {
                "type": "string",
                "description": "Indicates the currency associated with the contract"
            },
            "channel": {
                "type": "string",
                "description": "Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"
            },
            "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"
            },
            "lineOfBusiness": {
                "type": "string",
                "description": "Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"
            },
            "activityDateTimeStamp": {
                "type": "string",
                "description": "Contains the date and time of activity triggered."
            },
            "transactionReference": {
                "type": "string",
                "description": "Contains the identifier for the transaction in the core system"
            },
            "reversalIndicator": {
                "type": "boolean",
                "description": "Indicates whether the underlying transaction is reversed so that the details of the same could be removed from Enterprise product pricing system"
            },
            "originationReference": {
                "type": "string",
                "description": "Identifier of the account in source system, eg, a origination system."
            },
            "contractStatus": {
                "type": "string",
                "description": "Contains the status of the contract, e.g. open, matured or liquidated, unauthorised or authorised, closed."
            },
            "feeDetails": {
                "type": "array",
                "description": "Indicates the identifier for fee details in which fee name, fee amount, adjsuted fee amount are defined",
                "items": {
                    "id": "urn:jsonschema:FeeDetails",
                    "properties": {
                        "feeName": {
                            "type": "string",
                            "description": "Indicates the description for type of fee which is applied for payment instruction"
                        },
                        "feeAmount": {
                            "type": "string",
                            "description": "Indicates the fee amount which is applied for the payment instruction"
                        },
                        "feeCurrency": {
                            "type": "string",
                            "description": "Indicates the fee currency in which fee amount is applied for the payment instruction"
                        },
                        "adjustFeeAmount": {
                            "type": "string",
                            "description": "Indicates the adjustment detail if the base fee is adjusted for some reason in the system. This is a signed number. Hence if any decrease in fee should be indicated with a negative sign."
                        },
                        "adjustFeeReason": {
                            "type": "string",
                            "description": "Indicates the reason for adjusting the base fee. System use adjust fee reason for analytics purpose."
                        }
                    }
                }
            }
        }
    },
    "settlementDetails": {
        "type": "array",
        "description": "Contains the settlement details like payin instructions, payout instructions defined in the transaction.",
        "items": {
            "id": "urn:jsonschema:Settlement",
            "properties": {
                "payinSettlement": {
                    "type": "array",
                    "description": "Flag to indicate whether Payin Settlement instruction is required or not.Valid input is Yes or No.Default value is Yes.",
                    "items": {
                        "id": "urn:jsonschema:PayinSettlement",
                        "properties": {
                            "payinPaymentTypes": {
                                "type": "array",
                                "description": "It denotes the payment type based on which the repayment settlement instruction will be processed",
                                "items": {
                                    "id": "urn:jsonschema:PayinPaymentTypes",
                                    "properties": {
                                        "payinPaymentType": {
                                            "type": "string",
                                            "description": "It denotes the payment type based on which the repayment settlement instruction will be processed"
                                        },
                                        "description": {
                                            "type": "string",
                                            "description": "Indicates the description of the contract"
                                        }
                                    }
                                }
                            },
                            "payinDetails": {
                                "type": "array",
                                "description": "Contains the  payin instructions like payin account, payin beneficiary and payin payment order product defined in the transaction.",
                                "items": {
                                    "id": "urn:jsonschema:PayinDetails",
                                    "properties": {
                                        "payInPoProduct": {
                                            "type": "string",
                                            "description": "Contains the payment order product Id for which the payment is initiated"
                                        },
                                        "payInAccount": {
                                            "type": "string",
                                            "description": "Contains the account from which funds are to be debited against the payment type"
                                        },
                                        "payInBeneficiary": {
                                            "type": "string",
                                            "description": "Contains the beneficiary Id used for settlement of the bills due"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "payoutSettlement": {
                    "type": "array",
                    "description": "Flag to indicate whether Payout Settlement instruction is required or not.Valid input is Yes or No.Default value is Yes.",
                    "items": {
                        "id": "urn:jsonschema:PayoutSettlement",
                        "properties": {
                            "payoutDetails": {
                                "type": "array",
                                "description": "Contains the  payout instructions like payout account, payout beneficiary and payout payment order product defined in the transaction.",
                                "items": {
                                    "id": "urn:jsonschema:PayoutDetails",
                                    "properties": {
                                        "payoutAccount": {
                                            "type": "string",
                                            "description": "The account to which a settlement amount is transferred."
                                        },
                                        "payoutBeneficiary": {
                                            "type": "string",
                                            "description": "The beneficiary that payment should be made to ."
                                        },
                                        "payOutPoProduct": {
                                            "type": "string",
                                            "description": "Contains the payout payment order product for which payment is initiated"
                                        }
                                    }
                                }
                            },
                            "payOutPropertyClasses": {
                                "type": "array",
                                "description": "Contains the different payout options, for example charge, interest or principal on which the payout settlement instructions would be processed",
                                "items": {
                                    "id": "urn:jsonschema:PayOutPropertyClasses",
                                    "properties": {
                                        "propertyClassId": {
                                            "type": "string",
                                            "description": "The identifier of a condition that is used to build a product"
                                        },
                                        "propertyClassName": {
                                            "type": "string",
                                            "description": "The name of the condition that is used to build a product"
                                        }
                                    }
                                }
                            },
                            "payOutProperties": {
                                "type": "array",
                                "description": "Contains the different payout options, for example management charge, principal interest or commitment on which the payout settlement instructions would be processed",
                                "items": {
                                    "id": "urn:jsonschema:PayOutProperties",
                                    "properties": {
                                        "propertyId": {
                                            "type": "string",
                                            "description": "The identifier of the product condition"
                                        },
                                        "propertyName": {
                                            "type": "string",
                                            "description": "Indicates the  property description to which benefit has been applied"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "defaultSettlementAccounts": {
                    "type": "array",
                    "description": "Default settlement account to be used for all incoming payments and outgoing settlements when a specific settlement account is not provided for each payment type",
                    "items": {
                        "id": "urn:jsonschema:DefaultSettlementAccounts",
                        "properties": {
                            "defaultSettlementAccount": {
                                "type": "string",
                                "description": "Default settlement account to be used for all incoming payments and outgoing settlements when a specific settlement account is not provided for each payment type"
                            }
                        }
                    }
                },
                "extension": {
                    "type": "array",
                    "description": "",
                    "items": {
                        "id": "urn:jsonschema:Extension",
                        "properties": {
                            "key": {
                                "type": "string",
                                "description": "Key to a specific extension"
                            },
                            "values": {
                                "type": "array",
                                "description": "Values associated to the key for extension",
                                "items": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "subAccounts": {
        "type": "object",
        "description": "The sub-account that the security position is held in.",
        "id": "urn:jsonschema:subAccountDetails",
        "properties": {
            "subAccount": {
                "type": "string",
                "description": "The sub-account that the security position is held in."
            },
            "currency": {
                "type": "string",
                "description": "Identifies the currency. E.g. USD, GBP etc"
            }
        }
    },
    "previousState": {
        "type": "object",
        "description": "Contains the previous value of the attribute before the update",
        "id": "urn:jsonschema:PreviousState",
        "properties": {
            "settlementDetails": {
                "type": "array",
                "description": "Contains the settlement details like payin instructions, payout instructions defined in the transaction.",
                "items": {
                    "id": "urn:jsonschema:Settlement",
                    "properties": {
                        "payinSettlement": {
                            "type": "array",
                            "description": "Flag to indicate whether Payin Settlement instruction is required or not.Valid input is Yes or No.Default value is Yes.",
                            "items": {
                                "id": "urn:jsonschema:PayinSettlement",
                                "properties": {
                                    "payinPaymentTypes": {
                                        "type": "array",
                                        "description": "It denotes the payment type based on which the repayment settlement instruction will be processed",
                                        "items": {
                                            "id": "urn:jsonschema:PayinPaymentTypes",
                                            "properties": {
                                                "payinPaymentType": {
                                                    "type": "string",
                                                    "description": "It denotes the payment type based on which the repayment settlement instruction will be processed"
                                                },
                                                "description": {
                                                    "type": "string",
                                                    "description": "Indicates the description of the contract"
                                                }
                                            }
                                        }
                                    },
                                    "payinDetails": {
                                        "type": "array",
                                        "description": "Contains the  payin instructions like payin account, payin beneficiary and payin payment order product defined in the transaction.",
                                        "items": {
                                            "id": "urn:jsonschema:PayinDetails",
                                            "properties": {
                                                "payInPoProduct": {
                                                    "type": "string",
                                                    "description": "Contains the payment order product Id for which the payment is initiated"
                                                },
                                                "payInAccount": {
                                                    "type": "string",
                                                    "description": "Contains the account from which funds are to be debited against the payment type"
                                                },
                                                "payInBeneficiary": {
                                                    "type": "string",
                                                    "description": "Contains the beneficiary Id used for settlement of the bills due"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "payoutSettlement": {
                            "type": "array",
                            "description": "Flag to indicate whether Payout Settlement instruction is required or not.Valid input is Yes or No.Default value is Yes.",
                            "items": {
                                "id": "urn:jsonschema:PayoutSettlement",
                                "properties": {
                                    "payoutDetails": {
                                        "type": "array",
                                        "description": "Contains the  payout instructions like payout account, payout beneficiary and payout payment order product defined in the transaction.",
                                        "items": {
                                            "id": "urn:jsonschema:PayoutDetails",
                                            "properties": {
                                                "payoutAccount": {
                                                    "type": "string",
                                                    "description": "The account to which a settlement amount is transferred."
                                                },
                                                "payoutBeneficiary": {
                                                    "type": "string",
                                                    "description": "The beneficiary that payment should be made to ."
                                                },
                                                "payOutPoProduct": {
                                                    "type": "string",
                                                    "description": "Contains the payout payment order product for which payment is initiated"
                                                }
                                            }
                                        }
                                    },
                                    "payOutPropertyClasses": {
                                        "type": "array",
                                        "description": "Contains the different payout options, for example charge, interest or principal on which the payout settlement instructions would be processed",
                                        "items": {
                                            "id": "urn:jsonschema:PayOutPropertyClasses",
                                            "properties": {
                                                "propertyClassId": {
                                                    "type": "string",
                                                    "description": "The identifier of a condition that is used to build a product"
                                                },
                                                "propertyClassName": {
                                                    "type": "string",
                                                    "description": "The name of the condition that is used to build a product"
                                                }
                                            }
                                        }
                                    },
                                    "payOutProperties": {
                                        "type": "array",
                                        "description": "Contains the different payout options, for example management charge, principal interest or commitment on which the payout settlement instructions would be processed",
                                        "items": {
                                            "id": "urn:jsonschema:PayOutProperties",
                                            "properties": {
                                                "propertyId": {
                                                    "type": "string",
                                                    "description": "The identifier of the product condition"
                                                },
                                                "propertyName": {
                                                    "type": "string",
                                                    "description": "Indicates the  property description to which benefit has been applied"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "defaultSettlementAccounts": {
                            "type": "array",
                            "description": "Default settlement account to be used for all incoming payments and outgoing settlements when a specific settlement account is not provided for each payment type",
                            "items": {
                                "id": "urn:jsonschema:DefaultSettlementAccounts",
                                "properties": {
                                    "defaultSettlementAccount": {
                                        "type": "string",
                                        "description": "Default settlement account to be used for all incoming payments and outgoing settlements when a specific settlement account is not provided for each payment type"
                                    }
                                }
                            }
                        },
                        "extension": {
                            "type": "array",
                            "description": "",
                            "items": {
                                "id": "urn:jsonschema:Extension",
                                "properties": {
                                    "key": {
                                        "type": "string",
                                        "description": "Key to a specific extension"
                                    },
                                    "values": {
                                        "type": "array",
                                        "description": "Values associated to the key for extension",
                                        "items": {
                                            "type": "string"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}