Crate stripe_checkout

This crate provides Rust bindings to the Stripe HTTP API, centered around Checkout Sessions.

Modules

checkout_session

Structs

CheckoutAcssDebitMandateOptions

CheckoutAcssDebitPaymentMethodOptions

CheckoutAffirmPaymentMethodOptions

CheckoutAfterpayClearpayPaymentMethodOptions

CheckoutAlipayPaymentMethodOptions

CheckoutAmazonPayPaymentMethodOptions

CheckoutAuBecsDebitPaymentMethodOptions

CheckoutBacsDebitPaymentMethodOptions

CheckoutBancontactPaymentMethodOptions

CheckoutBoletoPaymentMethodOptions

CheckoutCardInstallmentsOptions

CheckoutCardPaymentMethodOptions

CheckoutCashappPaymentMethodOptions

CheckoutCustomerBalanceBankTransferPaymentMethodOptions

CheckoutCustomerBalancePaymentMethodOptions

CheckoutEpsPaymentMethodOptions

CheckoutFpxPaymentMethodOptions

CheckoutGiropayPaymentMethodOptions

CheckoutGrabPayPaymentMethodOptions

CheckoutIdealPaymentMethodOptions

CheckoutKakaoPayPaymentMethodOptions

CheckoutKlarnaPaymentMethodOptions

CheckoutKonbiniPaymentMethodOptions

CheckoutKrCardPaymentMethodOptions

CheckoutLinkPaymentMethodOptions

CheckoutLinkWalletOptions

CheckoutMobilepayPaymentMethodOptions

CheckoutMultibancoPaymentMethodOptions

CheckoutNaverPayPaymentMethodOptions

CheckoutOxxoPaymentMethodOptions

CheckoutP24PaymentMethodOptions

CheckoutPaycoPaymentMethodOptions

CheckoutPaymentMethodOptionsMandateOptionsBacsDebit

CheckoutPaymentMethodOptionsMandateOptionsSepaDebit

CheckoutPaynowPaymentMethodOptions

CheckoutPaypalPaymentMethodOptions

CheckoutPixPaymentMethodOptions

CheckoutRevolutPayPaymentMethodOptions

CheckoutSamsungPayPaymentMethodOptions

CheckoutSepaDebitPaymentMethodOptions

CheckoutSession

A Checkout Session represents your customer’s session as they pay for one-time purchases or subscriptions through Checkout or Payment Links. We recommend creating a new Session each time your customer attempts to pay.

CheckoutSessionId

CheckoutSessionPaymentMethodOptions

CheckoutSessionWalletOptions

CheckoutSofortPaymentMethodOptions

CheckoutSwishPaymentMethodOptions

CheckoutUsBankAccountPaymentMethodOptions

PaymentPagesCheckoutSessionAdaptivePricing

PaymentPagesCheckoutSessionAfterExpiration

PaymentPagesCheckoutSessionAfterExpirationRecovery

PaymentPagesCheckoutSessionAutomaticTax

PaymentPagesCheckoutSessionCheckoutAddressDetails

PaymentPagesCheckoutSessionCollectedInformation

PaymentPagesCheckoutSessionConsent

PaymentPagesCheckoutSessionConsentCollection

PaymentPagesCheckoutSessionCurrencyConversion

PaymentPagesCheckoutSessionCustomFields

PaymentPagesCheckoutSessionCustomFieldsDropdown

PaymentPagesCheckoutSessionCustomFieldsLabel

PaymentPagesCheckoutSessionCustomFieldsNumeric

PaymentPagesCheckoutSessionCustomFieldsOption

PaymentPagesCheckoutSessionCustomFieldsText

PaymentPagesCheckoutSessionCustomText

PaymentPagesCheckoutSessionCustomTextPosition

PaymentPagesCheckoutSessionCustomerDetails

PaymentPagesCheckoutSessionDiscount

PaymentPagesCheckoutSessionInvoiceCreation

