[−][src]Struct stripe::Recipient
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
[src]
pub fn list(
client: &Client,
params: ListRecipients
) -> Response<List<Recipient>>
[src]
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>
[src]
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>
[src]
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>
[src]
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>>
[src]
client: &Client,
id: &RecipientId
) -> Response<Deleted<RecipientId>>
Permanently deletes a recipient.
It cannot be undone.
Trait Implementations
impl Clone for Recipient
[src]
impl Debug for Recipient
[src]
impl<'de> Deserialize<'de> for Recipient
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Object for Recipient
[src]
type Id = RecipientId
The canonical id type for this object.
fn id(&self) -> Self::Id
[src]
fn object(&self) -> &'static str
[src]
impl Serialize for Recipient
[src]
Auto Trait Implementations
impl RefUnwindSafe for Recipient
impl Send for Recipient
impl Sync for Recipient
impl Unpin for Recipient
impl UnwindSafe for Recipient
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,