Struct stripe::CreatePayout

pub struct CreatePayout<'a> {
    pub amount: i64,
    pub currency: Currency,
    pub description: Option<&'a str>,
    pub destination: Option<String>,
    pub expand: &'a [&'a str],
    pub metadata: Option<Metadata>,
    pub method: Option<PayoutMethod>,
    pub source_type: Option<PayoutSourceType>,
    pub statement_descriptor: Option<&'a str>,
}

The parameters for Payout::create.

Fields

amount: i64

A positive integer in cents representing how much to payout.

currency: Currency

Three-letter ISO currency code, in lowercase.

Must be a supported currency.

description: Option<&'a str>

An arbitrary string attached to the object.

Often useful for displaying to users.

destination: Option<String>

The ID of a bank account or a card to send the payout to.

If you don’t provide a destination, we use the default external account for the specified currency.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

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

method: Option<PayoutMethod>

The method used to send this payout, which is standard or instant.

We support instant for payouts to debit cards and bank accounts in certain countries. Learn more about bank support for Instant Payouts.

source_type: Option<PayoutSourceType>

The balance type of your Stripe balance to draw this payout from.

Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of bank_account, card, or fpx.

statement_descriptor: Option<&'a str>

A string that displays on the recipient’s bank or card statement (up to 22 characters).

A statement_descriptor that’s longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.

Implementations

impl<'a> CreatePayout<'a>

pub fn new(amount: i64, currency: Currency) -> Self

Trait Implementations

impl<'a> Clone for CreatePayout<'a>

fn clone(&self) -> CreatePayout<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CreatePayout<'a>

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

Formats the value using the given formatter.

impl<'a> Serialize for CreatePayout<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.