PaymentPagesCheckoutSessionInvoiceSettings

PaymentPagesCheckoutSessionOptionalItem

PaymentPagesCheckoutSessionOptionalItemAdjustableQuantity

PaymentPagesCheckoutSessionPaymentMethodReuseAgreement

PaymentPagesCheckoutSessionPermissions

PaymentPagesCheckoutSessionPhoneNumberCollection

PaymentPagesCheckoutSessionSavedPaymentMethodOptions

PaymentPagesCheckoutSessionShippingAddressCollection

PaymentPagesCheckoutSessionShippingCost

PaymentPagesCheckoutSessionShippingOption

PaymentPagesCheckoutSessionTaxId

PaymentPagesCheckoutSessionTaxIdCollection

PaymentPagesCheckoutSessionTotalDetails

PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown

PaymentPagesPrivateCardPaymentMethodOptionsResourceRestrictions

Enums

CheckoutAcssDebitMandateOptionsDefaultFor

List of Stripe products where this mandate can be selected automatically. Returned when the Session is in setup mode.

CheckoutAcssDebitMandateOptionsPaymentSchedule

Payment schedule for the mandate.

CheckoutAcssDebitMandateOptionsTransactionType

Transaction type of the mandate.

CheckoutAcssDebitPaymentMethodOptionsCurrency

Currency supported by the bank account. Returned when the Session is in setup mode.

CheckoutAcssDebitPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutAcssDebitPaymentMethodOptionsVerificationMethod

Bank account verification method.

CheckoutAffirmPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutAfterpayClearpayPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutAlipayPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutAmazonPayPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutAuBecsDebitPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutBacsDebitPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutBancontactPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutBoletoPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutCardPaymentMethodOptionsRequestExtendedAuthorization

Request ability to capture beyond the standard authorization validity window for this CheckoutSession.

CheckoutCardPaymentMethodOptionsRequestIncrementalAuthorization

Request ability to increment the authorization for this CheckoutSession.

CheckoutCardPaymentMethodOptionsRequestMulticapture

Request ability to make multiple captures for this CheckoutSession.

CheckoutCardPaymentMethodOptionsRequestOvercapture

Request ability to overcapture for this CheckoutSession.

CheckoutCardPaymentMethodOptionsRequestThreeDSecure

We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to automatic. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.

CheckoutCardPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutCashappPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutCustomerBalanceBankTransferPaymentMethodOptionsRequestedAddressTypes

List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.

CheckoutCustomerBalanceBankTransferPaymentMethodOptionsType

The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.

CheckoutCustomerBalancePaymentMethodOptionsFundingType

The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.

CheckoutCustomerBalancePaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutEpsPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutFpxPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutGiropayPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutGrabPayPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutIdealPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutKakaoPayPaymentMethodOptionsCaptureMethod

Controls when the funds will be captured from the customer’s account.

CheckoutKakaoPayPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutKlarnaPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutKonbiniPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutKrCardPaymentMethodOptionsCaptureMethod

Controls when the funds will be captured from the customer’s account.

CheckoutKrCardPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutLinkPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutLinkWalletOptionsDisplay

Describes whether Checkout should display Link. Defaults to auto.

CheckoutMobilepayPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutMultibancoPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutNaverPayPaymentMethodOptionsCaptureMethod

Controls when the funds will be captured from the customer’s account.

CheckoutOxxoPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutP24PaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutPaycoPaymentMethodOptionsCaptureMethod

Controls when the funds will be captured from the customer’s account.

CheckoutPaynowPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutPaypalPaymentMethodOptionsCaptureMethod

Controls when the funds will be captured from the customer’s account.

CheckoutPaypalPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutRevolutPayPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutSamsungPayPaymentMethodOptionsCaptureMethod

Controls when the funds will be captured from the customer’s account.

CheckoutSepaDebitPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutSessionBillingAddressCollection

CheckoutSessionCustomerCreation

