Struct TreasuryOutboundTransfer 

pub struct TreasuryOutboundTransfer {

    pub amount: i64,
    pub cancelable: bool,
    pub created: i64,
    pub currency: String,
    pub description: Option<String>,
    pub destination_payment_method: Option<String>,
    pub destination_payment_method_details: OutboundTransfersPaymentMethodDetails,
    pub expected_arrival_date: i64,
    pub financial_account: String,
    pub hosted_regulatory_receipt_url: Option<String>,
    pub id: String,
    pub livemode: bool,
    pub metadata: Value,
    pub object: String,
    pub returned_details: Option<Value>,
    pub statement_descriptor: String,
    pub status: String,
    pub status_transitions: TreasuryOutboundTransfersResourceStatusTransitions,
    pub transaction: Value,
}

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.

Fields

amount: i64

Amount (in cents) transferred.

cancelable: bool

Returns true if the object can be canceled, and false otherwise.

created: i64

Time at which the object was created. Measured in seconds since the Unix epoch.

currency: String

Three-letter ISO currency code, in lowercase. Must be a supported currency.

description: Option<String>

An arbitrary string attached to the object. Often useful for displaying to users.

destination_payment_method: Option<String>

The PaymentMethod used as the payment instrument for an OutboundTransfer.

destination_payment_method_details: OutboundTransfersPaymentMethodDetails

expected_arrival_date: i64

The date when funds are expected to arrive in the destination account.

financial_account: String

The FinancialAccount that funds were pulled from.

hosted_regulatory_receipt_url: Option<String>

A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.

id: String

Unique identifier for the object.

livemode: bool

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata: Value

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.

object: String

String representing the object’s type. Objects of the same type share the same value.

returned_details: Option<Value>

Details about a returned OutboundTransfer. Only set when the status is returned.

statement_descriptor: String

Information about the OutboundTransfer to be sent to the recipient account.

status: String

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.

status_transitions: TreasuryOutboundTransfersResourceStatusTransitions

transaction: Value

The Transaction associated with this object.

Trait Implementations

impl Clone for TreasuryOutboundTransfer

fn clone(&self) -> TreasuryOutboundTransfer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TreasuryOutboundTransfer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TreasuryOutboundTransfer

fn default() -> TreasuryOutboundTransfer

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TreasuryOutboundTransfer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TreasuryOutboundTransfer

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Serialize for TreasuryOutboundTransfer

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.