Struct stripe::Recipient

pub struct Recipient {
    pub id: RecipientId,
    pub active_account: Option<BankAccount>,
    pub cards: List<Card>,
    pub created: Option<Timestamp>,
    pub default_card: Option<Expandable<Card>>,
    pub deleted: bool,
    pub description: Option<String>,
    pub email: Option<String>,
    pub livemode: Option<bool>,
    pub metadata: Metadata,
    pub migrated_to: Option<Expandable<Account>>,
    pub name: Option<String>,
    pub rolled_back_from: Option<Expandable<Account>>,
    pub type_: Option<RecipientType>,
}

The resource representing a Stripe "TransferRecipient".

Fields

id: RecipientId

Unique identifier for the object.

active_account: Option<BankAccount>

Hash describing the current account on the recipient, if there is one.

cards: List<Card>

created: Option<Timestamp>

Time at which the object was created.

Measured in seconds since the Unix epoch.

default_card: Option<Expandable<Card>>

The default card to use for creating transfers to this recipient.

deleted: bool

description: Option<String>

An arbitrary string attached to the object.

Often useful for displaying to users.

email: Option<String>

livemode: Option<bool>

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

metadata: 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.

migrated_to: Option<Expandable<Account>>

The ID of the Custom account this recipient was migrated to.

If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead.

name: Option<String>

Full, legal name of the recipient.

rolled_back_from: Option<Expandable<Account>>

type_: Option<RecipientType>

Type of the recipient, one of individual or corporation.

Implementations

impl Recipient

pub fn list(
    client: &Client,
    params: ListRecipients
) -> Response<List<Recipient>>

Returns a list of your recipients.

The recipients are returned sorted by creation date, with the most recently created recipients appearing first.

pub fn create(client: &Client, params: CreateRecipient) -> Response<Recipient>

Creates a new Recipient object and verifies the recipient’s identity. Also verifies the recipient’s bank account information or debit card, if either is provided.

pub fn retrieve(
    client: &Client,
    id: &RecipientId,
    expand: &[&str]
) -> Response<Recipient>

Retrieves the details of an existing recipient.

You need only supply the unique recipient identifier that was returned upon recipient creation.

pub fn update(
    client: &Client,
    id: &RecipientId,
    params: UpdateRecipient
) -> Response<Recipient>

Updates the specified recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

If you update the name or tax ID, the identity verification will automatically be rerun. If you update the bank account, the bank account validation will automatically be rerun.

pub fn delete(
    client: &Client,
    id: &RecipientId
) -> Response<Deleted<RecipientId>>

Permanently deletes a recipient.

It cannot be undone.

Trait Implementations

impl Clone for Recipient

fn clone(&self) -> Recipient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Recipient

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Recipient

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Object for Recipient

type Id = RecipientId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object's type, typically represented in wire format as the object property.

impl Serialize for Recipient

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

Serialize this value into the given Serde serializer.