Configure whether a Checkout Session creates a Customer when the Checkout Session completes.

CheckoutSessionLocale

CheckoutSessionMode

CheckoutSessionPaymentMethodCollection

Configure whether a Checkout Session should collect a payment method. Defaults to always.

CheckoutSessionPaymentStatus

The payment status of the Checkout Session, one of paid, unpaid, or no_payment_required. You can use this value to decide when to fulfill your customer’s order.

CheckoutSessionRedirectOnCompletion

CheckoutSessionStatus

CheckoutSessionSubmitType

CheckoutSessionUiMode

CheckoutSofortPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutUsBankAccountPaymentMethodOptionsSetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

CheckoutUsBankAccountPaymentMethodOptionsVerificationMethod

Bank account verification method.

PaymentPagesCheckoutSessionAutomaticTaxStatus

The status of the most recent automated tax calculation for this session.

PaymentPagesCheckoutSessionConsentCollectionPromotions

If set to auto, enables the collection of customer consent for promotional communications. The Checkout. Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer’s locale. Only available to US merchants.

PaymentPagesCheckoutSessionConsentCollectionTermsOfService

If set to required, it requires customers to accept the terms of service before being able to pay.

PaymentPagesCheckoutSessionConsentPromotions

If opt_in, the customer consents to receiving promotional communications from the merchant about this Checkout Session.

PaymentPagesCheckoutSessionConsentTermsOfService

If accepted, the customer in this Checkout Session has agreed to the merchant’s terms of service.

PaymentPagesCheckoutSessionCustomFieldsLabelType

The type of the label.

PaymentPagesCheckoutSessionCustomFieldsType

The type of the field.

PaymentPagesCheckoutSessionCustomerDetailsTaxExempt

The customer’s tax exempt status after a completed Checkout Session.

PaymentPagesCheckoutSessionPaymentMethodReuseAgreementPosition

Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe’s defaults will be used.

PaymentPagesCheckoutSessionPermissionsUpdateShippingDetails

Determines which entity is allowed to update the shipping details.

PaymentPagesCheckoutSessionSavedPaymentMethodOptionsAllowRedisplayFilters

Uses the allow_redisplay value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.

PaymentPagesCheckoutSessionSavedPaymentMethodOptionsPaymentMethodRemove

Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.

PaymentPagesCheckoutSessionSavedPaymentMethodOptionsPaymentMethodSave

Enable customers to choose if they wish to save their payment method for future use. Disabled by default.

PaymentPagesCheckoutSessionShippingAddressCollectionAllowedCountries

An array of two-letter ISO country codes representing which countries Checkout should provide as options for. shipping locations. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI.

PaymentPagesCheckoutSessionTaxIdCollectionRequired

Indicates whether a tax ID is required on the payment page

PaymentPagesCheckoutSessionTaxIdType

The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, li_vat, my_itn, us_ein, kr_brn, ca_qst, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, my_sst, sg_gst, ae_trn, cl_tin, sa_vat, id_npwp, my_frp, il_vat, ge_vat, ua_vat, is_vat, bg_uic, hu_tin, si_tin, ke_pin, tr_tin, eg_tin, ph_tin, al_tin, bh_vat, kz_bin, ng_tin, om_vat, de_stn, ch_uid, tz_vat, uz_vat, uz_tin, md_vat, ma_vat, by_tin, ao_tin, bs_tin, bb_tin, cd_nif, mr_nif, me_pib, zw_tin, ba_tin, gn_nif, mk_vat, sr_fin, sn_ninea, am_tin, np_pan, tj_tin, ug_tin, zm_tin, kh_tin, aw_tin, az_tin, bd_bin, bj_ifu, et_tin, kg_tin, la_tin, cm_niu, cv_nif, bf_ifu, or unknown.

PaymentPagesPrivateCardPaymentMethodOptionsResourceRestrictionsBrandsBlocked

Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can’t complete the Session.