Class TransferEvent


  • public class TransferEvent
    extends Object
    TransferEvent
    • Constructor Detail

      • TransferEvent

        public TransferEvent()
    • Method Detail

      • amount

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

        public Amount getAmount()
        amount
        Returns:
        amount
      • setAmount

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

        public TransferEvent amountAdjustments​(List<AmountAdjustment> amountAdjustments)
        The amount adjustments in this transfer.
        Parameters:
        amountAdjustments -
        Returns:
        the current TransferEvent instance, allowing for method chaining
      • getAmountAdjustments

        public List<AmountAdjustment> getAmountAdjustments()
        The amount adjustments in this transfer.
        Returns:
        amountAdjustments
      • setAmountAdjustments

        public void setAmountAdjustments​(List<AmountAdjustment> amountAdjustments)
        The amount adjustments in this transfer.
        Parameters:
        amountAdjustments -
      • arn

        public TransferEvent arn​(String arn)
        Scheme unique arn identifier useful for tracing captures, chargebacks, refunds, etc.
        Parameters:
        arn -
        Returns:
        the current TransferEvent instance, allowing for method chaining
      • getArn

        public String getArn()
        Scheme unique arn identifier useful for tracing captures, chargebacks, refunds, etc.
        Returns:
        arn
      • setArn

        public void setArn​(String arn)
        Scheme unique arn identifier useful for tracing captures, chargebacks, refunds, etc.
        Parameters:
        arn -
      • bookingDate

        public TransferEvent bookingDate​(OffsetDateTime bookingDate)
        The date when the transfer request was sent.
        Parameters:
        bookingDate -
        Returns:
        the current TransferEvent instance, allowing for method chaining
      • getBookingDate

        public OffsetDateTime getBookingDate()
        The date when the transfer request was sent.
        Returns:
        bookingDate
      • setBookingDate

        public void setBookingDate​(OffsetDateTime bookingDate)
        The date when the transfer request was sent.
        Parameters:
        bookingDate -
      • estimatedArrivalTime

        public TransferEvent estimatedArrivalTime​(OffsetDateTime estimatedArrivalTime)
        The estimated time when the beneficiary should have access to the funds.
        Parameters:
        estimatedArrivalTime -
        Returns:
        the current TransferEvent instance, allowing for method chaining
      • getEstimatedArrivalTime

        public OffsetDateTime getEstimatedArrivalTime()
        The estimated time when the beneficiary should have access to the funds.
        Returns:
        estimatedArrivalTime
      • setEstimatedArrivalTime

        public void setEstimatedArrivalTime​(OffsetDateTime estimatedArrivalTime)
        The estimated time when the beneficiary should have access to the funds.
        Parameters:
        estimatedArrivalTime -
      • externalReason

        public TransferEvent externalReason​(ExternalReason externalReason)
        externalReason
        Parameters:
        externalReason -
        Returns:
        the current TransferEvent instance, allowing for method chaining
      • getExternalReason

        public ExternalReason getExternalReason()
        externalReason
        Returns:
        externalReason
      • setExternalReason

        public void setExternalReason​(ExternalReason externalReason)
        externalReason
        Parameters:
        externalReason -
      • id

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

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

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

        public TransferEvent modification​(Modification modification)
        modification
        Parameters:
        modification -
        Returns:
        the current TransferEvent instance, allowing for method chaining
      • getModification

        public Modification getModification()
        modification
        Returns:
        modification
      • setModification

        public void setModification​(Modification modification)
        modification
        Parameters:
        modification -
      • mutations

        public TransferEvent mutations​(List<BalanceMutation> mutations)
        The list of balance mutations per event.
        Parameters:
        mutations -
        Returns:
        the current TransferEvent instance, allowing for method chaining
      • getMutations

        public List<BalanceMutation> getMutations()
        The list of balance mutations per event.
        Returns:
        mutations
      • setMutations

        public void setMutations​(List<BalanceMutation> mutations)
        The list of balance mutations per event.
        Parameters:
        mutations -
      • originalAmount

        public TransferEvent originalAmount​(Amount originalAmount)
        originalAmount
        Parameters:
        originalAmount -
        Returns:
        the current TransferEvent instance, allowing for method chaining
      • getOriginalAmount

        public Amount getOriginalAmount()
        originalAmount
        Returns:
        originalAmount
      • setOriginalAmount

        public void setOriginalAmount​(Amount originalAmount)
        originalAmount
        Parameters:
        originalAmount -
      • reason

        public TransferEvent reason​(TransferEvent.ReasonEnum reason)
        The reason for the transfer status.
        Parameters:
        reason -
        Returns:
        the current TransferEvent instance, allowing for method chaining
      • setReason

        public void setReason​(TransferEvent.ReasonEnum reason)
        The reason for the transfer status.
        Parameters:
        reason -
      • status

        public TransferEvent status​(TransferEvent.StatusEnum status)
        The status of the transfer event.
        Parameters:
        status -
        Returns:
        the current TransferEvent instance, allowing for method chaining
      • setStatus

        public void setStatus​(TransferEvent.StatusEnum status)
        The status of the transfer event.
        Parameters:
        status -
      • trackingData

        public TransferEvent trackingData​(TransferEventTrackingData trackingData)
        trackingData
        Parameters:
        trackingData -
        Returns:
        the current TransferEvent instance, allowing for method chaining
      • setTrackingData

        public void setTrackingData​(TransferEventTrackingData trackingData)
        trackingData
        Parameters:
        trackingData -
      • transactionId

        public TransferEvent transactionId​(String transactionId)
        The id of the transaction that is related to this accounting event. Only sent for events of type **accounting** where the balance changes.
        Parameters:
        transactionId -
        Returns:
        the current TransferEvent instance, allowing for method chaining
      • getTransactionId

        public String getTransactionId()
        The id of the transaction that is related to this accounting event. Only sent for events of type **accounting** where the balance changes.
        Returns:
        transactionId
      • setTransactionId

        public void setTransactionId​(String transactionId)
        The id of the transaction that is related to this accounting event. Only sent for events of type **accounting** where the balance changes.
        Parameters:
        transactionId -
      • type

        public TransferEvent type​(TransferEvent.TypeEnum type)
        The type of the transfer event. Possible values: **accounting**, **tracking**.
        Parameters:
        type -
        Returns:
        the current TransferEvent instance, allowing for method chaining
      • getType

        public TransferEvent.TypeEnum getType()
        The type of the transfer event. Possible values: **accounting**, **tracking**.
        Returns:
        type
      • setType

        public void setType​(TransferEvent.TypeEnum type)
        The type of the transfer event. Possible values: **accounting**, **tracking**.
        Parameters:
        type -
      • updateDate

        public TransferEvent updateDate​(OffsetDateTime updateDate)
        The date when the tracking status was updated.
        Parameters:
        updateDate -
        Returns:
        the current TransferEvent instance, allowing for method chaining
      • getUpdateDate

        public OffsetDateTime getUpdateDate()
        The date when the tracking status was updated.
        Returns:
        updateDate
      • setUpdateDate

        public void setUpdateDate​(OffsetDateTime updateDate)
        The date when the tracking status was updated.
        Parameters:
        updateDate -
      • valueDate

        public TransferEvent valueDate​(OffsetDateTime valueDate)
        The date when the funds are expected to be deducted from or credited to the balance account. This date can be in either the past or future.
        Parameters:
        valueDate -
        Returns:
        the current TransferEvent instance, allowing for method chaining
      • getValueDate

        public OffsetDateTime getValueDate()
        The date when the funds are expected to be deducted from or credited to the balance account. This date can be in either the past or future.
        Returns:
        valueDate
      • setValueDate

        public void setValueDate​(OffsetDateTime valueDate)
        The date when the funds are expected to be deducted from or credited to the balance account. This date can be in either the past or future.
        Parameters:
        valueDate -
      • equals

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

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

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

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