Package io.moov.sdk.models.errors

Class Transfer

  • All Implemented Interfaces:
    java.io.Serializable
    public class Transfer
extends java.lang.RuntimeException
    Transfer

    Details of a Transfer.

    See Also:
    Serialized Form

    • Constructor Detail

      • Transfer

        public Transfer​(java.lang.String transferID,
                java.time.OffsetDateTime createdOn,
                TransferSource source,
                TransferDestination destination,
                java.util.Optional<java.time.OffsetDateTime> completedOn,
                TransferStatus status,
                java.util.Optional<? extends TransferFailureReason> failureReason,
                Amount amount,
                java.util.Optional<java.lang.String> description,
                java.util.Optional<? extends java.util.Map<java.lang.String,​java.lang.String>> metadata,
                java.util.Optional<? extends FacilitatorFee> facilitatorFee,
                java.util.Optional<java.lang.Long> moovFee,
                java.util.Optional<java.lang.String> moovFeeDecimal,
                java.util.Optional<? extends MoovFeeDetails> moovFeeDetails,
                java.util.Optional<? extends java.util.List<MoovFee>> moovFees,
                java.util.Optional<java.lang.String> groupID,
                java.util.Optional<? extends java.util.List<Cancellation>> cancellations,
                java.util.Optional<? extends Amount> refundedAmount,
                java.util.Optional<? extends java.util.List<CardAcquiringRefund>> refunds,
                java.util.Optional<? extends Amount> disputedAmount,
                java.util.Optional<? extends java.util.List<CardAcquiringDispute>> disputes,
                java.util.Optional<java.lang.String> sweepID,
                java.util.Optional<java.lang.String> scheduleID,
                java.util.Optional<java.lang.String> occurrenceID,
                java.util.Optional<java.lang.String> paymentLinkCode,
                java.util.Optional<? extends Amount> salesTaxAmount)

    • Method Detail

      • transferID

        public java.lang.String transferID()

      • createdOn

        public java.time.OffsetDateTime createdOn()

      • completedOn

        public java.util.Optional<java.time.OffsetDateTime> completedOn()

      • failureReason

        public java.util.Optional<TransferFailureReason> failureReason()
        Reason for a transfer's failure.

      • amount

        public Amount amount()

      • description

        public java.util.Optional<java.lang.String> description()
        An optional description of the transfer that is used on receipts and for your own internal use.

      • metadata

        public java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>> metadata()
        Free-form key-value pair list. Useful for storing information that is not captured elsewhere.

      • facilitatorFee

        public java.util.Optional<FacilitatorFee> facilitatorFee()
        Total or markup fee.

      • moovFee

        public java.util.Optional<java.lang.Long> moovFee()
        Fees charged to your platform account for transfers.

      • moovFeeDecimal

        public java.util.Optional<java.lang.String> moovFeeDecimal()
        Same as `moovFee`, but a decimal-formatted numerical string that represents up to 9 decimal place precision.

      • moovFeeDetails

        public java.util.Optional<MoovFeeDetails> moovFeeDetails()
        Processing and pass-through costs that add up to the moovFee.

      • moovFees

        public java.util.Optional<java.util.List<MoovFee>> moovFees()
        Fees charged to accounts involved in the transfer.

      • groupID

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

      • cancellations

        public java.util.Optional<java.util.List<Cancellation>> cancellations()

      • refundedAmount

        public java.util.Optional<Amount> refundedAmount()

      • disputedAmount

        public java.util.Optional<Amount> disputedAmount()

      • sweepID

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

      • scheduleID

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

      • occurrenceID

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

      • paymentLinkCode

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

      • salesTaxAmount

        public java.util.Optional<Amount> salesTaxAmount()
        Optional sales tax amount. `transfer.amount.value` should be inclusive of any sales tax and represents the total amount charged.

      • withTransferID

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

      • withCreatedOn

        public Transfer withCreatedOn​(java.time.OffsetDateTime createdOn)

      • withCompletedOn

        public Transfer withCompletedOn​(java.time.OffsetDateTime completedOn)

      • withCompletedOn

        public Transfer withCompletedOn​(java.util.Optional<java.time.OffsetDateTime> completedOn)

      • withFailureReason

        public Transfer withFailureReason​(java.util.Optional<? extends TransferFailureReason> failureReason)
        Reason for a transfer's failure.

      • withDescription

        public Transfer withDescription​(java.lang.String description)
        An optional description of the transfer that is used on receipts and for your own internal use.

      • withDescription

        public Transfer withDescription​(java.util.Optional<java.lang.String> description)
        An optional description of the transfer that is used on receipts and for your own internal use.

      • withMetadata

        public Transfer withMetadata​(java.util.Map<java.lang.String,​java.lang.String> metadata)
        Free-form key-value pair list. Useful for storing information that is not captured elsewhere.

      • withMetadata

        public Transfer withMetadata​(java.util.Optional<? extends java.util.Map<java.lang.String,​java.lang.String>> metadata)
        Free-form key-value pair list. Useful for storing information that is not captured elsewhere.

      • withFacilitatorFee

        public Transfer withFacilitatorFee​(FacilitatorFee facilitatorFee)
        Total or markup fee.

      • withFacilitatorFee

        public Transfer withFacilitatorFee​(java.util.Optional<? extends FacilitatorFee> facilitatorFee)
        Total or markup fee.

      • withMoovFee

        public Transfer withMoovFee​(long moovFee)
        Fees charged to your platform account for transfers.

      • withMoovFee

        public Transfer withMoovFee​(java.util.Optional<java.lang.Long> moovFee)
        Fees charged to your platform account for transfers.

      • withMoovFeeDecimal

        public Transfer withMoovFeeDecimal​(java.lang.String moovFeeDecimal)
        Same as `moovFee`, but a decimal-formatted numerical string that represents up to 9 decimal place precision.

      • withMoovFeeDecimal

        public Transfer withMoovFeeDecimal​(java.util.Optional<java.lang.String> moovFeeDecimal)
        Same as `moovFee`, but a decimal-formatted numerical string that represents up to 9 decimal place precision.

      • withMoovFeeDetails

        public Transfer withMoovFeeDetails​(MoovFeeDetails moovFeeDetails)
        Processing and pass-through costs that add up to the moovFee.

      • withMoovFeeDetails

        public Transfer withMoovFeeDetails​(java.util.Optional<? extends MoovFeeDetails> moovFeeDetails)
        Processing and pass-through costs that add up to the moovFee.

      • withMoovFees

        public Transfer withMoovFees​(java.util.List<MoovFee> moovFees)
        Fees charged to accounts involved in the transfer.

      • withMoovFees

        public Transfer withMoovFees​(java.util.Optional<? extends java.util.List<MoovFee>> moovFees)
        Fees charged to accounts involved in the transfer.

      • withGroupID

        public Transfer withGroupID​(java.lang.String groupID)

      • withGroupID

        public Transfer withGroupID​(java.util.Optional<java.lang.String> groupID)

      • withCancellations

        public Transfer withCancellations​(java.util.List<Cancellation> cancellations)

      • withCancellations

        public Transfer withCancellations​(java.util.Optional<? extends java.util.List<Cancellation>> cancellations)

      • withRefundedAmount

        public Transfer withRefundedAmount​(Amount refundedAmount)

      • withRefundedAmount

        public Transfer withRefundedAmount​(java.util.Optional<? extends Amount> refundedAmount)

      • withDisputedAmount

        public Transfer withDisputedAmount​(Amount disputedAmount)

      • withDisputedAmount

        public Transfer withDisputedAmount​(java.util.Optional<? extends Amount> disputedAmount)

      • withSweepID

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

      • withSweepID

        public Transfer withSweepID​(java.util.Optional<java.lang.String> sweepID)

      • withScheduleID

        public Transfer withScheduleID​(java.lang.String scheduleID)

      • withScheduleID

        public Transfer withScheduleID​(java.util.Optional<java.lang.String> scheduleID)

      • withOccurrenceID

        public Transfer withOccurrenceID​(java.lang.String occurrenceID)

      • withOccurrenceID

        public Transfer withOccurrenceID​(java.util.Optional<java.lang.String> occurrenceID)

      • withPaymentLinkCode

        public Transfer withPaymentLinkCode​(java.lang.String paymentLinkCode)

      • withPaymentLinkCode

        public Transfer withPaymentLinkCode​(java.util.Optional<java.lang.String> paymentLinkCode)

      • withSalesTaxAmount

        public Transfer withSalesTaxAmount​(Amount salesTaxAmount)
        Optional sales tax amount. `transfer.amount.value` should be inclusive of any sales tax and represents the total amount charged.

      • withSalesTaxAmount

        public Transfer withSalesTaxAmount​(java.util.Optional<? extends Amount> salesTaxAmount)
        Optional sales tax amount. `transfer.amount.value` should be inclusive of any sales tax and represents the total amount charged.

      • 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.Throwable