Struct stripe::Source

pub struct Source {

    pub id: SourceId,
    pub ach_credit_transfer: Option<SourceTypeAchCreditTransfer>,
    pub ach_debit: Option<SourceTypeAchDebit>,
    pub acss_debit: Option<SourceTypeAcssDebit>,
    pub alipay: Option<SourceTypeAlipay>,
    pub amount: Option<i64>,
    pub au_becs_debit: Option<SourceTypeAuBecsDebit>,
    pub bancontact: Option<SourceTypeBancontact>,
    pub card: Option<SourceTypeCard>,
    pub card_present: Option<SourceTypeCardPresent>,
    pub client_secret: String,
    pub code_verification: Option<SourceCodeVerificationFlow>,
    pub created: Timestamp,
    pub currency: Option<Currency>,
    pub customer: Option<String>,
    pub eps: Option<SourceTypeEps>,
    pub flow: SourceFlow,
    pub giropay: Option<SourceTypeGiropay>,
    pub ideal: Option<SourceTypeIdeal>,
    pub klarna: Option<SourceTypeKlarna>,
    pub livemode: bool,
    pub metadata: Option<Metadata>,
    pub multibanco: Option<SourceTypeMultibanco>,
    pub owner: Option<SourceOwner>,
    pub p24: Option<SourceTypeP24>,
    pub receiver: Option<SourceReceiverFlow>,
    pub redirect: Option<SourceRedirectFlow>,
    pub sepa_credit_transfer: Option<SourceTypeSepaCreditTransfer>,
    pub sepa_debit: Option<SourceTypeSepaDebit>,
    pub sofort: Option<SourceTypeSofort>,
    pub source_order: Option<SourceOrder>,
    pub statement_descriptor: Option<String>,
    pub status: SourceStatus,
    pub three_d_secure: Option<SourceTypeThreeDSecure>,
    pub type_: SourceType,
    pub usage: Option<SourceUsage>,
    pub wechat: Option<SourceTypeWechat>,
}

The resource representing a Stripe “Source”.

For more details see https://stripe.com/docs/api/sources/object

Fields

id: SourceId

Unique identifier for the object.

ach_credit_transfer: Option<SourceTypeAchCreditTransfer>

ach_debit: Option<SourceTypeAchDebit>

acss_debit: Option<SourceTypeAcssDebit>

alipay: Option<SourceTypeAlipay>

amount: Option<i64>

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source.

This is the amount for which the source will be chargeable once ready. Required for single_use sources.

au_becs_debit: Option<SourceTypeAuBecsDebit>

bancontact: Option<SourceTypeBancontact>

card: Option<SourceTypeCard>

card_present: Option<SourceTypeCardPresent>

client_secret: String

The client secret of the source.

Used for client-side retrieval using a publishable key.

code_verification: Option<SourceCodeVerificationFlow>

created: Timestamp

Time at which the object was created.

Measured in seconds since the Unix epoch.

currency: Option<Currency>

Three-letter ISO code for the currency associated with the source.

This is the currency for which the source will be chargeable once ready. Required for single_use sources.

customer: Option<String>

The ID of the customer to which this source is attached.

This will not be present when the source has not been attached to a customer.

eps: Option<SourceTypeEps>

flow: SourceFlow

The authentication flow of the source.

flow is one of redirect, receiver, code_verification, none.

giropay: Option<SourceTypeGiropay>

ideal: Option<SourceTypeIdeal>

klarna: Option<SourceTypeKlarna>

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

multibanco: Option<SourceTypeMultibanco>

owner: Option<SourceOwner>

Information about the owner of the payment instrument that may be used or required by particular source types.

p24: Option<SourceTypeP24>

receiver: Option<SourceReceiverFlow>

redirect: Option<SourceRedirectFlow>

sepa_credit_transfer: Option<SourceTypeSepaCreditTransfer>

sepa_debit: Option<SourceTypeSepaDebit>

sofort: Option<SourceTypeSofort>

source_order: Option<SourceOrder>

statement_descriptor: Option<String>

Extra information about a source.

This will appear on your customer’s statement every time you charge the source.

status: SourceStatus

The status of the source, one of canceled, chargeable, consumed, failed, or pending.

Only chargeable sources can be used to create a charge.

three_d_secure: Option<SourceTypeThreeDSecure>

type_: SourceType

The type of the source.

The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.

usage: Option<SourceUsage>

Either reusable or single_use.

Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.

wechat: Option<SourceTypeWechat>

Implementations

impl Source

pub fn list(client: &Client, params: &ListSources<'_>) -> Response<List<Source>>

List source transactions for a given source.

pub fn create(client: &Client, params: CreateSource<'_>) -> Response<Source>

Creates a new source object.

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

Retrieves an existing source object.

Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

pub fn update( client: &Client, id: &SourceId, params: UpdateSource<'_>, ) -> Response<Source>

Updates the specified source by setting the values of the parameters passed.

Any parameters not provided will be left unchanged. This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl Default for Source

fn default() -> Source

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Source

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Object for Source

type Id = SourceId

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 Source

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

where __S: Serializer,

Serialize this value into the given Serde serializer.