Class SettlementInstructionsPartsDef.SettlementFields

    • Method Detail

      • getSettlementId

        @Nullable
        public @Nullable String getSettlementId()
        Returns:
        The identifier for the settlement instruction.
      • getSettlementCurrency

        @Nullable
        public @Nullable String getSettlementCurrency()
        Returns:
        A currency for of settlement instruction
      • getSettlementAmount

        @Nullable
        public @Nullable BigDecimal getSettlementAmount()
        Returns:
        The amount of a settlement
      • getSettlementDirection

        @Nullable
        public @Nullable String getSettlementDirection()
        Returns:
        The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH
      • getIsDefaultSettlementInstruction

        @Nullable
        public @Nullable Boolean getIsDefaultSettlementInstruction()
        Returns:
        Is this the default settlement instruction for this currency
      • getSettlementInstructionType

        @Nullable
        public @Nullable String getSettlementInstructionType()
        Returns:
        The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]
      • getSettlementDisplayName

        @Nullable
        public @Nullable String getSettlementDisplayName()
        Returns:
        The name of the settlement instruction. This field can be omitted.
      • getSettlementStatus

        @Nullable
        public @Nullable String getSettlementStatus()
        Returns:
        Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]
      • getBankAccount

        @Nullable
        public @Nullable String getBankAccount()
        Returns:
        The account number of the bank
      • getBankSwift

        @Nullable
        public @Nullable String getBankSwift()
        Returns:
        The BIC of the bank
      • getBankName

        @Nullable
        public @Nullable String getBankName()
        Returns:
        The name of the bank
      • getBankAddress1

        @Nullable
        public @Nullable String getBankAddress1()
        Returns:
        The first line of the bank's address
      • getBankAddress2

        @Nullable
        public @Nullable String getBankAddress2()
        Returns:
        The second line of the bank's address
      • getBankAddress3

        @Nullable
        public @Nullable String getBankAddress3()
        Returns:
        The third line of the bank's address
      • getIndividualAccount

        @Nullable
        public @Nullable String getIndividualAccount()
        Returns:
        The account number of the recipient
      • getIndividualSwift

        @Nullable
        public @Nullable String getIndividualSwift()
        Returns:
        The BIC of the recipient's account
      • getIndividualName

        @Nullable
        public @Nullable String getIndividualName()
        Returns:
        The name of the payee or payee's bank
      • getIndividualAddress1

        @Nullable
        public @Nullable String getIndividualAddress1()
        Returns:
        The first line of the recipient
      • getIndividualAddress2

        @Nullable
        public @Nullable String getIndividualAddress2()
        Returns:
        The second line of the recipient
      • getNettingStatus

        @Nullable
        public @Nullable String getNettingStatus()
        Returns:
        The status that denotes the permanent netting state of a settlement. This is required to know which settlements have been netted and which have not
      • getSplitComponentId

        @Nullable
        public @Nullable String getSplitComponentId()
        Returns:
        The unique ID of a split component
      • getSettlementDetailsLine1

        @Nullable
        public @Nullable String getSettlementDetailsLine1()
        Returns:
        The first line of remittance information.
      • getSettlementDetailsLine2

        @Nullable
        public @Nullable String getSettlementDetailsLine2()
        Returns:
        The second line of remittance information.
      • getSettlementDetailsLine3

        @Nullable
        public @Nullable String getSettlementDetailsLine3()
        Returns:
        The third line of remittance information.
      • getSettlementDetailsLine4

        @Nullable
        public @Nullable String getSettlementDetailsLine4()
        Returns:
        The fourth line of remittance information.