Package io.moov.sdk.models.components

Class Sweep

  • public class Sweep
extends java.lang.Object

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Sweep.Builder  

    • Constructor Summary

      Constructors 
      Constructor Description
      Sweep​(java.lang.String sweepID, SweepStatus status, java.lang.String accruedAmount, java.lang.String currency, java.time.OffsetDateTime accrualStartedOn)  
      Sweep​(java.lang.String sweepID, SweepStatus status, java.lang.String accruedAmount, java.util.Optional<java.lang.String> residualBalance, java.lang.String currency, java.time.OffsetDateTime accrualStartedOn, java.util.Optional<java.time.OffsetDateTime> accrualEndedOn, java.util.Optional<java.lang.String> pushPaymentMethodID, java.util.Optional<java.lang.String> pullPaymentMethodID, java.util.Optional<java.lang.String> transferID, java.util.Optional<java.lang.String> transferAmount, java.util.Optional<java.lang.String> statementDescriptor, java.util.Optional<? extends java.util.List<SweepSubtotal>> subtotals)  

    • Constructor Detail

      • Sweep

        public Sweep​(java.lang.String sweepID,
             SweepStatus status,
             java.lang.String accruedAmount,
             java.util.Optional<java.lang.String> residualBalance,
             java.lang.String currency,
             java.time.OffsetDateTime accrualStartedOn,
             java.util.Optional<java.time.OffsetDateTime> accrualEndedOn,
             java.util.Optional<java.lang.String> pushPaymentMethodID,
             java.util.Optional<java.lang.String> pullPaymentMethodID,
             java.util.Optional<java.lang.String> transferID,
             java.util.Optional<java.lang.String> transferAmount,
             java.util.Optional<java.lang.String> statementDescriptor,
             java.util.Optional<? extends java.util.List<SweepSubtotal>> subtotals)

      • Sweep

        public Sweep​(java.lang.String sweepID,
             SweepStatus status,
             java.lang.String accruedAmount,
             java.lang.String currency,
             java.time.OffsetDateTime accrualStartedOn)

    • Method Detail

      • sweepID

        public java.lang.String sweepID()

      • accruedAmount

        public java.lang.String accruedAmount()
        The total net amount of wallet transactions accrued in the sweep.

      • residualBalance

        public java.util.Optional<java.lang.String> residualBalance()
        Amount remaining in the wallet after the sweep transfer completes.

      • currency

        public java.lang.String currency()
        A 3-letter ISO 4217 currency code.

      • accrualStartedOn

        public java.time.OffsetDateTime accrualStartedOn()
        The date-time the sweep began accruing transactions.

      • accrualEndedOn

        public java.util.Optional<java.time.OffsetDateTime> accrualEndedOn()
        The date-time the sweep stopped accruing transactions.

      • pushPaymentMethodID

        public java.util.Optional<java.lang.String> pushPaymentMethodID()
        ID of the payment method.

      • pullPaymentMethodID

        public java.util.Optional<java.lang.String> pullPaymentMethodID()
        ID of the payment method.

      • transferID

        public java.util.Optional<java.lang.String> transferID()

      • transferAmount

        public java.util.Optional<java.lang.String> transferAmount()
        Amount that is transferred.

      • statementDescriptor

        public java.util.Optional<java.lang.String> statementDescriptor()
        The text that appears on the banking statement. The default descriptor is a 10 character ID if an override is not set in the sweep configs statementDescriptor.

      • subtotals

        public java.util.Optional<java.util.List<SweepSubtotal>> subtotals()
        The subtotal of each transaction type contributing to the sweep's accrued amount.

      • withSweepID

        public Sweep withSweepID​(java.lang.String sweepID)

      • withAccruedAmount

        public Sweep withAccruedAmount​(java.lang.String accruedAmount)
        The total net amount of wallet transactions accrued in the sweep.

      • withResidualBalance

        public Sweep withResidualBalance​(java.lang.String residualBalance)
        Amount remaining in the wallet after the sweep transfer completes.

      • withResidualBalance

        public Sweep withResidualBalance​(java.util.Optional<java.lang.String> residualBalance)
        Amount remaining in the wallet after the sweep transfer completes.

      • withCurrency

        public Sweep withCurrency​(java.lang.String currency)
        A 3-letter ISO 4217 currency code.

      • withAccrualStartedOn

        public Sweep withAccrualStartedOn​(java.time.OffsetDateTime accrualStartedOn)
        The date-time the sweep began accruing transactions.

      • withAccrualEndedOn

        public Sweep withAccrualEndedOn​(java.time.OffsetDateTime accrualEndedOn)
        The date-time the sweep stopped accruing transactions.

      • withAccrualEndedOn

        public Sweep withAccrualEndedOn​(java.util.Optional<java.time.OffsetDateTime> accrualEndedOn)
        The date-time the sweep stopped accruing transactions.

      • withPushPaymentMethodID

        public Sweep withPushPaymentMethodID​(java.lang.String pushPaymentMethodID)
        ID of the payment method.

      • withPushPaymentMethodID

        public Sweep withPushPaymentMethodID​(java.util.Optional<java.lang.String> pushPaymentMethodID)
        ID of the payment method.

      • withPullPaymentMethodID

        public Sweep withPullPaymentMethodID​(java.lang.String pullPaymentMethodID)
        ID of the payment method.

      • withPullPaymentMethodID

        public Sweep withPullPaymentMethodID​(java.util.Optional<java.lang.String> pullPaymentMethodID)
        ID of the payment method.

      • withTransferID

        public Sweep withTransferID​(java.lang.String transferID)

      • withTransferID

        public Sweep withTransferID​(java.util.Optional<java.lang.String> transferID)

      • withTransferAmount

        public Sweep withTransferAmount​(java.lang.String transferAmount)
        Amount that is transferred.

      • withTransferAmount

        public Sweep withTransferAmount​(java.util.Optional<java.lang.String> transferAmount)
        Amount that is transferred.

      • withStatementDescriptor

        public Sweep withStatementDescriptor​(java.lang.String statementDescriptor)
        The text that appears on the banking statement. The default descriptor is a 10 character ID if an override is not set in the sweep configs statementDescriptor.

      • withStatementDescriptor

        public Sweep withStatementDescriptor​(java.util.Optional<java.lang.String> statementDescriptor)
        The text that appears on the banking statement. The default descriptor is a 10 character ID if an override is not set in the sweep configs statementDescriptor.

      • withSubtotals

        public Sweep withSubtotals​(java.util.List<SweepSubtotal> subtotals)
        The subtotal of each transaction type contributing to the sweep's accrued amount.

      • withSubtotals

        public Sweep withSubtotals​(java.util.Optional<? extends java.util.List<SweepSubtotal>> subtotals)
        The subtotal of each transaction type contributing to the sweep's accrued amount.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

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