The Stripe REST API. Please see https://stripe.com/docs/api for more details.
Contact
Terms of Service
https://stripe.com/us/terms/Servers
Default
Operations
Retrieve account
Retrieves the details of an account.
Authorizations
Basic HTTP authentication. Allowed headers-- Authorization: Basic <api_key> | Authorization: Basic <base64 hash of api_key:>
Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>
Parameters
Query Parameters
Specifies which fields in the response should be expanded.
Request Body
Responses
Successful response.
For new integrations, we recommend using the Accounts v2 API, in place of /v1/accounts and /v1/customers to represent a user.
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.
For accounts where controller.requirement_collection
is application, which includes Custom accounts, the properties below are always
returned.
For accounts where controller.requirement_collection
is stripe, which includes Standard and Express accounts, some properties are only returned
until you create an Account Link or Account Session
to start Connect Onboarding. Learn about the differences between accounts.
Business information about the account.
The business type.
"company""government_entity""individual""non_profit"Whether the account can process charges.
The account's country.
5000Time at which the account was connected. Measured in seconds since the Unix epoch.
"unix-time"Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
5000Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to an onboarding flow to finish submitting account details.
An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.
5000External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where controller[is_controller] is true.
The groups associated with the account.
Unique identifier for the object.
5000This is an object representing a person associated with a Stripe account.
A platform can only access a subset of data in a person for an account where account.controller.requirement_collection is stripe, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
See the Standard onboarding or Express onboarding documentation for information about prefilling information and account onboarding steps. Learn more about handling identity verification with the API.
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.
String representing the object's type. Objects of the same type share the same value.
"account"Whether the funds in this account can be paid out.
Options for customizing how the account functions within Stripe.
The Stripe account type. Can be standard, express, custom, or none.
"custom""express""none""standard"