Struct stripe::generated::payment::payment_method::PaymentMethod
source · pub struct PaymentMethod {Show 43 fields
pub id: PaymentMethodId,
pub acss_debit: Option<PaymentMethodAcssDebit>,
pub affirm: Option<PaymentMethodAffirm>,
pub afterpay_clearpay: Option<PaymentMethodAfterpayClearpay>,
pub alipay: Option<PaymentFlowsPrivatePaymentMethodsAlipay>,
pub au_becs_debit: Option<PaymentMethodAuBecsDebit>,
pub bacs_debit: Option<PaymentMethodBacsDebit>,
pub bancontact: Option<PaymentMethodBancontact>,
pub billing_details: BillingDetails,
pub blik: Option<PaymentMethodBlik>,
pub boleto: Option<PaymentMethodBoleto>,
pub card: Option<CardDetails>,
pub card_present: Option<CardPresent>,
pub cashapp: Option<PaymentMethodCashapp>,
pub created: Timestamp,
pub customer: Option<Expandable<Customer>>,
pub customer_balance: Option<PaymentMethodCustomerBalance>,
pub eps: Option<PaymentMethodEps>,
pub fpx: Option<PaymentMethodFpx>,
pub giropay: Option<PaymentMethodGiropay>,
pub grabpay: Option<PaymentMethodGrabpay>,
pub ideal: Option<PaymentMethodIdeal>,
pub interac_present: Option<PaymentMethodInteracPresent>,
pub klarna: Option<PaymentMethodKlarna>,
pub konbini: Option<PaymentMethodKonbini>,
pub link: Option<PaymentMethodLink>,
pub livemode: bool,
pub metadata: Option<Metadata>,
pub oxxo: Option<PaymentMethodOxxo>,
pub p24: Option<PaymentMethodP24>,
pub paynow: Option<PaymentMethodPaynow>,
pub paypal: Option<PaymentMethodPaypal>,
pub pix: Option<PaymentMethodPix>,
pub promptpay: Option<PaymentMethodPromptpay>,
pub radar_options: Option<RadarRadarOptions>,
pub revolut_pay: Option<PaymentMethodRevolutPay>,
pub sepa_debit: Option<PaymentMethodSepaDebit>,
pub sofort: Option<PaymentMethodSofort>,
pub swish: Option<PaymentMethodSwish>,
pub type_: PaymentMethodType,
pub us_bank_account: Option<PaymentMethodUsBankAccount>,
pub wechat_pay: Option<PaymentMethodWechatPay>,
pub zip: Option<PaymentMethodZip>,
}
Expand description
The resource representing a Stripe “PaymentMethod”.
For more details see https://stripe.com/docs/api/payment_methods/object
Fields§
§id: PaymentMethodId
Unique identifier for the object.
acss_debit: Option<PaymentMethodAcssDebit>
§affirm: Option<PaymentMethodAffirm>
§afterpay_clearpay: Option<PaymentMethodAfterpayClearpay>
§alipay: Option<PaymentFlowsPrivatePaymentMethodsAlipay>
§au_becs_debit: Option<PaymentMethodAuBecsDebit>
§bacs_debit: Option<PaymentMethodBacsDebit>
§bancontact: Option<PaymentMethodBancontact>
§billing_details: BillingDetails
§blik: Option<PaymentMethodBlik>
§boleto: Option<PaymentMethodBoleto>
§card: Option<CardDetails>
§card_present: Option<CardPresent>
§cashapp: Option<PaymentMethodCashapp>
§created: Timestamp
Time at which the object was created.
Measured in seconds since the Unix epoch.
customer: Option<Expandable<Customer>>
The ID of the Customer to which this PaymentMethod is saved.
This will not be set when the PaymentMethod has not been saved to a Customer.
customer_balance: Option<PaymentMethodCustomerBalance>
§eps: Option<PaymentMethodEps>
§fpx: Option<PaymentMethodFpx>
§giropay: Option<PaymentMethodGiropay>
§grabpay: Option<PaymentMethodGrabpay>
§ideal: Option<PaymentMethodIdeal>
§interac_present: Option<PaymentMethodInteracPresent>
§klarna: Option<PaymentMethodKlarna>
§konbini: Option<PaymentMethodKonbini>
§link: Option<PaymentMethodLink>
§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.
oxxo: Option<PaymentMethodOxxo>
§p24: Option<PaymentMethodP24>
§paynow: Option<PaymentMethodPaynow>
§paypal: Option<PaymentMethodPaypal>
§pix: Option<PaymentMethodPix>
§promptpay: Option<PaymentMethodPromptpay>
§radar_options: Option<RadarRadarOptions>
§revolut_pay: Option<PaymentMethodRevolutPay>
§sepa_debit: Option<PaymentMethodSepaDebit>
§sofort: Option<PaymentMethodSofort>
§swish: Option<PaymentMethodSwish>
§type_: PaymentMethodType
The type of the PaymentMethod.
An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
us_bank_account: Option<PaymentMethodUsBankAccount>
§wechat_pay: Option<PaymentMethodWechatPay>
§zip: Option<PaymentMethodZip>
Implementations§
source§impl PaymentMethod
impl PaymentMethod
sourcepub fn list(
client: &Client,
params: &ListPaymentMethods<'_>,
) -> Response<List<PaymentMethod>>
pub fn list( client: &Client, params: &ListPaymentMethods<'_>, ) -> Response<List<PaymentMethod>>
Returns a list of PaymentMethods for Treasury flows.
If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.
sourcepub fn create(
client: &Client,
params: CreatePaymentMethod<'_>,
) -> Response<PaymentMethod>
pub fn create( client: &Client, params: CreatePaymentMethod<'_>, ) -> Response<PaymentMethod>
Creates a PaymentMethod object.
Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js. Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.
sourcepub fn retrieve(
client: &Client,
id: &PaymentMethodId,
expand: &[&str],
) -> Response<PaymentMethod>
pub fn retrieve( client: &Client, id: &PaymentMethodId, expand: &[&str], ) -> Response<PaymentMethod>
Retrieves a PaymentMethod object attached to the StripeAccount.
To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods.
sourcepub fn update(
client: &Client,
id: &PaymentMethodId,
params: UpdatePaymentMethod<'_>,
) -> Response<PaymentMethod>
pub fn update( client: &Client, id: &PaymentMethodId, params: UpdatePaymentMethod<'_>, ) -> Response<PaymentMethod>
Updates a PaymentMethod object.
A PaymentMethod must be attached a customer to be updated.
source§impl PaymentMethod
impl PaymentMethod
sourcepub fn attach(
client: &Client,
payment_method_id: &PaymentMethodId,
params: AttachPaymentMethod,
) -> Response<PaymentMethod>
pub fn attach( client: &Client, payment_method_id: &PaymentMethodId, params: AttachPaymentMethod, ) -> Response<PaymentMethod>
Attach a payment method to a customer
For more details see https://stripe.com/docs/api/payment_methods/attach.
sourcepub fn detach(
client: &Client,
payment_method_id: &PaymentMethodId,
) -> Response<PaymentMethod>
pub fn detach( client: &Client, payment_method_id: &PaymentMethodId, ) -> Response<PaymentMethod>
Detach a PaymentMethod from a Customer
For more details see https://stripe.com/docs/api/payment_methods/detach.
Trait Implementations§
source§impl Clone for PaymentMethod
impl Clone for PaymentMethod
source§fn clone(&self) -> PaymentMethod
fn clone(&self) -> PaymentMethod
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PaymentMethod
impl Debug for PaymentMethod
source§impl Default for PaymentMethod
impl Default for PaymentMethod
source§fn default() -> PaymentMethod
fn default() -> PaymentMethod
source§impl<'de> Deserialize<'de> for PaymentMethod
impl<'de> Deserialize<'de> for PaymentMethod
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl Object for PaymentMethod
impl Object for PaymentMethod
Auto Trait Implementations§
impl Freeze for PaymentMethod
impl RefUnwindSafe for PaymentMethod
impl Send for PaymentMethod
impl Sync for PaymentMethod
impl Unpin for PaymentMethod
impl UnwindSafe for PaymentMethod
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)