Package com.stripe.model.v2.moneymanagement

Class OutboundTransfer

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.v2.moneymanagement.OutboundTransfer
All Implemented Interfaces:
HasId, StripeObjectInterface
public class OutboundTransfer extends StripeObject implements HasId
OutboundTransfer represents a single money movement from one FinancialAccount you own to a payout method you also own.

  • Constructor Details

    • OutboundTransfer

      public OutboundTransfer()

  • Method Details

    • getAmount

      public Amount getAmount()
      The "presentment amount" for the OutboundTransfer.

    • getCancelable

      public Boolean getCancelable()
      Returns true if the OutboundTransfer can be canceled, and false otherwise.

    • getCreated

      public Instant getCreated()
      Time at which the OutboundTransfer was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

    • getDeliveryOptions

      public OutboundTransfer.DeliveryOptions getDeliveryOptions()
      Delivery options to be used to send the OutboundTransfer.

    • getDescription

      public String getDescription()
      An arbitrary string attached to the OutboundTransfer. Often useful for displaying to users.

    • getExpectedArrivalDate

      public Instant getExpectedArrivalDate()
      The date when funds are expected to arrive in the payout method. This field is not set if the payout method is in a failed, canceled, or returned state. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

    • getFrom

      public OutboundTransfer.From getFrom()
      The FinancialAccount that funds were pulled from.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getMetadata

      public Map<String,String> getMetadata()
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value of the object field.

      Equal to v2.money_management.outbound_transfer.

    • getReceiptUrl

      public String getReceiptUrl()
      A link to the Stripe-hosted receipt for this OutboundTransfer. The receipt link remains active for 60 days from the OutboundTransfer creation date. After this period, the link will expire and the receipt url value will be null.

    • getRecipientVerification

      public String getRecipientVerification()
      The recipient verification id for this OutboundTransfer. Only required for countries with regulatory mandates to verify recipient names before OutboundTransfer creation.

    • getStatementDescriptor

      public String getStatementDescriptor()
      The description that appears on the receiving end for an OutboundTransfer (for example, bank statement for external bank transfer). It will default to STRIPE if not set on the account settings.

    • getStatus

      public String getStatus()
      Closed Enum. Current status of the OutboundTransfer: processing, failed, posted, returned, canceled. An OutboundTransfer is processing if it has been created and is processing. The status changes to posted once the OutboundTransfer has been "confirmed" and funds have left the account, or to failed or canceled. If an OutboundTransfer fails to arrive at its payout method, its status will change to returned.

      One of canceled, failed, posted, processing, or returned.

    • getStatusDetails

      public OutboundTransfer.StatusDetails getStatusDetails()
      Status details for an OutboundTransfer in a failed or returned state.

    • getStatusTransitions

      public OutboundTransfer.StatusTransitions getStatusTransitions()
      Hash containing timestamps of when the object transitioned to a particular status.

    • getTo

      public OutboundTransfer.To getTo()
      To which payout method the OutboundTransfer was sent.

    • getTraceId

      public OutboundTransfer.TraceId getTraceId()
      A unique identifier that can be used to track this OutboundTransfer with recipient bank. Banks might call this a “reference number” or something similar.

    • setAmount

      public void setAmount(Amount amount)
      The "presentment amount" for the OutboundTransfer.

    • setCancelable

      public void setCancelable(Boolean cancelable)
      Returns true if the OutboundTransfer can be canceled, and false otherwise.

    • setCreated

      public void setCreated(Instant created)
      Time at which the OutboundTransfer was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

    • setDeliveryOptions

      public void setDeliveryOptions(OutboundTransfer.DeliveryOptions deliveryOptions)
      Delivery options to be used to send the OutboundTransfer.

    • setDescription

      public void setDescription(String description)
      An arbitrary string attached to the OutboundTransfer. Often useful for displaying to users.

    • setExpectedArrivalDate

      public void setExpectedArrivalDate(Instant expectedArrivalDate)
      The date when funds are expected to arrive in the payout method. This field is not set if the payout method is in a failed, canceled, or returned state. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

    • setFrom

      public void setFrom(OutboundTransfer.From from)
      The FinancialAccount that funds were pulled from.

    • setId

      public void setId(String id)
      Unique identifier for the OutboundTransfer.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setMetadata

      public void setMetadata(Map<String,String> metadata)
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value of the object field.

      Equal to v2.money_management.outbound_transfer.

    • setReceiptUrl

      public void setReceiptUrl(String receiptUrl)
      A link to the Stripe-hosted receipt for this OutboundTransfer. The receipt link remains active for 60 days from the OutboundTransfer creation date. After this period, the link will expire and the receipt url value will be null.

    • setRecipientVerification

      public void setRecipientVerification(String recipientVerification)
      The recipient verification id for this OutboundTransfer. Only required for countries with regulatory mandates to verify recipient names before OutboundTransfer creation.

    • setStatementDescriptor

      public void setStatementDescriptor(String statementDescriptor)
      The description that appears on the receiving end for an OutboundTransfer (for example, bank statement for external bank transfer). It will default to STRIPE if not set on the account settings.

    • setStatus

      public void setStatus(String status)
      Closed Enum. Current status of the OutboundTransfer: processing, failed, posted, returned, canceled. An OutboundTransfer is processing if it has been created and is processing. The status changes to posted once the OutboundTransfer has been "confirmed" and funds have left the account, or to failed or canceled. If an OutboundTransfer fails to arrive at its payout method, its status will change to returned.

      One of canceled, failed, posted, processing, or returned.

    • setStatusDetails

      public void setStatusDetails(OutboundTransfer.StatusDetails statusDetails)
      Status details for an OutboundTransfer in a failed or returned state.

    • setStatusTransitions

      public void setStatusTransitions(OutboundTransfer.StatusTransitions statusTransitions)
      Hash containing timestamps of when the object transitioned to a particular status.

    • setTo

      public void setTo(OutboundTransfer.To to)
      To which payout method the OutboundTransfer was sent.

    • setTraceId

      public void setTraceId(OutboundTransfer.TraceId traceId)
      A unique identifier that can be used to track this OutboundTransfer with recipient bank. Banks might call this a “reference number” or something similar.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the OutboundTransfer.
      Specified by:
      getId in interface HasId