Class TransferLimit


  • public class TransferLimit
    extends Object
    The transfer limit configured to regulate outgoing transfers.
    • Constructor Detail

      • TransferLimit

        public TransferLimit()
    • Method Detail

      • amount

        public TransferLimit amount​(Amount amount)
        amount
        Parameters:
        amount -
        Returns:
        the current TransferLimit instance, allowing for method chaining
      • getAmount

        public Amount getAmount()
        Get amount
        Returns:
        amount
      • setAmount

        public void setAmount​(Amount amount)
        amount
        Parameters:
        amount -
      • endsAt

        public TransferLimit endsAt​(OffsetDateTime endsAt)
        The date and time when the transfer limit becomes inactive. If you do not specify an end date, the limit stays active until you override it with a new limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
        Parameters:
        endsAt - The date and time when the transfer limit becomes inactive. If you do not specify an end date, the limit stays active until you override it with a new limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
        Returns:
        the current TransferLimit instance, allowing for method chaining
      • getEndsAt

        public OffsetDateTime getEndsAt()
        The date and time when the transfer limit becomes inactive. If you do not specify an end date, the limit stays active until you override it with a new limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
        Returns:
        endsAt The date and time when the transfer limit becomes inactive. If you do not specify an end date, the limit stays active until you override it with a new limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
      • setEndsAt

        public void setEndsAt​(OffsetDateTime endsAt)
        The date and time when the transfer limit becomes inactive. If you do not specify an end date, the limit stays active until you override it with a new limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
        Parameters:
        endsAt - The date and time when the transfer limit becomes inactive. If you do not specify an end date, the limit stays active until you override it with a new limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
      • id

        public TransferLimit id​(String id)
        The unique identifier of the transfer limit.
        Parameters:
        id - The unique identifier of the transfer limit.
        Returns:
        the current TransferLimit instance, allowing for method chaining
      • getId

        public String getId()
        The unique identifier of the transfer limit.
        Returns:
        id The unique identifier of the transfer limit.
      • setId

        public void setId​(String id)
        The unique identifier of the transfer limit.
        Parameters:
        id - The unique identifier of the transfer limit.
      • limitStatus

        public TransferLimit limitStatus​(LimitStatus limitStatus)
        limitStatus
        Parameters:
        limitStatus -
        Returns:
        the current TransferLimit instance, allowing for method chaining
      • getLimitStatus

        public LimitStatus getLimitStatus()
        Get limitStatus
        Returns:
        limitStatus
      • setLimitStatus

        public void setLimitStatus​(LimitStatus limitStatus)
        limitStatus
        Parameters:
        limitStatus -
      • reference

        public TransferLimit reference​(String reference)
        Your reference for the transfer limit.
        Parameters:
        reference - Your reference for the transfer limit.
        Returns:
        the current TransferLimit instance, allowing for method chaining
      • getReference

        public String getReference()
        Your reference for the transfer limit.
        Returns:
        reference Your reference for the transfer limit.
      • setReference

        public void setReference​(String reference)
        Your reference for the transfer limit.
        Parameters:
        reference - Your reference for the transfer limit.
      • scaInformation

        public TransferLimit scaInformation​(ScaInformation scaInformation)
        scaInformation
        Parameters:
        scaInformation -
        Returns:
        the current TransferLimit instance, allowing for method chaining
      • getScaInformation

        public ScaInformation getScaInformation()
        Get scaInformation
        Returns:
        scaInformation
      • setScaInformation

        public void setScaInformation​(ScaInformation scaInformation)
        scaInformation
        Parameters:
        scaInformation -
      • scope

        public TransferLimit scope​(Scope scope)
        scope
        Parameters:
        scope -
        Returns:
        the current TransferLimit instance, allowing for method chaining
      • getScope

        public Scope getScope()
        Get scope
        Returns:
        scope
      • setScope

        public void setScope​(Scope scope)
        scope
        Parameters:
        scope -
      • startsAt

        public TransferLimit startsAt​(OffsetDateTime startsAt)
        The date and time when the transfer limit becomes active. If you specify a date in the future, we will schedule a transfer limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
        Parameters:
        startsAt - The date and time when the transfer limit becomes active. If you specify a date in the future, we will schedule a transfer limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
        Returns:
        the current TransferLimit instance, allowing for method chaining
      • getStartsAt

        public OffsetDateTime getStartsAt()
        The date and time when the transfer limit becomes active. If you specify a date in the future, we will schedule a transfer limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
        Returns:
        startsAt The date and time when the transfer limit becomes active. If you specify a date in the future, we will schedule a transfer limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
      • setStartsAt

        public void setStartsAt​(OffsetDateTime startsAt)
        The date and time when the transfer limit becomes active. If you specify a date in the future, we will schedule a transfer limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
        Parameters:
        startsAt - The date and time when the transfer limit becomes active. If you specify a date in the future, we will schedule a transfer limit. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): **YYYY-MM-DDThh:mm:ss.sssTZD**
      • transferType

        public TransferLimit transferType​(TransferType transferType)
        transferType
        Parameters:
        transferType -
        Returns:
        the current TransferLimit instance, allowing for method chaining
      • getTransferType

        public TransferType getTransferType()
        Get transferType
        Returns:
        transferType
      • setTransferType

        public void setTransferType​(TransferType transferType)
        transferType
        Parameters:
        transferType -
      • equals

        public boolean equals​(Object o)
        Return true if this TransferLimit object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • fromJson

        public static TransferLimit fromJson​(String jsonString)
                                      throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of TransferLimit given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of TransferLimit
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to TransferLimit
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of TransferLimit to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException