Struct CreateTransfer 

pub struct CreateTransfer { /* private fields */ }

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

Implementations

impl CreateTransfer

pub fn new( currency: impl Into<Currency>, destination: impl Into<String>, ) -> Self

Construct a new CreateTransfer.

pub fn amount(self, amount: impl Into<i64>) -> Self

A positive integer in cents (or local equivalent) representing how much to transfer.

pub fn description(self, description: impl Into<String>) -> Self

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

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

pub fn source_transaction(self, source_transaction: impl Into<String>) -> Self

You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. See the Connect documentation for details.

pub fn source_type( self, source_type: impl Into<CreateTransferSourceType>, ) -> Self

The source balance to use for this transfer. One of bank_account, card, or fpx. For most users, this will default to card.

pub fn transfer_group(self, transfer_group: impl Into<String>) -> Self

A string that identifies this transaction as part of a group. See the Connect documentation for details.

impl CreateTransfer

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

Trait Implementations

impl Clone for CreateTransfer

fn clone(&self) -> CreateTransfer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateTransfer

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

Formats the value using the given formatter.

impl Serialize for CreateTransfer

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for CreateTransfer

type Output = Transfer

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.