Expand description
This crate provides Rust bindings to the Stripe HTTP API, specifically
for requests mentioned in the Connect
section of the Stripe API docs
Modules§
- account
- account_
link - account_
session - application_
fee - application_
fee_ refund - apps_
secret - capability
- country_
spec - external_
account - login_
link - person
- topup
- transfer
- transfer_
reversal
Structs§
- Account
- This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.
- Account
Annual Revenue - Account
Bacs Debit Payments Settings - Account
Branding Settings - Account
Business Profile - Account
Capabilities - Account
Capability Future Requirements - Account
Capability Requirements - Account
Card Issuing Settings - Account
Card Payments Settings - Account
Dashboard Settings - Account
Decline Charge On - Account
Future Requirements - Account
Group Membership - Account
Id - Account
Invoices Settings - Account
Link - Account Links are the means by which a Connect platform grants a connected account permission to access. Stripe-hosted applications, such as Connect Onboarding.
- Account
Monthly Estimated Revenue - Account
Payments Settings - Account
Payout Settings - Account
Requirements - Account
Requirements Alternative - Account
Requirements Error - Account
Sepa Debit Payments Settings - Account
Session - An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.
- Account
Settings - Account
Terms OfService - Account
TosAcceptance - Account
Treasury Settings - Account
Unification Account Controller - Account
Unification Account Controller Fees - Account
Unification Account Controller Losses - Account
Unification Account Controller Stripe Dashboard - Application
- Application
Fee - For more details see <https://stripe.com/docs/api/application_fees/object>.
- Application
FeeId - Application
FeeRefund Application Fee Refund
objects allow you to refund an application fee that has previously been created but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.- Application
FeeRefund Id - Application
Id - Apps
Secret - Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.
- Apps
Secret Id - Capability
- This is an object representing a capability for a Stripe account.
- Capability
Id - Connect
Account Reference - Connect
Embedded Account Config Claim - Connect
Embedded Account Config Claim Builder - Connect
Embedded Account Features Claim - Connect
Embedded Account Features Claim Builder - Connect
Embedded Account Session Create Components - Connect
Embedded Account Session Create Components Builder - Connect
Embedded Base Config Claim - Connect
Embedded Base Config Claim Builder - Connect
Embedded Base Features - Connect
Embedded Base Features Builder - Connect
Embedded Financial Account Config Claim - Connect
Embedded Financial Account Config Claim Builder - Connect
Embedded Financial Account Features - Connect
Embedded Financial Account Features Builder - Connect
Embedded Financial Account Transactions Config Claim - Connect
Embedded Financial Account Transactions Config Claim Builder - Connect
Embedded Financial Account Transactions Features - Connect
Embedded Financial Account Transactions Features Builder - Connect
Embedded Issuing Card Config Claim - Connect
Embedded Issuing Card Config Claim Builder - Connect
Embedded Issuing Card Features - Connect
Embedded Issuing Card Features Builder - Connect
Embedded Issuing Cards List Config Claim - Connect
Embedded Issuing Cards List Config Claim Builder - Connect
Embedded Issuing Cards List Features - Connect
Embedded Issuing Cards List Features Builder - Connect
Embedded Payments Config Claim - Connect
Embedded Payments Config Claim Builder - Connect
Embedded Payments Features - Connect
Embedded Payments Features Builder - Connect
Embedded Payouts Config - Connect
Embedded Payouts Config Builder - Connect
Embedded Payouts Features - Connect
Embedded Payouts Features Builder - Country
Spec - Stripe needs to collect certain pieces of information about each account created. These requirements can differ depending on the account’s country. The Country Specs API makes these rules available to your integration.
- Country
Spec Id - Country
Spec Verification Field Details - Country
Spec Verification Field Details Builder - Country
Spec Verification Fields - Country
Spec Verification Fields Builder - Deleted
Account - Deleted
Person - External
Account Builder - Legal
Entity Company - Legal
Entity Company Verification - Legal
Entity Company Verification Document - Legal
Entity Directorship Declaration - Legal
Entity Dob - Legal
Entity Japan Address - Legal
Entity Person Verification - Legal
Entity Person Verification Document - Legal
Entity Registration Date - Legal
Entity UboDeclaration - Login
Link - Login Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard. A Login Link differs from an Account Link in that it takes the user directly to their Express dashboard for the specified account.
- Person
- This is an object representing a person associated with a Stripe account.
- Person
Additional TosAcceptance - Person
Additional TosAcceptances - Person
Ethnicity Details - Person
Future Requirements - Person
Id - Person
Race Details - Person
Relationship - Person
Requirements - Person
UsCfpb Data - Platform
Earning FeeSource - Secret
Service Resource Scope - Secret
Service Resource Scope Builder - Topup
- To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID.
- TopupId
- Transfer
- A
Transfer
object is created when you move funds between Stripe accounts as part of Connect. - Transfer
Data - Transfer
Id - Transfer
Reversal - Stripe Connect platforms can reverse transfers made to a connected account, either entirely or partially, and can also specify whether to refund any related application fees. Transfer reversals add to the platform’s balance and subtract from the destination account’s balance.
- Transfer
Reversal Id - Transfer
Schedule
Enums§
- Account
Business Profile Minority Owned Business Designation - Whether the business is a minority-owned, women-owned, and/or LGBTQI+-owned business.
- Account
Business Type - Account
Capabilities Status - Account
Capability Future Requirements Disabled Reason - This is typed as an enum for consistency with
requirements.disabled_reason
, but it safe to assumefuture_requirements.disabled_reason
is null because fields infuture_requirements
will never disable the account. - Account
Capability Requirements Disabled Reason - Description of why the capability is disabled. Learn more about handling verification issues.
- Account
Future Requirements Disabled Reason - This is typed as an enum for consistency with
requirements.disabled_reason
. - Account
Invoices Settings Hosted Payment Method Save - Whether payment methods should be saved when a payment is completed for a one-time invoices on a hosted invoice page.
- Account
Requirements Disabled Reason - If the account is disabled, this enum describes why. Learn more about handling verification issues.
- Account
Requirements Error Code - The code for the type of error.
- Account
Type - The Stripe account type. Can be
standard
,express
,custom
, ornone
. - Account
Unification Account Controller Fees Payer - A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about fee behavior on connected accounts.
- Account
Unification Account Controller Losses Payments - A value indicating who is liable when this account can’t pay back negative balances from payments.
- Account
Unification Account Controller Requirement Collection - A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.
- Account
Unification Account Controller Stripe Dashboard Type - A value indicating the Stripe dashboard this account has access to independent of the Connect application.
- Account
Unification Account Controller Type - The controller type.
Can be
application
, if a Connect application controls the account, oraccount
, if the account controls itself. - Capability
Status - The status of the capability.
- Connect
Account Reference Type - Type of the account referenced.
- External
Account - The resource representing a Stripe Polymorphic
- Legal
Entity Company Ownership Exemption Reason - This value is used to determine if a business is exempt from providing ultimate beneficial owners. See this support article and changelog for more details.
- Legal
Entity Company Structure - The category identifying the legal structure of the company or legal entity.
Also available for accounts where controller.requirement_collection is
stripe
. See Business structure for more details. - Person
Ethnicity Details Ethnicity - The persons ethnicity
- Person
Political Exposure - Person
Race Details Race - The persons race.
- Platform
Earning FeeSource Type - Type of object that created the application fee.
- Secret
Service Resource Scope Type - The secret scope type.
- Topup
Status - The status of the top-up is either
canceled
,failed
,pending
,reversed
, orsucceeded
.