Class SettlementInstructionsPartsDef.SettlementFields

    • Method Detail

      • getSettlementId

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        @Nullable
        public @Nullable java.lang.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 java.lang.String getSplitComponentId()
        Returns:
        The unique ID of a split component
      • getSettlementDetailsLine1

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

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

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

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

        @Nullable
        public @Nullable java.lang.String getSettlementDetailsLine5()
        Returns:
        The fifth line of remittance information.
      • getSettlementDetailsLine6

        @Nullable
        public @Nullable java.lang.String getSettlementDetailsLine6()
        Returns:
        The sixth line of remittance information.
      • getFields

        @NotNull
        public @NotNull java.util.Map<java.lang.String,​java.lang.String> getFields()
        Specified by:
        getFields in interface Message
      • getFieldFlags

        @NotNull
        public @NotNull java.util.Map<java.lang.String,​java.util.Collection<java.lang.String>> getFieldFlags()
        Specified by:
        getFieldFlags in interface BuilderMessage
        Returns:
        Get the flags for all fields.
      • getFlagFields

        @NotNull
        public @NotNull java.util.Map<java.lang.String,​java.util.Collection<java.lang.String>> getFlagFields()
        Specified by:
        getFlagFields in interface BuilderMessage
        Returns:
        Get the fields for all flags.
      • toString

        @NotNull
        public @NotNull java.lang.String toString()
        Overrides:
        toString in class java.lang.Object