Package com.stripe.model.treasury

Class OutboundTransfer

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.treasury.OutboundTransfer
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class OutboundTransfer extends ApiResource implements HasId
Use OutboundTransfers to transfer funds from a FinancialAccount to a PaymentMethod belonging to the same entity. To send funds to a different party, use OutboundPayments instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.

Simulate OutboundTransfer state changes with the /v1/test_helpers/treasury/outbound_transfers endpoints. These methods can only be called on test mode objects.

Related guide: Moving money with Treasury using OutboundTransfer objects

  • Constructor Details

    • OutboundTransfer

      public OutboundTransfer()

  • Method Details

    • getTransaction

      public String getTransaction()
      Get ID of expandable transaction object.

    • setTransaction

      public void setTransaction(String id)

    • getTransactionObject

      public Transaction getTransactionObject()
      Get expanded transaction.

    • setTransactionObject

      public void setTransactionObject(Transaction expandableObject)

    • cancel

      public OutboundTransfer cancel() throws StripeException
      An OutboundTransfer can be canceled if the funds have not yet been paid out.
      Throws:
      StripeException

    • cancel

      public OutboundTransfer cancel(RequestOptions options) throws StripeException
      An OutboundTransfer can be canceled if the funds have not yet been paid out.
      Throws:
      StripeException

    • cancel

      public OutboundTransfer cancel(Map<String,Object> params) throws StripeException
      An OutboundTransfer can be canceled if the funds have not yet been paid out.
      Throws:
      StripeException

    • cancel

      public OutboundTransfer cancel(Map<String,Object> params, RequestOptions options) throws StripeException
      An OutboundTransfer can be canceled if the funds have not yet been paid out.
      Throws:
      StripeException

    • cancel

      public OutboundTransfer cancel(OutboundTransferCancelParams params) throws StripeException
      An OutboundTransfer can be canceled if the funds have not yet been paid out.
      Throws:
      StripeException

    • cancel

      public OutboundTransfer cancel(OutboundTransferCancelParams params, RequestOptions options) throws StripeException
      An OutboundTransfer can be canceled if the funds have not yet been paid out.
      Throws:
      StripeException

    • create

      public static OutboundTransfer create(Map<String,Object> params) throws StripeException
      Creates an OutboundTransfer.
      Throws:
      StripeException

    • create

      public static OutboundTransfer create(Map<String,Object> params, RequestOptions options) throws StripeException
      Creates an OutboundTransfer.
      Throws:
      StripeException

    • create

      public static OutboundTransfer create(OutboundTransferCreateParams params) throws StripeException
      Creates an OutboundTransfer.
      Throws:
      StripeException

    • create

      public static OutboundTransfer create(OutboundTransferCreateParams params, RequestOptions options) throws StripeException
      Creates an OutboundTransfer.
      Throws:
      StripeException

    • list

      public static OutboundTransferCollection list(Map<String,Object> params) throws StripeException
      Returns a list of OutboundTransfers sent from the specified FinancialAccount.
      Throws:
      StripeException

    • list

      public static OutboundTransferCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Returns a list of OutboundTransfers sent from the specified FinancialAccount.
      Throws:
      StripeException

    • list

      public static OutboundTransferCollection list(OutboundTransferListParams params) throws StripeException
      Returns a list of OutboundTransfers sent from the specified FinancialAccount.
      Throws:
      StripeException

    • list

      public static OutboundTransferCollection list(OutboundTransferListParams params, RequestOptions options) throws StripeException
      Returns a list of OutboundTransfers sent from the specified FinancialAccount.
      Throws:
      StripeException

    • retrieve

      public static OutboundTransfer retrieve(String outboundTransfer) throws StripeException
      Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.
      Throws:
      StripeException

    • retrieve

      public static OutboundTransfer retrieve(String outboundTransfer, RequestOptions options) throws StripeException
      Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.
      Throws:
      StripeException

    • retrieve

      public static OutboundTransfer retrieve(String outboundTransfer, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.
      Throws:
      StripeException

    • retrieve

      public static OutboundTransfer retrieve(String outboundTransfer, OutboundTransferRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.
      Throws:
      StripeException

    • getTestHelpers

      public OutboundTransfer.TestHelpers getTestHelpers()
      OMAD of the OutboundTransfer for transfers sent over the us_domestic_wire network.

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getAmount

      public Long getAmount()
      Amount (in cents) transferred.

    • getCancelable

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

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getCurrency

      public String getCurrency()
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • getDescription

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

    • getDestinationPaymentMethod

      public String getDestinationPaymentMethod()
      The PaymentMethod used as the payment instrument for an OutboundTransfer.

    • getDestinationPaymentMethodDetails

      public OutboundTransfer.DestinationPaymentMethodDetails getDestinationPaymentMethodDetails()

    • getExpectedArrivalDate

      public Long getExpectedArrivalDate()
      The date when funds are expected to arrive in the destination account.

    • getFinancialAccount

      public String getFinancialAccount()
      The FinancialAccount that funds were pulled from.

    • getHostedRegulatoryReceiptUrl

      public String getHostedRegulatoryReceiptUrl()
      A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

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

    • getNetworkDetails

      public OutboundTransfer.NetworkDetails getNetworkDetails()
      Details about the network used for the OutboundTransfer.

    • getObject

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

      Equal to treasury.outbound_transfer.

    • getReturnedDetails

      public OutboundTransfer.ReturnedDetails getReturnedDetails()
      Details about a returned OutboundTransfer. Only set when the status is returned.

    • getStatementDescriptor

      public String getStatementDescriptor()
      Information about the OutboundTransfer to be sent to the recipient account.

    • getStatus

      public String getStatus()
      Current status of the OutboundTransfer: processing, failed, canceled, posted, returned. An OutboundTransfer is processing if it has been created and is pending. 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 destination, its status will change to returned.

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

    • getStatusTransitions

      public OutboundTransfer.StatusTransitions getStatusTransitions()

    • getTrackingDetails

      public OutboundTransfer.TrackingDetails getTrackingDetails()
      Details about network-specific tracking information if available.

    • setAmount

      public void setAmount(Long amount)
      Amount (in cents) transferred.

    • setCancelable

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

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setCurrency

      public void setCurrency(String currency)
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • setDescription

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

    • setDestinationPaymentMethod

      public void setDestinationPaymentMethod(String destinationPaymentMethod)
      The PaymentMethod used as the payment instrument for an OutboundTransfer.

    • setDestinationPaymentMethodDetails

      public void setDestinationPaymentMethodDetails(OutboundTransfer.DestinationPaymentMethodDetails destinationPaymentMethodDetails)

    • setExpectedArrivalDate

      public void setExpectedArrivalDate(Long expectedArrivalDate)
      The date when funds are expected to arrive in the destination account.

    • setFinancialAccount

      public void setFinancialAccount(String financialAccount)
      The FinancialAccount that funds were pulled from.

    • setHostedRegulatoryReceiptUrl

      public void setHostedRegulatoryReceiptUrl(String hostedRegulatoryReceiptUrl)
      A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

    • setId

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

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

    • setNetworkDetails

      public void setNetworkDetails(OutboundTransfer.NetworkDetails networkDetails)
      Details about the network used for the OutboundTransfer.

    • setObject

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

      Equal to treasury.outbound_transfer.

    • setReturnedDetails

      public void setReturnedDetails(OutboundTransfer.ReturnedDetails returnedDetails)
      Details about a returned OutboundTransfer. Only set when the status is returned.

    • setStatementDescriptor

      public void setStatementDescriptor(String statementDescriptor)
      Information about the OutboundTransfer to be sent to the recipient account.

    • setStatus

      public void setStatus(String status)
      Current status of the OutboundTransfer: processing, failed, canceled, posted, returned. An OutboundTransfer is processing if it has been created and is pending. 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 destination, its status will change to returned.

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

    • setStatusTransitions

      public void setStatusTransitions(OutboundTransfer.StatusTransitions statusTransitions)

    • setTrackingDetails

      public void setTrackingDetails(OutboundTransfer.TrackingDetails trackingDetails)
      Details about network-specific tracking information if available.

    • 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 object.
      Specified by:
      getId in interface HasId