--- title: "Retrieve an application fee" method: GET path: "/v1/application_fees/{id}" --- # Retrieve an application fee `GET /v1/application_fees/{id}` Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee. ## Path parameters - `id` string, required ## Query parameters - `expand` string[] ## Response `200` Successful response. - ApplicationFee - `account` union, required — ID of the Stripe account this fee was taken from. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), 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](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - `business_profile` AccountBusinessProfile - `annual_revenue` AccountAnnualRevenue - `amount` integer, nullable — A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal). - `currency` string, currency, nullable — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `fiscal_year_end` string, nullable — The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. - `estimated_worker_count` integer, nullable — An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. - `mcc` string, nullable — [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. - `minority_owned_business_designation` string[], nullable — Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business. - `monthly_estimated_revenue` AccountMonthlyEstimatedRevenue - `amount` integer, required — A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal). - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `name` string, nullable — The customer-facing business name. - `product_description` string, nullable — Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. - `support_address` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `support_email` string, nullable — A publicly available email address for sending support issues to. - `support_phone` string, nullable — A publicly available phone number to call with support issues. - `support_url` string, nullable — A publicly available website for handling support issues. - `url` string, nullable — The business's publicly available website. - `business_type` 'company' | 'government_entity' | 'individual' | 'non_profit', nullable — The business type. - `capabilities` AccountCapabilities - `acss_debit_payments` 'active' | 'inactive' | 'pending' — The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges. - `affirm_payments` 'active' | 'inactive' | 'pending' — The status of the Affirm capability of the account, or whether the account can directly process Affirm charges. - `afterpay_clearpay_payments` 'active' | 'inactive' | 'pending' — The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges. - `alma_payments` 'active' | 'inactive' | 'pending' — The status of the Alma capability of the account, or whether the account can directly process Alma payments. - `amazon_pay_payments` 'active' | 'inactive' | 'pending' — The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments. - `app_distribution` 'active' | 'inactive' | 'pending' — The status of the `app_distribution` capability of the account, or whether the platform can distribute apps to other accounts. - `au_becs_debit_payments` 'active' | 'inactive' | 'pending' — The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges. - `bacs_debit_payments` 'active' | 'inactive' | 'pending' — The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges. - `bancontact_payments` 'active' | 'inactive' | 'pending' — The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges. - `bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges. - `billie_payments` 'active' | 'inactive' | 'pending' — The status of the Billie capability of the account, or whether the account can directly process Billie payments. - `bizum_payments` 'active' | 'inactive' | 'pending' — The status of the Bizum capability of the account, or whether the account can directly process Bizum payments. - `blik_payments` 'active' | 'inactive' | 'pending' — The status of the blik payments capability of the account, or whether the account can directly process blik charges. - `boleto_payments` 'active' | 'inactive' | 'pending' — The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. - `card_issuing` 'active' | 'inactive' | 'pending' — The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards - `card_payments` 'active' | 'inactive' | 'pending' — The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. - `cartes_bancaires_payments` 'active' | 'inactive' | 'pending' — The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency. - `cashapp_payments` 'active' | 'inactive' | 'pending' — The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments. - `crypto_payments` 'active' | 'inactive' | 'pending' — The status of the Crypto capability of the account, or whether the account can directly process Crypto payments. - `eps_payments` 'active' | 'inactive' | 'pending' — The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. - `fpx_payments` 'active' | 'inactive' | 'pending' — The status of the FPX payments capability of the account, or whether the account can directly process FPX charges. - `gb_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges. - `giropay_payments` 'active' | 'inactive' | 'pending' — The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. - `grabpay_payments` 'active' | 'inactive' | 'pending' — The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. - `ideal_payments` 'active' | 'inactive' | 'pending' — The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges. - `india_international_payments` 'active' | 'inactive' | 'pending' — The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India. - `jcb_payments` 'active' | 'inactive' | 'pending' — The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency. - `jp_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges. - `kakao_pay_payments` 'active' | 'inactive' | 'pending' — The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments. - `klarna_payments` 'active' | 'inactive' | 'pending' — The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges. - `konbini_payments` 'active' | 'inactive' | 'pending' — The status of the konbini payments capability of the account, or whether the account can directly process konbini charges. - `kr_card_payments` 'active' | 'inactive' | 'pending' — The status of the KrCard capability of the account, or whether the account can directly process KrCard payments. - `legacy_payments` 'active' | 'inactive' | 'pending' — The status of the legacy payments capability of the account. - `link_payments` 'active' | 'inactive' | 'pending' — The status of the link_payments capability of the account, or whether the account can directly process Link charges. - `mb_way_payments` 'active' | 'inactive' | 'pending' — The status of the MB WAY payments capability of the account, or whether the account can directly process MB WAY charges. - `mobilepay_payments` 'active' | 'inactive' | 'pending' — The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges. - `multibanco_payments` 'active' | 'inactive' | 'pending' — The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges. - `mx_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges. - `naver_pay_payments` 'active' | 'inactive' | 'pending' — The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments. - `nz_bank_account_becs_debit_payments` 'active' | 'inactive' | 'pending' — The status of the New Zealand BECS Direct Debit payments capability of the account, or whether the account can directly process New Zealand BECS Direct Debit charges. - `oxxo_payments` 'active' | 'inactive' | 'pending' — The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. - `p24_payments` 'active' | 'inactive' | 'pending' — The status of the P24 payments capability of the account, or whether the account can directly process P24 charges. - `pay_by_bank_payments` 'active' | 'inactive' | 'pending' — The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges. - `payco_payments` 'active' | 'inactive' | 'pending' — The status of the Payco capability of the account, or whether the account can directly process Payco payments. - `paynow_payments` 'active' | 'inactive' | 'pending' — The status of the paynow payments capability of the account, or whether the account can directly process paynow charges. - `payto_payments` 'active' | 'inactive' | 'pending' — The status of the PayTo capability of the account, or whether the account can directly process PayTo charges. - `pix_payments` 'active' | 'inactive' | 'pending' — The status of the pix payments capability of the account, or whether the account can directly process pix charges. - `promptpay_payments` 'active' | 'inactive' | 'pending' — The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges. - `revolut_pay_payments` 'active' | 'inactive' | 'pending' — The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments. - `samsung_pay_payments` 'active' | 'inactive' | 'pending' — The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments. - `satispay_payments` 'active' | 'inactive' | 'pending' — The status of the Satispay capability of the account, or whether the account can directly process Satispay payments. - `scalapay_payments` 'active' | 'inactive' | 'pending' — The status of the Scalapay capability of the account, or whether the account can directly process Scalapay payments. - `sepa_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges. - `sepa_debit_payments` 'active' | 'inactive' | 'pending' — The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. - `sofort_payments` 'active' | 'inactive' | 'pending' — The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. - `sunbit_payments` 'active' | 'inactive' | 'pending' — The status of the Sunbit capability of the account, or whether the account can directly process Sunbit payments. - `swish_payments` 'active' | 'inactive' | 'pending' — The status of the Swish capability of the account, or whether the account can directly process Swish payments. - `tax_reporting_us_1099_k` 'active' | 'inactive' | 'pending' — The status of the tax reporting 1099-K (US) capability of the account. - `tax_reporting_us_1099_misc` 'active' | 'inactive' | 'pending' — The status of the tax reporting 1099-MISC (US) capability of the account. - `transfers` 'active' | 'inactive' | 'pending' — The status of the transfers capability of the account, or whether your platform can transfer funds to the account. - `treasury` 'active' | 'inactive' | 'pending' — The status of the banking capability, or whether the account can have bank accounts. - `twint_payments` 'active' | 'inactive' | 'pending' — The status of the TWINT capability of the account, or whether the account can directly process TWINT charges. - `upi_payments` 'active' | 'inactive' | 'pending' — The status of the upi payments capability of the account, or whether the account can directly process upi charges. - `us_bank_account_ach_payments` 'active' | 'inactive' | 'pending' — The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges. - `us_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges. - `zip_payments` 'active' | 'inactive' | 'pending' — The status of the Zip capability of the account, or whether the account can directly process Zip charges. - `charges_enabled` boolean — Whether the account can process charges. - `company` LegalEntityCompany - `address` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `address_kana` LegalEntityJapanAddress - `city` string, nullable — City/Ward. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Block/Building number. - `line2` string, nullable — Building details. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — Prefecture. - `town` string, nullable — Town/cho-me. - `address_kanji` LegalEntityJapanAddress - `city` string, nullable — City/Ward. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Block/Building number. - `line2` string, nullable — Building details. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — Prefecture. - `town` string, nullable — Town/cho-me. - `administrative_address` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `directors_provided` boolean — Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-directors_provided). - `directorship_declaration` LegalEntityDirectorshipDeclaration - `date` integer, nullable — The Unix timestamp marking when the directorship declaration attestation was made. - `ip` string, nullable — The IP address from which the directorship declaration attestation was made. - `user_agent` string, nullable — The user-agent string from the browser where the directorship declaration attestation was made. - `executives_provided` boolean — Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided. - `export_license_id` string — The export license ID number of the company, also referred as Import Export Code (India only). - `export_purpose_code` string — The purpose code to use for export transactions (India only). - `name` string, nullable — The company's legal name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `name_kana` string, nullable — The Kana variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `name_kanji` string, nullable — The Kanji variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `owners_provided` boolean — Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together). - `ownership_declaration` LegalEntityUboDeclaration - `date` integer, nullable — The Unix timestamp marking when the beneficial owner attestation was made. - `ip` string, nullable — The IP address from which the beneficial owner attestation was made. - `user_agent` string, nullable — The user-agent string from the browser where the beneficial owner attestation was made. - `ownership_exemption_reason` 'qualified_entity_exceeds_ownership_threshold' | 'qualifies_as_financial_institution' — This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details. - `phone` string, nullable — The company's phone number (used for verification). - `principal_place_of_business` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `registration_date` LegalEntityRegistrationDate - `day` integer, nullable — The day of registration, between 1 and 31. - `month` integer, nullable — The month of registration, between 1 and 12. - `year` integer, nullable — The four-digit year of registration. - `representative_declaration` LegalEntityRepresentativeDeclaration - `date` integer, nullable — The Unix timestamp marking when the representative declaration attestation was made. - `ip` string, nullable — The IP address from which the representative declaration attestation was made. - `user_agent` string, nullable — The user-agent string from the browser where the representative declaration attestation was made. - `structure` 'free_zone_establishment' | 'free_zone_llc' | 'government_instrumentality' | 'governmental_unit' | 'incorporated_non_profit' | 'incorporated_partnership' | 'limited_liability_partnership' | 'llc' | 'multi_member_llc' | 'private_company' | 'private_corporation' | 'private_partnership' | 'public_company' | 'public_corporation' | 'public_partnership' | 'registered_charity' | 'single_member_llc' | 'sole_establishment' | 'sole_proprietorship' | 'tax_exempt_government_instrumentality' | 'unincorporated_association' | 'unincorporated_non_profit' | 'unincorporated_partnership' — The category identifying the legal structure of the company or legal entity. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. - `tax_id_provided` boolean — Whether the company's business ID number was provided. - `tax_id_registrar` string — The jurisdiction in which the `tax_id` is registered (Germany-based companies only). - `vat_id_provided` boolean — Whether the company's business VAT number was provided. - `verification` LegalEntityCompanyVerification - `document` LegalEntityCompanyVerificationDocument, required - `back` union — The back of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file). - … - `details` string, nullable — A user-displayable string describing the verification state of this document. - `details_code` string, nullable — One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document. - `front` union — The front of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file). - … - `controller` AccountUnificationAccountController - `fees` AccountUnificationAccountControllerFees - `payer` 'account' | 'application' | 'application_custom' | 'application_express', required — 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](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior). - `is_controller` boolean — `true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://docs.stripe.com/connect/platform-controls-for-standard-accounts). Otherwise, this field is null. - `losses` AccountUnificationAccountControllerLosses - `payments` 'application' | 'stripe', required — A value indicating who is liable when this account can't pay back negative balances from payments. - `requirement_collection` 'application' | 'stripe' — A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account. - `stripe_dashboard` AccountUnificationAccountControllerStripeDashboard - `type` 'express' | 'full' | 'none', required — A value indicating the Stripe dashboard this account has access to independent of the Connect application. - `type` 'account' | 'application', required — The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself. - `country` string — The account's country. - `created` integer — Time at which the account was connected. Measured in seconds since the Unix epoch. - `default_currency` string — 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](https://stripe.com/docs/payouts). - `details_submitted` boolean — Whether 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](/connect/onboarding) to finish submitting account details. - `email` string, nullable — 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. - `external_accounts` object — External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true. - `data` union[], required — The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. - union - object — These bank accounts are payment methods on `Customer` objects. On the other hand [External Accounts](/api#external_accounts) are transfer destinations on `Account` objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) - … - object — You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `future_requirements` AccountFutureRequirements - `alternatives` AccountRequirementsAlternative[], nullable — Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. - `alternative_fields_due` string[], required — Fields that can be provided to resolve all fields in `original_fields_due`. - `original_fields_due` string[], required — Fields that are due and can be resolved by providing all fields in `alternative_fields_due`. - `current_deadline` integer, nullable — Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning. - `currently_due` string[], nullable — Fields that need to be resolved to keep the account enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. - `disabled_reason` 'action_required.requested_capabilities' | 'listed' | 'other' | 'platform_paused' | 'rejected.fraud' | 'rejected.incomplete_verification' | 'rejected.listed' | 'rejected.other' | 'rejected.platform_fraud' | 'rejected.platform_other' | 'rejected.platform_terms_of_service' | 'rejected.terms_of_service' | 'requirements.past_due' | 'requirements.pending_verification' | 'under_review', nullable — This is typed as an enum for consistency with `requirements.disabled_reason`. - `errors` AccountRequirementsError[], nullable — Fields that are `currently_due` and need to be collected again because validation or verification failed. - `code` 'external_request' | 'information_missing' | 'invalid_address_city_state_postal_code' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | 'invalid_business_profile_name' | 'invalid_business_profile_name_denylisted' | 'invalid_company_name_denylisted' | 'invalid_dob_age_over_maximum' | 'invalid_dob_age_under_18' | 'invalid_dob_age_under_minimum' | 'invalid_product_description_length' | 'invalid_product_description_url_match' | 'invalid_representative_country' | 'invalid_signator' | 'invalid_statement_descriptor_business_mismatch' | 'invalid_statement_descriptor_denylisted' | 'invalid_statement_descriptor_length' | 'invalid_statement_descriptor_prefix_denylisted' | 'invalid_statement_descriptor_prefix_mismatch' | 'invalid_street_address' | 'invalid_tax_id' | 'invalid_tax_id_format' | 'invalid_tos_acceptance' | 'invalid_url_denylisted' | 'invalid_url_format' | 'invalid_url_web_presence_detected' | 'invalid_url_website_business_information_mismatch' | 'invalid_url_website_empty' | 'invalid_url_website_inaccessible' | 'invalid_url_website_inaccessible_geoblocked' | 'invalid_url_website_inaccessible_password_protected' | 'invalid_url_website_incomplete' | 'invalid_url_website_incomplete_cancellation_policy' | 'invalid_url_website_incomplete_customer_service_details' | 'invalid_url_website_incomplete_legal_restrictions' | 'invalid_url_website_incomplete_refund_policy' | 'invalid_url_website_incomplete_return_policy' | 'invalid_url_website_incomplete_terms_and_conditions' | 'invalid_url_website_incomplete_under_construction' | 'invalid_url_website_other' | 'invalid_value_other' | 'unsupported_business_type' | 'verification_directors_mismatch' | 'verification_document_address_mismatch' | 'verification_document_address_missing' | 'verification_document_corrupt' | 'verification_document_country_not_supported' | 'verification_document_directors_mismatch' | 'verification_document_dob_mismatch' | 'verification_document_duplicate_type' | 'verification_document_expired' | 'verification_document_failed_copy' | 'verification_document_failed_greyscale' | 'verification_document_failed_other' | 'verification_document_failed_test_mode' | 'verification_document_fraudulent' | 'verification_document_id_number_mismatch' | 'verification_document_id_number_missing' | 'verification_document_incomplete' | 'verification_document_invalid' | 'verification_document_issue_or_expiry_date_missing' | 'verification_document_manipulated' | 'verification_document_missing_back' | 'verification_document_missing_front' | 'verification_document_name_mismatch' | 'verification_document_name_missing' | 'verification_document_nationality_mismatch' | 'verification_document_not_readable' | 'verification_document_not_signed' | 'verification_document_not_uploaded' | 'verification_document_photo_mismatch' | 'verification_document_too_large' | 'verification_document_type_not_supported' | 'verification_extraneous_directors' | 'verification_failed_address_match' | 'verification_failed_authorizer_authority' | 'verification_failed_business_iec_number' | 'verification_failed_document_match' | 'verification_failed_id_number_match' | 'verification_failed_keyed_identity' | 'verification_failed_keyed_match' | 'verification_failed_name_match' | 'verification_failed_other' | 'verification_failed_representative_authority' | 'verification_failed_residential_address' | 'verification_failed_tax_id_match' | 'verification_failed_tax_id_not_issued' | 'verification_legal_entity_structure_mismatch' | 'verification_missing_directors' | 'verification_missing_executives' | 'verification_missing_owners' | 'verification_rejected_ownership_exemption_reason' | 'verification_requires_additional_memorandum_of_associations' | 'verification_requires_additional_proof_of_registration' | 'verification_supportability', required — The code for the type of error. - `reason` string, required — An informative message that indicates the error type and provides additional details about the error. - `requirement` string, required — The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. - `eventually_due` string[], nullable — Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. - `past_due` string[], nullable — Fields that haven't been resolved by `requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`. - `pending_verification` string[], nullable — Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. - `groups` AccountGroupMembership - `payments_pricing` string, nullable — The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://docs.stripe.com/connect/platform-pricing-tools) for details. - `id` string, required — Unique identifier for the object. - `individual` Person — This 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](/api/accounts/object#account_object-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](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information). - `account` string, required — The account the person is associated with. - `additional_tos_acceptances` PersonAdditionalTosAcceptances - `account` PersonAdditionalTosAcceptance - `date` integer, nullable — The Unix timestamp marking when the legal guardian accepted the service agreement. - `ip` string, nullable — The IP address from which the legal guardian accepted the service agreement. - `user_agent` string, nullable — The user agent of the browser from which the legal guardian accepted the service agreement. - `address` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `address_kana` LegalEntityJapanAddress - `city` string, nullable — City/Ward. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Block/Building number. - `line2` string, nullable — Building details. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — Prefecture. - `town` string, nullable — Town/cho-me. - `address_kanji` LegalEntityJapanAddress - `city` string, nullable — City/Ward. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Block/Building number. - `line2` string, nullable — Building details. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — Prefecture. - `town` string, nullable — Town/cho-me. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `dob` LegalEntityDob - `day` integer, nullable — The day of birth, between 1 and 31. - `month` integer, nullable — The month of birth, between 1 and 12. - `year` integer, nullable — The four-digit year of birth. - `email` string, nullable — The person's email address. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `first_name` string, nullable — The person's first name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `first_name_kana` string, nullable — The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `first_name_kanji` string, nullable — The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `full_name_aliases` string[] — A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `future_requirements` PersonFutureRequirements - `alternatives` AccountRequirementsAlternative[], nullable — Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. - `alternative_fields_due` string[], required — Fields that can be provided to resolve all fields in `original_fields_due`. - `original_fields_due` string[], required — Fields that are due and can be resolved by providing all fields in `alternative_fields_due`. - `currently_due` string[], required — Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition. - `errors` AccountRequirementsError[], required — Fields that are `currently_due` and need to be collected again because validation or verification failed. - `code` 'external_request' | 'information_missing' | 'invalid_address_city_state_postal_code' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | 'invalid_business_profile_name' | 'invalid_business_profile_name_denylisted' | 'invalid_company_name_denylisted' | 'invalid_dob_age_over_maximum' | 'invalid_dob_age_under_18' | 'invalid_dob_age_under_minimum' | 'invalid_product_description_length' | 'invalid_product_description_url_match' | 'invalid_representative_country' | 'invalid_signator' | 'invalid_statement_descriptor_business_mismatch' | 'invalid_statement_descriptor_denylisted' | 'invalid_statement_descriptor_length' | 'invalid_statement_descriptor_prefix_denylisted' | 'invalid_statement_descriptor_prefix_mismatch' | 'invalid_street_address' | 'invalid_tax_id' | 'invalid_tax_id_format' | 'invalid_tos_acceptance' | 'invalid_url_denylisted' | 'invalid_url_format' | 'invalid_url_web_presence_detected' | 'invalid_url_website_business_information_mismatch' | 'invalid_url_website_empty' | 'invalid_url_website_inaccessible' | 'invalid_url_website_inaccessible_geoblocked' | 'invalid_url_website_inaccessible_password_protected' | 'invalid_url_website_incomplete' | 'invalid_url_website_incomplete_cancellation_policy' | 'invalid_url_website_incomplete_customer_service_details' | 'invalid_url_website_incomplete_legal_restrictions' | 'invalid_url_website_incomplete_refund_policy' | 'invalid_url_website_incomplete_return_policy' | 'invalid_url_website_incomplete_terms_and_conditions' | 'invalid_url_website_incomplete_under_construction' | 'invalid_url_website_other' | 'invalid_value_other' | 'unsupported_business_type' | 'verification_directors_mismatch' | 'verification_document_address_mismatch' | 'verification_document_address_missing' | 'verification_document_corrupt' | 'verification_document_country_not_supported' | 'verification_document_directors_mismatch' | 'verification_document_dob_mismatch' | 'verification_document_duplicate_type' | 'verification_document_expired' | 'verification_document_failed_copy' | 'verification_document_failed_greyscale' | 'verification_document_failed_other' | 'verification_document_failed_test_mode' | 'verification_document_fraudulent' | 'verification_document_id_number_mismatch' | 'verification_document_id_number_missing' | 'verification_document_incomplete' | 'verification_document_invalid' | 'verification_document_issue_or_expiry_date_missing' | 'verification_document_manipulated' | 'verification_document_missing_back' | 'verification_document_missing_front' | 'verification_document_name_mismatch' | 'verification_document_name_missing' | 'verification_document_nationality_mismatch' | 'verification_document_not_readable' | 'verification_document_not_signed' | 'verification_document_not_uploaded' | 'verification_document_photo_mismatch' | 'verification_document_too_large' | 'verification_document_type_not_supported' | 'verification_extraneous_directors' | 'verification_failed_address_match' | 'verification_failed_authorizer_authority' | 'verification_failed_business_iec_number' | 'verification_failed_document_match' | 'verification_failed_id_number_match' | 'verification_failed_keyed_identity' | 'verification_failed_keyed_match' | 'verification_failed_name_match' | 'verification_failed_other' | 'verification_failed_representative_authority' | 'verification_failed_residential_address' | 'verification_failed_tax_id_match' | 'verification_failed_tax_id_not_issued' | 'verification_legal_entity_structure_mismatch' | 'verification_missing_directors' | 'verification_missing_executives' | 'verification_missing_owners' | 'verification_rejected_ownership_exemption_reason' | 'verification_requires_additional_memorandum_of_associations' | 'verification_requires_additional_proof_of_registration' | 'verification_supportability', required — The code for the type of error. - `reason` string, required — An informative message that indicates the error type and provides additional details about the error. - `requirement` string, required — The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. - `eventually_due` string[], required — Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set. - `past_due` string[], required — Fields that haven't been resolved by the account's `requirements.current_deadline`. These fields need to be resolved to enable the person's account. `future_requirements.past_due` is a subset of `requirements.past_due`. - `pending_verification` string[], required — Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. - `gender` string, nullable — The person's gender. - `id` string, required — Unique identifier for the object. - `id_number_provided` boolean — Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`). - `id_number_secondary_provided` boolean — Whether the person's `id_number_secondary` was provided. - `last_name` string, nullable — The person's last name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `last_name_kana` string, nullable — The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `last_name_kanji` string, nullable — The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `maiden_name` string, nullable — The person's maiden name. - `metadata` object — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `nationality` string, nullable — The country where the person is a national. - `object` 'person', required — String representing the object's type. Objects of the same type share the same value. - `phone` string, nullable — The person's phone number. - `political_exposure` 'existing' | 'none' — Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. - `registered_address` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `relationship` PersonRelationship - `authorizer` boolean, nullable — Whether the person is the authorizer of the account's representative. - `director` boolean, nullable — Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. - `executive` boolean, nullable — Whether the person has significant responsibility to control, manage, or direct the organization. - `legal_guardian` boolean, nullable — Whether the person is the legal guardian of the account's representative. - `owner` boolean, nullable — Whether the person is an owner of the account’s legal entity. - `percent_ownership` number, nullable — The percent owned by the person of the account's legal entity. - `representative` boolean, nullable — Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account. - `title` string, nullable — The person's title (e.g., CEO, Support Engineer). - `requirements` PersonRequirements - `alternatives` AccountRequirementsAlternative[], nullable — Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. - `alternative_fields_due` string[], required — Fields that can be provided to resolve all fields in `original_fields_due`. - `original_fields_due` string[], required — Fields that are due and can be resolved by providing all fields in `alternative_fields_due`. - `currently_due` string[], required — Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled. - `errors` AccountRequirementsError[], required — Fields that are `currently_due` and need to be collected again because validation or verification failed. - `code` 'external_request' | 'information_missing' | 'invalid_address_city_state_postal_code' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | 'invalid_business_profile_name' | 'invalid_business_profile_name_denylisted' | 'invalid_company_name_denylisted' | 'invalid_dob_age_over_maximum' | 'invalid_dob_age_under_18' | 'invalid_dob_age_under_minimum' | 'invalid_product_description_length' | 'invalid_product_description_url_match' | 'invalid_representative_country' | 'invalid_signator' | 'invalid_statement_descriptor_business_mismatch' | 'invalid_statement_descriptor_denylisted' | 'invalid_statement_descriptor_length' | 'invalid_statement_descriptor_prefix_denylisted' | 'invalid_statement_descriptor_prefix_mismatch' | 'invalid_street_address' | 'invalid_tax_id' | 'invalid_tax_id_format' | 'invalid_tos_acceptance' | 'invalid_url_denylisted' | 'invalid_url_format' | 'invalid_url_web_presence_detected' | 'invalid_url_website_business_information_mismatch' | 'invalid_url_website_empty' | 'invalid_url_website_inaccessible' | 'invalid_url_website_inaccessible_geoblocked' | 'invalid_url_website_inaccessible_password_protected' | 'invalid_url_website_incomplete' | 'invalid_url_website_incomplete_cancellation_policy' | 'invalid_url_website_incomplete_customer_service_details' | 'invalid_url_website_incomplete_legal_restrictions' | 'invalid_url_website_incomplete_refund_policy' | 'invalid_url_website_incomplete_return_policy' | 'invalid_url_website_incomplete_terms_and_conditions' | 'invalid_url_website_incomplete_under_construction' | 'invalid_url_website_other' | 'invalid_value_other' | 'unsupported_business_type' | 'verification_directors_mismatch' | 'verification_document_address_mismatch' | 'verification_document_address_missing' | 'verification_document_corrupt' | 'verification_document_country_not_supported' | 'verification_document_directors_mismatch' | 'verification_document_dob_mismatch' | 'verification_document_duplicate_type' | 'verification_document_expired' | 'verification_document_failed_copy' | 'verification_document_failed_greyscale' | 'verification_document_failed_other' | 'verification_document_failed_test_mode' | 'verification_document_fraudulent' | 'verification_document_id_number_mismatch' | 'verification_document_id_number_missing' | 'verification_document_incomplete' | 'verification_document_invalid' | 'verification_document_issue_or_expiry_date_missing' | 'verification_document_manipulated' | 'verification_document_missing_back' | 'verification_document_missing_front' | 'verification_document_name_mismatch' | 'verification_document_name_missing' | 'verification_document_nationality_mismatch' | 'verification_document_not_readable' | 'verification_document_not_signed' | 'verification_document_not_uploaded' | 'verification_document_photo_mismatch' | 'verification_document_too_large' | 'verification_document_type_not_supported' | 'verification_extraneous_directors' | 'verification_failed_address_match' | 'verification_failed_authorizer_authority' | 'verification_failed_business_iec_number' | 'verification_failed_document_match' | 'verification_failed_id_number_match' | 'verification_failed_keyed_identity' | 'verification_failed_keyed_match' | 'verification_failed_name_match' | 'verification_failed_other' | 'verification_failed_representative_authority' | 'verification_failed_residential_address' | 'verification_failed_tax_id_match' | 'verification_failed_tax_id_not_issued' | 'verification_legal_entity_structure_mismatch' | 'verification_missing_directors' | 'verification_missing_executives' | 'verification_missing_owners' | 'verification_rejected_ownership_exemption_reason' | 'verification_requires_additional_memorandum_of_associations' | 'verification_requires_additional_proof_of_registration' | 'verification_supportability', required — The code for the type of error. - `reason` string, required — An informative message that indicates the error type and provides additional details about the error. - `requirement` string, required — The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. - `eventually_due` string[], required — Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. - `past_due` string[], required — Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the person's account. - `pending_verification` string[], required — Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. - `ssn_last_4_provided` boolean — Whether the last four digits of the person's Social Security number have been provided (U.S. only). - `us_cfpb_data` PersonUsCfpbData - `ethnicity_details` PersonEthnicityDetails - `ethnicity` string[], nullable — The persons ethnicity - `ethnicity_other` string, nullable — Please specify your origin, when other is selected. - `race_details` PersonRaceDetails - `race` string[], nullable — The persons race. - `race_other` string, nullable — Please specify your race, when other is selected. - `self_identified_gender` string, nullable — The persons self-identified gender - `verification` LegalEntityPersonVerification - `additional_document` LegalEntityPersonVerificationDocument - `back` union — The back of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. - … - `details` string, nullable — A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read". - `details_code` string, nullable — One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document. - `front` union — The front of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. - … - `details` string, nullable — A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified". - `details_code` string, nullable — One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person. - `document` LegalEntityPersonVerificationDocument - `back` union — The back of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. - … - `details` string, nullable — A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read". - `details_code` string, nullable — One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document. - `front` union — The front of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. - … - `status` string, required — The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. Please refer [guide](https://docs.stripe.com/connect/handling-api-verification) to handle verification updates. - `metadata` object — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'account', required — String representing the object's type. Objects of the same type share the same value. - `payouts_enabled` boolean — Whether the funds in this account can be paid out. - `requirements` AccountRequirements - `alternatives` AccountRequirementsAlternative[], nullable — Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. - `alternative_fields_due` string[], required — Fields that can be provided to resolve all fields in `original_fields_due`. - `original_fields_due` string[], required — Fields that are due and can be resolved by providing all fields in `alternative_fields_due`. - `current_deadline` integer, nullable — Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected. - `currently_due` string[], nullable — Fields that need to be resolved to keep the account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account will be disabled. - `disabled_reason` 'action_required.requested_capabilities' | 'listed' | 'other' | 'platform_paused' | 'rejected.fraud' | 'rejected.incomplete_verification' | 'rejected.listed' | 'rejected.other' | 'rejected.platform_fraud' | 'rejected.platform_other' | 'rejected.platform_terms_of_service' | 'rejected.terms_of_service' | 'requirements.past_due' | 'requirements.pending_verification' | 'under_review', nullable — If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification). - `errors` AccountRequirementsError[], nullable — Fields that are `currently_due` and need to be collected again because validation or verification failed. - `code` 'external_request' | 'information_missing' | 'invalid_address_city_state_postal_code' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | 'invalid_business_profile_name' | 'invalid_business_profile_name_denylisted' | 'invalid_company_name_denylisted' | 'invalid_dob_age_over_maximum' | 'invalid_dob_age_under_18' | 'invalid_dob_age_under_minimum' | 'invalid_product_description_length' | 'invalid_product_description_url_match' | 'invalid_representative_country' | 'invalid_signator' | 'invalid_statement_descriptor_business_mismatch' | 'invalid_statement_descriptor_denylisted' | 'invalid_statement_descriptor_length' | 'invalid_statement_descriptor_prefix_denylisted' | 'invalid_statement_descriptor_prefix_mismatch' | 'invalid_street_address' | 'invalid_tax_id' | 'invalid_tax_id_format' | 'invalid_tos_acceptance' | 'invalid_url_denylisted' | 'invalid_url_format' | 'invalid_url_web_presence_detected' | 'invalid_url_website_business_information_mismatch' | 'invalid_url_website_empty' | 'invalid_url_website_inaccessible' | 'invalid_url_website_inaccessible_geoblocked' | 'invalid_url_website_inaccessible_password_protected' | 'invalid_url_website_incomplete' | 'invalid_url_website_incomplete_cancellation_policy' | 'invalid_url_website_incomplete_customer_service_details' | 'invalid_url_website_incomplete_legal_restrictions' | 'invalid_url_website_incomplete_refund_policy' | 'invalid_url_website_incomplete_return_policy' | 'invalid_url_website_incomplete_terms_and_conditions' | 'invalid_url_website_incomplete_under_construction' | 'invalid_url_website_other' | 'invalid_value_other' | 'unsupported_business_type' | 'verification_directors_mismatch' | 'verification_document_address_mismatch' | 'verification_document_address_missing' | 'verification_document_corrupt' | 'verification_document_country_not_supported' | 'verification_document_directors_mismatch' | 'verification_document_dob_mismatch' | 'verification_document_duplicate_type' | 'verification_document_expired' | 'verification_document_failed_copy' | 'verification_document_failed_greyscale' | 'verification_document_failed_other' | 'verification_document_failed_test_mode' | 'verification_document_fraudulent' | 'verification_document_id_number_mismatch' | 'verification_document_id_number_missing' | 'verification_document_incomplete' | 'verification_document_invalid' | 'verification_document_issue_or_expiry_date_missing' | 'verification_document_manipulated' | 'verification_document_missing_back' | 'verification_document_missing_front' | 'verification_document_name_mismatch' | 'verification_document_name_missing' | 'verification_document_nationality_mismatch' | 'verification_document_not_readable' | 'verification_document_not_signed' | 'verification_document_not_uploaded' | 'verification_document_photo_mismatch' | 'verification_document_too_large' | 'verification_document_type_not_supported' | 'verification_extraneous_directors' | 'verification_failed_address_match' | 'verification_failed_authorizer_authority' | 'verification_failed_business_iec_number' | 'verification_failed_document_match' | 'verification_failed_id_number_match' | 'verification_failed_keyed_identity' | 'verification_failed_keyed_match' | 'verification_failed_name_match' | 'verification_failed_other' | 'verification_failed_representative_authority' | 'verification_failed_residential_address' | 'verification_failed_tax_id_match' | 'verification_failed_tax_id_not_issued' | 'verification_legal_entity_structure_mismatch' | 'verification_missing_directors' | 'verification_missing_executives' | 'verification_missing_owners' | 'verification_rejected_ownership_exemption_reason' | 'verification_requires_additional_memorandum_of_associations' | 'verification_requires_additional_proof_of_registration' | 'verification_supportability', required — The code for the type of error. - `reason` string, required — An informative message that indicates the error type and provides additional details about the error. - `requirement` string, required — The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. - `eventually_due` string[], nullable — Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. - `past_due` string[], nullable — Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the account. - `pending_verification` string[], nullable — Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. - `settings` AccountSettings - `bacs_debit_payments` AccountBacsDebitPaymentsSettings - `display_name` string, nullable — The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free. - `service_user_number` string, nullable — The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners. - `branding` AccountBrandingSettings, required - `icon` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px. - string - File — This object represents files hosted on Stripe's servers. You can upload files with the [create file](https://api.stripe.com#create_file) request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a [Sigma scheduled query](#scheduled_queries)). Related guide: [File upload guide](https://docs.stripe.com/file-upload) - … - `logo` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px. - string - File — This object represents files hosted on Stripe's servers. You can upload files with the [create file](https://api.stripe.com#create_file) request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a [Sigma scheduled query](#scheduled_queries)). Related guide: [File upload guide](https://docs.stripe.com/file-upload) - … - `primary_color` string, nullable — A CSS hex color value representing the primary branding color for this account - `secondary_color` string, nullable — A CSS hex color value representing the secondary branding color for this account - `card_issuing` AccountCardIssuingSettings - `tos_acceptance` CardIssuingAccountTermsOfService - `date` integer, nullable — The Unix timestamp marking when the account representative accepted the service agreement. - `ip` string, nullable — The IP address from which the account representative accepted the service agreement. - `user_agent` string — The user agent of the browser from which the account representative accepted the service agreement. - `card_payments` AccountCardPaymentsSettings, required - `decline_on` AccountDeclineChargeOn - `avs_failure` boolean, required — Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification. - `cvc_failure` boolean, required — Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification. - `statement_descriptor_prefix` string, nullable — The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion. - `statement_descriptor_prefix_kana` string, nullable — The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion. - `statement_descriptor_prefix_kanji` string, nullable — The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion. - `dashboard` AccountDashboardSettings, required - `display_name` string, nullable — The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. - `timezone` string, nullable — The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). - `invoices` AccountInvoicesSettings - `default_account_tax_ids` union[], nullable — The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized. - union - … - `hosted_payment_method_save` 'always' | 'never' | 'offer', nullable — Whether to save the payment method after a payment is completed for a one-time invoice or a subscription invoice when the customer already has a default payment method on the hosted invoice page. - `payments` AccountPaymentsSettings, required - `statement_descriptor` string, nullable — The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. - `statement_descriptor_kana` string, nullable — The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). - `statement_descriptor_kanji` string, nullable — The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). - `payouts` AccountPayoutSettings - `debit_negative_balances` boolean, required — A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`. - `schedule` TransferSchedule, required - `delay_days` integer, required — The number of days charges for the account will be held before being paid out. - `interval` string, required — How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`. - `monthly_anchor` integer — The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months. - `monthly_payout_days` integer[] — The days of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months. - `weekly_anchor` string — The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly. - `weekly_payout_days` string[] — The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly. - `statement_descriptor` string, nullable — The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. - `sepa_debit_payments` AccountSepaDebitPaymentsSettings - `creditor_id` string — SEPA creditor identifier that identifies the company making the payment. - `treasury` AccountTreasurySettings - `tos_acceptance` AccountTermsOfService - `date` integer, nullable — The Unix timestamp marking when the account representative accepted the service agreement. - `ip` string, nullable — The IP address from which the account representative accepted the service agreement. - `user_agent` string — The user agent of the browser from which the account representative accepted the service agreement. - `tos_acceptance` AccountTosAcceptance - `date` integer, nullable — The Unix timestamp marking when the account representative accepted their service agreement - `ip` string, nullable — The IP address from which the account representative accepted their service agreement - `service_agreement` string — The user's service agreement type - `user_agent` string, nullable — The user agent of the browser from which the account representative accepted their service agreement - `type` 'custom' | 'express' | 'none' | 'standard' — The Stripe account type. Can be `standard`, `express`, `custom`, or `none`. - `amount` integer, required — Amount earned, in cents (or local equivalent). - `amount_refunded` integer, required — Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued) - `application` union, required — ID of the Connect application that earned the fee. - string - Application - `id` string, required — Unique identifier for the object. - `name` string, nullable — The name of the application. - `object` 'application', required — String representing the object's type. Objects of the same type share the same value. - `balance_transaction` union — Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). - string - BalanceTransaction — Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe account balance. Related guide: [Balance transaction types](https://docs.stripe.com/reports/balance-transaction-types) - `amount` integer, required — Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party. - `available_on` integer, required — The date that the transaction's net funds become available in the Stripe balance. - `balance_type` 'issuing' | 'payments' | 'refund_and_dispute_prefunding' | 'risk_reserved', required — The balance that this transaction impacts. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `exchange_rate` number, nullable — If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multiplied by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`. - `fee` integer, required — Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed. - `fee_details` Fee[], required — Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction. - `amount` integer, required — Amount of the fee, in cents. - `application` string, nullable — ID of the Connect application that earned the fee. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `type` string, required — Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee`, `tax`, or `withheld_tax`. - `id` string, required — Unique identifier for the object. - `net` integer, required — Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee` - `object` 'balance_transaction', required — String representing the object's type. Objects of the same type share the same value. - `reporting_category` string, required — Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective. - `source` union — This transaction relates to the Stripe object. - string - ApplicationFee — recursive - Charge — The `Charge` object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://docs.stripe.com/connect/account-debits) may also create Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations. - `amount` integer, required — Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). - `amount_captured` integer, required — Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made). - `amount_refunded` integer, required — Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued). - `application` union — ID of the Connect application that created the charge. - string - Application - … - `application_fee` union — The application fee (if any) for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details. - string - ApplicationFee — recursive - `application_fee_amount` integer, nullable — The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details. - `balance_transaction` union — ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). - string - BalanceTransaction — recursive - `billing_details` BillingDetails, required - `address` Address - … - `email` string, nullable — Email address. - `name` string, nullable — Full name. - `phone` string, nullable — Billing phone number (including extension). - `tax_id` string, nullable — Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers. - `calculated_statement_descriptor` string, nullable — The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments. - `captured` boolean, required — If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `customer` union — ID of the customer this charge is for if one exists. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - … - DeletedCustomer - … - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `disputed` boolean, required — Whether the charge has been disputed. - `failure_balance_transaction` union — ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. - string - BalanceTransaction — recursive - `failure_code` string, nullable — Error code explaining reason for charge failure if available (see [the errors section](https://docs.stripe.com/error-codes) for a list of codes). - `failure_message` string, nullable — Message to user further explaining reason for charge failure if available. - `fraud_details` ChargeFraudDetails - `stripe_report` string — Assessments from Stripe. If set, the value is `fraudulent`. - `user_report` string — Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'charge', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), 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](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - … - `outcome` ChargeOutcome - `advice_code` 'confirm_card_data' | 'do_not_try_again' | 'try_again_later', nullable — An enumerated value providing a more detailed explanation on [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines). - `network_advice_code` string, nullable — For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error. - `network_decline_code` string, nullable — For charges declined by the network, an alphanumeric code which indicates the reason the charge failed. - `network_status` string, nullable — Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://docs.stripe.com/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement. - `reason` string, nullable — An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges blocked because the payment is unlikely to be authorized have the value `low_probability_of_authorization`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://docs.stripe.com/declines) for more details. - `risk_level` string — Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar. - `risk_score` integer — Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams. - `rule` union — The ID of the Radar rule that matched the payment, if applicable. - … - `seller_message` string, nullable — A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. - `type` string, required — Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://docs.stripe.com/declines) and [Radar reviews](https://docs.stripe.com/radar/reviews) for details. - `paid` boolean, required — `true` if the charge succeeded, or was successfully authorized for later capture. - `payment_intent` union — ID of the PaymentIntent associated with this charge, if one exists. - string - PaymentIntent — A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session. A PaymentIntent transitions through [multiple statuses](/payments/paymentintents/lifecycle) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents) - … - `payment_method` string, nullable — ID of the payment method used in this charge. - `payment_method_details` PaymentMethodDetails - `ach_credit_transfer` PaymentMethodDetailsAchCreditTransfer - … - `ach_debit` PaymentMethodDetailsAchDebit - … - `acss_debit` PaymentMethodDetailsAcssDebit - … - `affirm` PaymentMethodDetailsAffirm - … - `afterpay_clearpay` PaymentMethodDetailsAfterpayClearpay - … - `alipay` PaymentMethodDetailsAlipay - … - `alma` PaymentMethodDetailsAlma - … - `amazon_pay` PaymentMethodDetailsAmazonPay - … - `au_becs_debit` PaymentMethodDetailsAuBecsDebit - … - `bacs_debit` PaymentMethodDetailsBacsDebit - … - `bancontact` PaymentMethodDetailsBancontact - … - `billie` PaymentMethodDetailsBillie - … - `bizum` PaymentMethodDetailsBizum - … - `blik` PaymentMethodDetailsBlik - … - `boleto` PaymentMethodDetailsBoleto - … - `card` PaymentMethodDetailsCard - … - `card_present` PaymentMethodDetailsCardPresent - … - `cashapp` PaymentMethodDetailsCashapp - … - `crypto` PaymentMethodDetailsCrypto - … - `customer_balance` PaymentMethodDetailsCustomerBalance - `eps` PaymentMethodDetailsEps - … - `fpx` PaymentMethodDetailsFpx - … - `giropay` PaymentMethodDetailsGiropay - … - `grabpay` PaymentMethodDetailsGrabpay - … - `ideal` PaymentMethodDetailsIdeal - … - `interac_present` PaymentMethodDetailsInteracPresent - … - `kakao_pay` PaymentMethodDetailsKakaoPay - … - `klarna` PaymentMethodDetailsKlarna - … - `konbini` PaymentMethodDetailsKonbini - … - `kr_card` PaymentMethodDetailsKrCard - … - `link` PaymentMethodDetailsLink - … - `mb_way` PaymentMethodDetailsMbWay - `mobilepay` PaymentMethodDetailsMobilepay - … - `multibanco` PaymentMethodDetailsMultibanco - … - `naver_pay` PaymentMethodDetailsNaverPay - … - `nz_bank_account` PaymentMethodDetailsNzBankAccount - … - `oxxo` PaymentMethodDetailsOxxo - … - `p24` PaymentMethodDetailsP24 - … - `pay_by_bank` PaymentMethodDetailsPayByBank - `payco` PaymentMethodDetailsPayco - … - `paynow` PaymentMethodDetailsPaynow - … - `paypal` PaymentMethodDetailsPaypal - … - `payto` PaymentMethodDetailsPayto - … - `pix` PaymentMethodDetailsPix - … - `promptpay` PaymentMethodDetailsPromptpay - … - `revolut_pay` PaymentMethodDetailsRevolutPay - … - `samsung_pay` PaymentMethodDetailsSamsungPay - … - `satispay` PaymentMethodDetailsSatispay - … - `scalapay` PaymentMethodDetailsScalapay - … - `sepa_debit` PaymentMethodDetailsSepaDebit - … - `sofort` PaymentMethodDetailsSofort - … - `stripe_account` PaymentMethodDetailsStripeAccount - `sunbit` PaymentMethodDetailsSunbit - … - `swish` PaymentMethodDetailsSwish - … - `twint` PaymentMethodDetailsTwint - … - `type` string, required — The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) for the full list of possible types. An additional hash is included on `payment_method_details` with a name matching this value. It contains information specific to the payment method. - `upi` PaymentMethodDetailsUpi - … - `us_bank_account` PaymentMethodDetailsUsBankAccount - … - `wechat` PaymentMethodDetailsWechat - `wechat_pay` PaymentMethodDetailsWechatPay - … - `zip` PaymentMethodDetailsZip - `presentment_details` PaymentFlowsPaymentIntentPresentmentDetails - `presentment_amount` integer, required — Amount intended to be collected by this payment, denominated in `presentment_currency`. - `presentment_currency` string, required — Currency presented to the customer during payment. - `radar_options` RadarRadarOptions — Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. - `session` string — A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. - `receipt_email` string, nullable — This is the email address that the receipt for this charge was sent to. - `receipt_number` string, nullable — This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent. - `receipt_url` string, nullable — This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt. - `refunded` boolean, required — Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. - `refunds` object, nullable — A list of refunds that have been applied to the charge. - `data` Refund[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `review` union — ID of the review associated with this charge if one exists. - string - Review — Reviews can be used to supplement automated fraud detection with human expertise. Learn more about [Radar](/radar) and reviewing payments [here](https://docs.stripe.com/radar/reviews). - … - `shipping` Shipping - `address` Address - … - `carrier` string, nullable — The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. - `name` string — Recipient name. - `phone` string, nullable — Recipient phone (including extension). - `tracking_number` string, nullable — The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. - `source_transfer` union — The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. - string - Transfer — A `Transfer` object is created when you move funds between Stripe accounts as part of Connect. Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a [Payout](https://api.stripe.com#payout_object) object, with corresponding payout endpoints. For more information, read about the [transfer/payout split](https://docs.stripe.com/transfer-payout-split). Related guide: [Creating separate charges and transfers](https://docs.stripe.com/connect/separate-charges-and-transfers) - … - `statement_descriptor` string, nullable — For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix. - `statement_descriptor_suffix` string, nullable — Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor. - `status` 'failed' | 'pending' | 'succeeded', required — The status of the payment is either `succeeded`, `pending`, or `failed`. - `transfer` union — ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). - string - Transfer — A `Transfer` object is created when you move funds between Stripe accounts as part of Connect. Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a [Payout](https://api.stripe.com#payout_object) object, with corresponding payout endpoints. For more information, read about the [transfer/payout split](https://docs.stripe.com/transfer-payout-split). Related guide: [Creating separate charges and transfers](https://docs.stripe.com/connect/separate-charges-and-transfers) - … - `transfer_data` ChargeTransferData - `amount` integer, nullable — The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. - `destination` union, required — ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request. - … - `transfer_group` string, nullable — A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. - ConnectCollectionTransfer - `amount` integer, required — Amount transferred, in cents (or local equivalent). - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `destination` union, required — ID of the account that funds are being collected for. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), 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](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `object` 'connect_collection_transfer', required — String representing the object's type. Objects of the same type share the same value. - CustomerCashBalanceTransaction — Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer. - `adjusted_for_overdraft` CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft - `balance_transaction` union, required — The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance. - … - `linked_transaction` union, required — The [Cash Balance Transaction](https://docs.stripe.com/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds. - … - `applied_to_payment` CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction - `payment_intent` union, required — The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were applied to. - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `customer` union, required — The customer whose available cash balance changed as a result of this transaction. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - … - `customer_account` string, nullable — The ID of an Account representing a customer whose available cash balance changed as a result of this transaction. - `ending_balance` integer, required — The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). - `funded` CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction - `bank_transfer` CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransfer, required - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `net_amount` integer, required — The amount by which the cash balance changed, represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance. - `object` 'customer_cash_balance_transaction', required — String representing the object's type. Objects of the same type share the same value. - `refunded_from_payment` CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction - `refund` union, required — The [Refund](https://docs.stripe.com/api/refunds/object) that moved these funds into the customer's cash balance. - … - `transferred_to_balance` CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance - `balance_transaction` union, required — The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance. - … - `type` 'adjusted_for_overdraft' | 'applied_to_payment' | 'funded' | 'funding_reversed' | 'refunded_from_payment' | 'return_canceled' | 'return_initiated' | 'transferred_to_balance' | 'unapplied_from_payment', required — The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://docs.stripe.com/payments/customer-balance#types) to learn more about these types. - `unapplied_from_payment` CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction - `payment_intent` union, required — The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were unapplied from. - … - Dispute — A dispute occurs when a customer questions your charge with their card issuer. When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate. Related guide: [Disputes and fraud](https://docs.stripe.com/disputes) - `amount` integer, required — Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed). - `balance_transactions` BalanceTransaction[], required — List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute. - `charge` union, required — ID of the charge that's disputed. - string - Charge — The `Charge` object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://docs.stripe.com/connect/account-debits) may also create Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations. - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `enhanced_eligibility_types` string[], required — List of eligibility types that are included in `enhanced_evidence`. - `evidence` DisputeEvidence, required - `access_activity_log` string, nullable — Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. - `billing_address` string, nullable — The billing address provided by the customer. - `cancellation_policy` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. - … - `cancellation_policy_disclosure` string, nullable — An explanation of how and when the customer was shown your refund policy prior to purchase. - `cancellation_rebuttal` string, nullable — A justification for why the customer's subscription was not canceled. - `customer_communication` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service. - … - `customer_email_address` string, nullable — The email address of the customer. - `customer_name` string, nullable — The name of the customer. - `customer_purchase_ip` string, nullable — The IP address that the customer used when making the purchase. - `customer_signature` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. - … - `duplicate_charge_documentation` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate. - … - `duplicate_charge_explanation` string, nullable — An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. - `duplicate_charge_id` string, nullable — The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. - `enhanced_evidence` DisputeEnhancedEvidence, required - … - `product_description` string, nullable — A description of the product or service that was sold. - `receipt` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge. - … - `refund_policy` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. - … - `refund_policy_disclosure` string, nullable — Documentation demonstrating that the customer was shown your refund policy prior to purchase. - `refund_refusal_explanation` string, nullable — A justification for why the customer is not entitled to a refund. - `service_date` string, nullable — The date on which the customer received or began receiving the purchased service, in a clear human-readable format. - `service_documentation` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement. - … - `shipping_address` string, nullable — The address to which a physical product was shipped. You should try to include as complete address information as possible. - `shipping_carrier` string, nullable — The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas. - `shipping_date` string, nullable — The date on which a physical product began its route to the shipping address, in a clear human-readable format. - `shipping_documentation` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible. - … - `shipping_tracking_number` string, nullable — The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. - `uncategorized_file` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. - … - `uncategorized_text` string, nullable — Any additional evidence or statements. - `evidence_details` DisputeEvidenceDetails, required - `due_by` integer, nullable — Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute. - `enhanced_eligibility` DisputeEnhancedEligibility, required - … - `has_evidence` boolean, required — Whether evidence has been staged for this dispute. - `past_due` boolean, required — Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed. - `submission_count` integer, required — The number of times evidence has been submitted. Typically, you may only submit evidence once. - `id` string, required — Unique identifier for the object. - `is_charge_refundable` boolean, required — If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'dispute', required — String representing the object's type. Objects of the same type share the same value. - `payment_intent` union — ID of the PaymentIntent that's disputed. - string - PaymentIntent — A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session. A PaymentIntent transitions through [multiple statuses](/payments/paymentintents/lifecycle) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents) - … - `payment_method_details` DisputePaymentMethodDetails - `amazon_pay` DisputePaymentMethodDetailsAmazonPay - … - `card` DisputePaymentMethodDetailsCard - … - `klarna` DisputePaymentMethodDetailsKlarna - … - `paypal` DisputePaymentMethodDetailsPaypal - … - `type` 'amazon_pay' | 'card' | 'klarna' | 'paypal', required — Payment method type. - `reason` string, required — Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://docs.stripe.com/disputes/categories). - `status` 'lost' | 'needs_response' | 'prevented' | 'under_review' | 'warning_closed' | 'warning_needs_response' | 'warning_under_review' | 'won', required — The current status of a dispute. Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`. - 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. Related guide: [Refunding application fees](https://docs.stripe.com/connect/destination-charges#refunding-app-fee) - `amount` integer, required — Amount, in cents (or local equivalent). - `balance_transaction` union — Balance transaction that describes the impact on your account balance. - string - BalanceTransaction — recursive - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `fee` union, required — ID of the application fee that was refunded. - string - ApplicationFee — recursive - `id` string, required — Unique identifier for the object. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'fee_refund', required — String representing the object's type. Objects of the same type share the same value. - IssuingAuthorization — When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization` object is created. [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the purchase to be completed successfully. Related guide: [Issued card authorizations](https://docs.stripe.com/issuing/purchases/authorizations) - `amount` integer, required — The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different. - `amount_details` IssuingAuthorizationAmountDetails - `atm_fee` integer, nullable — The fee charged by the ATM for the cash withdrawal. - `cashback_amount` integer, nullable — The amount of cash requested by the cardholder. - `approved` boolean, required — Whether the authorization has been approved. - `authorization_method` 'chip' | 'contactless' | 'keyed_in' | 'online' | 'swipe', required — How the card details were provided. - `balance_transactions` BalanceTransaction[], required — List of balance transactions associated with this authorization. - `card` IssuingCard, required — You can [create physical or virtual cards](https://docs.stripe.com/issuing) that are issued to cardholders. - `brand` string, required — The brand of the card. - `cancellation_reason` 'design_rejected' | 'fulfillment_error' | 'lost' | 'stolen', nullable — The reason why the card was canceled. - `cardholder` IssuingCardholder, required — An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://docs.stripe.com/issuing) cards. Related guide: [How to create a cardholder](https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder) - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK. - `cvc` string — The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. - `exp_month` integer, required — The expiration month of the card. - `exp_year` integer, required — The expiration year of the card. - `financial_account` string, nullable — The financial account this card is attached to. - `id` string, required — Unique identifier for the object. - `last4` string, required — The last 4 digits of the card number. - `latest_fraud_warning` IssuingCardFraudWarning - … - `lifecycle_controls` IssuingCardLifecycleControls - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `number` string — The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. - `object` 'issuing.card', required — String representing the object's type. Objects of the same type share the same value. - `personalization_design` union — The personalization design object belonging to this card. - … - `replaced_by` union — The latest card that replaces this card, if any. - … - `replacement_for` union — The card this card replaces, if any. - … - `replacement_reason` 'damaged' | 'expired' | 'fulfillment_error' | 'lost' | 'stolen', nullable — The reason why the previous card needed to be replaced. - `second_line` string, nullable — Text separate from cardholder name, printed on the card. - `shipping` IssuingCardShipping - … - `spending_controls` IssuingCardAuthorizationControls, required - … - `status` 'active' | 'canceled' | 'inactive', required — Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. - `type` 'physical' | 'virtual', required — The type of the card. - `wallets` IssuingCardWallets - … - `card_presence` 'not_present' | 'present', nullable — Whether the card was present at the point of sale for the authorization. - `cardholder` union — The cardholder to whom this authorization belongs. - string - IssuingCardholder — An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://docs.stripe.com/issuing) cards. Related guide: [How to create a cardholder](https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder) - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `fleet` IssuingAuthorizationFleetData - `cardholder_prompt_data` IssuingAuthorizationFleetCardholderPromptData - … - `purchase_type` 'fuel_and_non_fuel_purchase' | 'fuel_purchase' | 'non_fuel_purchase', nullable — The type of purchase. - `reported_breakdown` IssuingAuthorizationFleetReportedBreakdown - … - `service_type` 'full_service' | 'non_fuel_transaction' | 'self_service', nullable — The type of fuel service. - `fraud_challenges` IssuingAuthorizationFraudChallenge[], nullable — Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons. - `channel` 'sms', required — The method by which the fraud challenge was delivered to the cardholder. - `status` 'expired' | 'pending' | 'rejected' | 'undeliverable' | 'verified', required — The status of the fraud challenge. - `undeliverable_reason` 'no_phone_number' | 'unsupported_phone_number', nullable — If the challenge is not deliverable, the reason why. - `fuel` IssuingAuthorizationFuelData - `industry_product_code` string, nullable — [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. - `quantity_decimal` string, decimal, nullable — The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places. - `type` 'diesel' | 'other' | 'unleaded_plus' | 'unleaded_regular' | 'unleaded_super', nullable — The type of fuel that was purchased. - `unit` 'charging_minute' | 'imperial_gallon' | 'kilogram' | 'kilowatt_hour' | 'liter' | 'other' | 'pound' | 'us_gallon', nullable — The units for `quantity_decimal`. - `unit_cost_decimal` string, decimal, nullable — The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `merchant_amount` integer, required — The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different. - `merchant_currency` string, currency, required — The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `merchant_data` IssuingAuthorizationMerchantData, required - `category` string, required — A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values. - `category_code` string, required — The merchant category code for the seller’s business - `city` string, nullable — City where the seller is located - `country` string, nullable — Country where the seller is located - `name` string, nullable — Name of the seller - `network_id` string, required — Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. - `postal_code` string, nullable — Postal code where the seller is located - `state` string, nullable — State where the seller is located - `tax_id` string, nullable — The seller's tax identification number. Currently populated for French merchants only. - `terminal_id` string, nullable — An ID assigned by the seller to the location of the sale. - `url` string, nullable — URL provided by the merchant on a 3DS request - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `network_data` IssuingAuthorizationNetworkData - `acquiring_institution_id` string, nullable — Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`. - `system_trace_audit_number` string, nullable — The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements. - `transaction_id` string, nullable — Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions. - `object` 'issuing.authorization', required — String representing the object's type. Objects of the same type share the same value. - `pending_request` IssuingAuthorizationPendingRequest - `amount` integer, required — The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://docs.stripe.com/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). - `amount_details` IssuingAuthorizationAmountDetails - … - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `is_amount_controllable` boolean, required — If set `true`, you may provide [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. - `merchant_amount` integer, required — The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). - `merchant_currency` string, currency, required — The local currency the merchant is requesting to authorize. - `network_risk_score` integer, nullable — The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99. - `request_history` IssuingAuthorizationRequest[], required — History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined. - `amount` integer, required — The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved. - `amount_details` IssuingAuthorizationAmountDetails - … - `approved` boolean, required — Whether this request was approved. - `authorization_code` string, nullable — A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `merchant_amount` integer, required — The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). - `merchant_currency` string, required — The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `network_risk_score` integer, nullable — The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99. - `reason` 'account_disabled' | 'card_active' | 'card_canceled' | 'card_expired' | 'card_inactive' | 'cardholder_blocked' | 'cardholder_inactive' | 'cardholder_verification_required' | 'insecure_authorization_method' | 'insufficient_funds' | 'network_fallback' | 'not_allowed' | 'pin_blocked' | 'spending_controls' | 'stripe_internal_error' | 'suspected_fraud' | 'verification_failed' | 'webhook_approved' | 'webhook_declined' | 'webhook_error' | 'webhook_timeout', required — When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome. - `reason_message` string, nullable — If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field. - `requested_at` integer, nullable — Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time. - `status` 'closed' | 'expired' | 'pending' | 'reversed', required — The current status of the authorization in its lifecycle. - `token` union — [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null. - string - IssuingToken — An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://docs.stripe.com/issuing), you can [view and manage these tokens](https://docs.stripe.com/issuing/controls/token-management) through Stripe. - … - `transactions` IssuingTransaction[], required — List of [transactions](https://docs.stripe.com/api/issuing/transactions) associated with this authorization. - `amount` integer, required — The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). - `amount_details` IssuingTransactionAmountDetails - … - `authorization` union — The `Authorization` object that led to this transaction. - … - `balance_transaction` union — ID of the [balance transaction](https://docs.stripe.com/api/balance_transactions) associated with this transaction. - … - `card` union, required — The card used to make this transaction. - … - `cardholder` union — The cardholder to whom this transaction belongs. - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `dispute` union — If you've disputed the transaction, the ID of the dispute. - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `merchant_amount` integer, required — The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. - `merchant_currency` string, currency, required — The currency with which the merchant is taking payment. - `merchant_data` IssuingAuthorizationMerchantData, required - … - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `network_data` IssuingTransactionNetworkData - … - `object` 'issuing.transaction', required — String representing the object's type. Objects of the same type share the same value. - `purchase_details` IssuingTransactionPurchaseDetails - … - `token` union — [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. - … - `treasury` IssuingTransactionTreasury - … - `type` 'capture' | 'refund', required — The nature of the transaction. - `wallet` 'apple_pay' | 'google_pay' | 'samsung_pay', nullable — The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. - `treasury` IssuingAuthorizationTreasury - `received_credits` string[], required — The array of [ReceivedCredits](https://docs.stripe.com/api/treasury/received_credits) associated with this authorization - `received_debits` string[], required — The array of [ReceivedDebits](https://docs.stripe.com/api/treasury/received_debits) associated with this authorization - `transaction` string, nullable — The Treasury [Transaction](https://docs.stripe.com/api/treasury/transactions) associated with this authorization - `verification_data` IssuingAuthorizationVerificationData, required - `address_line1_check` 'match' | 'mismatch' | 'not_provided', required — Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`. - `address_postal_code_check` 'match' | 'mismatch' | 'not_provided', required — Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`. - `authentication_exemption` IssuingAuthorizationAuthenticationExemption - … - `cvc_check` 'match' | 'mismatch' | 'not_provided', required — Whether the cardholder provided a CVC and if it matched Stripe’s record. - `expiry_check` 'match' | 'mismatch' | 'not_provided', required — Whether the cardholder provided an expiry date and if it matched Stripe’s record. - `postal_code` string, nullable — The postal code submitted as part of the authorization used for postal code verification. - `three_d_secure` IssuingAuthorizationThreeDSecure - … - `verified_by_fraud_challenge` boolean, nullable — Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant. - `wallet` string, nullable — The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. - IssuingDispute — As a [card issuer](https://docs.stripe.com/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with. Related guide: [Issuing disputes](https://docs.stripe.com/issuing/purchases/disputes) - `amount` integer, required — Disputed amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). - `balance_transactions` BalanceTransaction[], nullable — List of balance transactions associated with the dispute. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — The currency the `transaction` was made in. - `evidence` IssuingDisputeEvidence, required - `canceled` IssuingDisputeCanceledEvidence - … - `duplicate` IssuingDisputeDuplicateEvidence - … - `fraudulent` IssuingDisputeFraudulentEvidence - … - `merchandise_not_as_described` IssuingDisputeMerchandiseNotAsDescribedEvidence - … - `no_valid_authorization` IssuingDisputeNoValidAuthorizationEvidence - … - `not_received` IssuingDisputeNotReceivedEvidence - … - `other` IssuingDisputeOtherEvidence - … - `reason` 'canceled' | 'duplicate' | 'fraudulent' | 'merchandise_not_as_described' | 'no_valid_authorization' | 'not_received' | 'other' | 'service_not_as_described', required — The reason for filing the dispute. Its value will match the field containing the evidence. - `service_not_as_described` IssuingDisputeServiceNotAsDescribedEvidence - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `loss_reason` 'cardholder_authentication_issuer_liability' | 'eci5_token_transaction_with_tavv' | 'excess_disputes_in_timeframe' | 'has_not_met_the_minimum_dispute_amount_requirements' | 'invalid_duplicate_dispute' | 'invalid_incorrect_amount_dispute' | 'invalid_no_authorization' | 'invalid_use_of_disputes' | 'merchandise_delivered_or_shipped' | 'merchandise_or_service_as_described' | 'not_cancelled' | 'other' | 'refund_issued' | 'submitted_beyond_allowable_time_limit' | 'transaction_3ds_required' | 'transaction_approved_after_prior_fraud_dispute' | 'transaction_authorized' | 'transaction_electronically_read' | 'transaction_qualifies_for_visa_easy_payment_service' | 'transaction_unattended' — The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'issuing.dispute', required — String representing the object's type. Objects of the same type share the same value. - `status` 'expired' | 'lost' | 'submitted' | 'unsubmitted' | 'won', required — Current status of the dispute. - `transaction` union, required — The transaction being disputed. - string - IssuingTransaction — Any use of an [issued card](https://docs.stripe.com/issuing) that results in funds entering or leaving your Stripe account, such as a completed purchase or refund, is represented by an Issuing `Transaction` object. Related guide: [Issued card transactions](https://docs.stripe.com/issuing/purchases/transactions) - … - `treasury` IssuingDisputeTreasury - `debit_reversal` string, nullable — The Treasury [DebitReversal](https://docs.stripe.com/api/treasury/debit_reversals) representing this Issuing dispute - `received_debit` string, required — The Treasury [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) that is being disputed. - IssuingTransaction — Any use of an [issued card](https://docs.stripe.com/issuing) that results in funds entering or leaving your Stripe account, such as a completed purchase or refund, is represented by an Issuing `Transaction` object. Related guide: [Issued card transactions](https://docs.stripe.com/issuing/purchases/transactions) - `amount` integer, required — The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). - `amount_details` IssuingTransactionAmountDetails - `atm_fee` integer, nullable — The fee charged by the ATM for the cash withdrawal. - `cashback_amount` integer, nullable — The amount of cash requested by the cardholder. - `authorization` union — The `Authorization` object that led to this transaction. - string - IssuingAuthorization — When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization` object is created. [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the purchase to be completed successfully. Related guide: [Issued card authorizations](https://docs.stripe.com/issuing/purchases/authorizations) - … - `balance_transaction` union — ID of the [balance transaction](https://docs.stripe.com/api/balance_transactions) associated with this transaction. - string - BalanceTransaction — recursive - `card` union, required — The card used to make this transaction. - string - IssuingCard — You can [create physical or virtual cards](https://docs.stripe.com/issuing) that are issued to cardholders. - … - `cardholder` union — The cardholder to whom this transaction belongs. - string - IssuingCardholder — An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://docs.stripe.com/issuing) cards. Related guide: [How to create a cardholder](https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder) - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `dispute` union — If you've disputed the transaction, the ID of the dispute. - string - IssuingDispute — As a [card issuer](https://docs.stripe.com/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with. Related guide: [Issuing disputes](https://docs.stripe.com/issuing/purchases/disputes) - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `merchant_amount` integer, required — The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. - `merchant_currency` string, currency, required — The currency with which the merchant is taking payment. - `merchant_data` IssuingAuthorizationMerchantData, required - `category` string, required — A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values. - `category_code` string, required — The merchant category code for the seller’s business - `city` string, nullable — City where the seller is located - `country` string, nullable — Country where the seller is located - `name` string, nullable — Name of the seller - `network_id` string, required — Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. - `postal_code` string, nullable — Postal code where the seller is located - `state` string, nullable — State where the seller is located - `tax_id` string, nullable — The seller's tax identification number. Currently populated for French merchants only. - `terminal_id` string, nullable — An ID assigned by the seller to the location of the sale. - `url` string, nullable — URL provided by the merchant on a 3DS request - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `network_data` IssuingTransactionNetworkData - `authorization_code` string, nullable — A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations. - `processing_date` string, nullable — The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network. - `transaction_id` string, nullable — Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions. - `object` 'issuing.transaction', required — String representing the object's type. Objects of the same type share the same value. - `purchase_details` IssuingTransactionPurchaseDetails - `fleet` IssuingTransactionFleetData - … - `flight` IssuingTransactionFlightData - … - `fuel` IssuingTransactionFuelData - … - `lodging` IssuingTransactionLodgingData - … - `receipt` IssuingTransactionReceiptData[], nullable — The line items in the purchase. - … - `reference` string, nullable — A merchant-specific order number. - `token` union — [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. - string - IssuingToken — An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://docs.stripe.com/issuing), you can [view and manage these tokens](https://docs.stripe.com/issuing/controls/token-management) through Stripe. - … - `treasury` IssuingTransactionTreasury - `received_credit` string, nullable — The Treasury [ReceivedCredit](https://docs.stripe.com/api/treasury/received_credits) representing this Issuing transaction if it is a refund - `received_debit` string, nullable — The Treasury [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) representing this Issuing transaction if it is a capture - `type` 'capture' | 'refund', required — The nature of the transaction. - `wallet` 'apple_pay' | 'google_pay' | 'samsung_pay', nullable — The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. - Payout — A `Payout` object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a [connected Stripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts, and list all payouts. Payouts are made on [varying schedules](/docs/connect/manage-payout-schedule), depending on your country and industry. Related guide: [Receiving payouts](https://docs.stripe.com/payouts) - `amount` integer, required — The amount (in cents (or local equivalent)) that transfers to your bank account or debit card. - `application_fee` union — The application fee (if any) for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details. - string - ApplicationFee — recursive - `application_fee_amount` integer, nullable — The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details. - `arrival_date` integer, required — Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays. - `automatic` boolean, required — Returns `true` if the payout is created by an [automated payout schedule](https://docs.stripe.com/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts). - `balance_transaction` union — ID of the balance transaction that describes the impact of this payout on your account balance. - string - BalanceTransaction — recursive - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `destination` union — ID of the bank account or card the payout is sent to. - string - BankAccount — These bank accounts are payment methods on `Customer` objects. On the other hand [External Accounts](/api#external_accounts) are transfer destinations on `Account` objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) - … - Card — You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) - … - DeletedBankAccount - … - DeletedCard - … - `failure_balance_transaction` union — If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance. - string - BalanceTransaction — recursive - `failure_code` string, nullable — Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://docs.stripe.com/api#payout_failures). - `failure_message` string, nullable — Message that provides the reason for a payout failure, if available. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `method` string, required — The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks). - `object` 'payout', required — String representing the object's type. Objects of the same type share the same value. - `original_payout` union — If the payout reverses another, this is the ID of the original payout. - string - Payout — recursive - `payout_method` string, nullable — ID of the v2 FinancialAccount the funds are sent to. - `reconciliation_status` 'completed' | 'in_progress' | 'not_applicable', required — If `completed`, you can use the [Balance Transactions API](https://docs.stripe.com/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout. - `reversed_by` union — If the payout reverses, this is the ID of the payout that reverses this payout. - string - Payout — recursive - `source_type` string, required — The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`. - `statement_descriptor` string, nullable — Extra information about a payout that displays on the user's bank statement. - `status` string, required — Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`. - `trace_id` PayoutsTraceId - `status` string, required — Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`. - `value` string, nullable — The trace ID value if `trace_id.status` is `supported`, otherwise `nil`. - `type` 'bank_account' | 'card', required — Can be `bank_account` or `card`. - Refund — Refund objects allow you to refund a previously created charge that isn't refunded yet. Funds are refunded to the credit or debit card that's initially charged. Related guide: [Refunds](https://docs.stripe.com/refunds) - `amount` integer, required — Amount, in cents (or local equivalent). - `balance_transaction` union — Balance transaction that describes the impact on your account balance. - string - BalanceTransaction — recursive - `charge` union — ID of the charge that's refunded. - string - Charge — The `Charge` object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://docs.stripe.com/connect/account-debits) may also create Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations. - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `customer` union — ID of the customer of this refund. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - … - DeletedCustomer - … - `customer_account` string, nullable — ID of the account of this refund. - `description` string — An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only). - `destination_details` RefundDestinationDetails - `affirm` DestinationDetailsUnimplemented - `afterpay_clearpay` DestinationDetailsUnimplemented - `alipay` DestinationDetailsUnimplemented - `alma` DestinationDetailsUnimplemented - `amazon_pay` DestinationDetailsUnimplemented - `au_bank_transfer` DestinationDetailsUnimplemented - `blik` RefundDestinationDetailsBlik - … - `br_bank_transfer` RefundDestinationDetailsBrBankTransfer - … - `card` RefundDestinationDetailsCard - … - `cashapp` DestinationDetailsUnimplemented - `crypto` RefundDestinationDetailsCrypto - … - `customer_cash_balance` DestinationDetailsUnimplemented - `eps` DestinationDetailsUnimplemented - `eu_bank_transfer` RefundDestinationDetailsEuBankTransfer - … - `gb_bank_transfer` RefundDestinationDetailsGbBankTransfer - … - `giropay` DestinationDetailsUnimplemented - `grabpay` DestinationDetailsUnimplemented - `jp_bank_transfer` RefundDestinationDetailsJpBankTransfer - … - `klarna` DestinationDetailsUnimplemented - `mb_way` RefundDestinationDetailsMbWay - … - `multibanco` RefundDestinationDetailsMultibanco - … - `mx_bank_transfer` RefundDestinationDetailsMxBankTransfer - … - `nz_bank_transfer` DestinationDetailsUnimplemented - `p24` RefundDestinationDetailsP24 - … - `paynow` DestinationDetailsUnimplemented - `paypal` RefundDestinationDetailsPaypal - … - `pix` DestinationDetailsUnimplemented - `revolut` DestinationDetailsUnimplemented - `scalapay` DestinationDetailsUnimplemented - `sofort` DestinationDetailsUnimplemented - `swish` RefundDestinationDetailsSwish - … - `th_bank_transfer` RefundDestinationDetailsThBankTransfer - … - `twint` DestinationDetailsUnimplemented - `type` string, required — The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction. - `us_bank_transfer` RefundDestinationDetailsUsBankTransfer - … - `wechat_pay` DestinationDetailsUnimplemented - `zip` DestinationDetailsUnimplemented - `failure_balance_transaction` union — After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. - string - BalanceTransaction — recursive - `failure_reason` string — Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`. - `id` string, required — Unique identifier for the object. - `instructions_email` string — For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `next_action` RefundNextAction - `display_details` RefundNextActionDisplayDetails - … - `type` string, required — Type of the next action to perform. - `object` 'refund', required — String representing the object's type. Objects of the same type share the same value. - `payment_intent` union — ID of the PaymentIntent that's refunded. - string - PaymentIntent — A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session. A PaymentIntent transitions through [multiple statuses](/payments/paymentintents/lifecycle) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents) - … - `payment_method` union — ID of the payment method associated with this refund. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - … - `pending_reason` 'charge_pending' | 'insufficient_funds' | 'processing' — Provides the reason for why the refund is pending. Possible values are: `processing`, `insufficient_funds`, or `charge_pending`. - `presentment_details` PaymentFlowsPaymentIntentPresentmentDetails - `presentment_amount` integer, required — Amount intended to be collected by this payment, denominated in `presentment_currency`. - `presentment_currency` string, required — Currency presented to the customer during payment. - `reason` 'duplicate' | 'expired_uncaptured_charge' | 'fraudulent' | 'requested_by_customer', nullable — Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). - `receipt_number` string, nullable — This is the transaction number that appears on email receipts sent for this refund. - `source_transfer_reversal` union — The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account. - string - TransferReversal — [Stripe Connect](https://docs.stripe.com/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. Reversing a transfer that was made for a [destination charge](/docs/connect/destination-charges) is allowed only up to the amount of the charge. It is possible to reverse a [transfer_group](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) transfer only if the destination account has enough balance to cover the reversal. Related guide: [Reverse transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#reverse-transfers) - … - `status` string, nullable — Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://docs.stripe.com/refunds#failed-refunds). - `transfer_reversal` union — This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter. - string - TransferReversal — [Stripe Connect](https://docs.stripe.com/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. Reversing a transfer that was made for a [destination charge](/docs/connect/destination-charges) is allowed only up to the amount of the charge. It is possible to reverse a [transfer_group](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) transfer only if the destination account has enough balance to cover the reversal. Related guide: [Reverse transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#reverse-transfers) - … - ReserveTransaction - `amount` integer, required - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `id` string, required — Unique identifier for the object. - `object` 'reserve_transaction', required — String representing the object's type. Objects of the same type share the same value. - TaxDeductedAtSource - `id` string, required — Unique identifier for the object. - `object` 'tax_deducted_at_source', required — String representing the object's type. Objects of the same type share the same value. - `period_end` integer, required — The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. - `period_start` integer, required — The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. - `tax_deduction_account_number` string, required — The TAN that was supplied to Stripe when TDS was assessed - 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. Related guide: [Topping up your platform account](https://docs.stripe.com/connect/top-ups) - `amount` integer, required — Amount transferred. - `balance_transaction` union — ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up. - string - BalanceTransaction — recursive - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `expected_availability_date` integer, nullable — Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up. - `failure_code` string, nullable — Error code explaining reason for top-up failure if available (see [the errors section](/api/errors) for a list of codes). - `failure_message` string, nullable — Message to user further explaining reason for top-up failure if available. - `id` string, required — Unique identifier for the object. - `initiated_by` 'stripe' | 'user', nullable — Indicates whether the top-up was initiated by Stripe or by the user. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'topup', required — String representing the object's type. Objects of the same type share the same value. - `payment_method` union — The ID of a PaymentMethod representing the payment method used for the top-up. A PaymentMethod of type `us_bank_account` can be used. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - … - `payment_method_options` TopupResourcePaymentMethodOptions - `us_bank_account` TopupResourceUsBankAccount - … - `source` Source — `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). - `ach_credit_transfer` SourceTypeAchCreditTransfer - … - `ach_debit` SourceTypeAchDebit - … - `acss_debit` SourceTypeAcssDebit - … - `alipay` SourceTypeAlipay - … - `allow_redisplay` 'always' | 'limited' | 'unspecified', nullable — This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. - `amount` integer, nullable — 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` SourceTypeAuBecsDebit - … - `bancontact` SourceTypeBancontact - … - `card` SourceTypeCard - … - `card_present` SourceTypeCardPresent - … - `client_secret` string, required — The client secret of the source. Used for client-side retrieval using a publishable key. - `code_verification` SourceCodeVerificationFlow - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, nullable — Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. - `customer` 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` SourceTypeEps - … - `flow` string, required — The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. - `giropay` SourceTypeGiropay - … - `id` string, required — Unique identifier for the object. - `ideal` SourceTypeIdeal - … - `klarna` SourceTypeKlarna - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `multibanco` SourceTypeMultibanco - … - `object` 'source', required — String representing the object's type. Objects of the same type share the same value. - `owner` SourceOwner - … - `p24` SourceTypeP24 - … - `receiver` SourceReceiverFlow - … - `redirect` SourceRedirectFlow - … - `sepa_debit` SourceTypeSepaDebit - … - `sofort` SourceTypeSofort - … - `source_order` SourceOrder - … - `statement_descriptor` string, nullable — Extra information about a source. This will appear on your customer's statement every time you charge the source. - `status` string, required — 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` SourceTypeThreeDSecure - … - `type` 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'alipay' | 'au_becs_debit' | 'bancontact' | 'card' | 'card_present' | 'eps' | 'giropay' | 'ideal' | 'klarna' | 'multibanco' | 'p24' | 'sepa_debit' | 'sofort' | 'three_d_secure' | 'wechat', required — 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](https://docs.stripe.com/sources) used. - `usage` string, nullable — 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` SourceTypeWechat - … - `statement_descriptor` string, nullable — Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter. - `status` 'canceled' | 'failed' | 'pending' | 'reversed' | 'succeeded', required — The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. - `transfer_group` string, nullable — A string that identifies this top-up as part of a group. - Transfer — A `Transfer` object is created when you move funds between Stripe accounts as part of Connect. Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a [Payout](https://api.stripe.com#payout_object) object, with corresponding payout endpoints. For more information, read about the [transfer/payout split](https://docs.stripe.com/transfer-payout-split). Related guide: [Creating separate charges and transfers](https://docs.stripe.com/connect/separate-charges-and-transfers) - `amount` integer, required — Amount in cents (or local equivalent) to be transferred. - `amount_reversed` integer, required — Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). - `balance_transaction` union — Balance transaction that describes the impact of this transfer on your account balance. - string - BalanceTransaction — recursive - `created` integer, required — Time that this record of the transfer was first created. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `destination` union — ID of the Stripe account the transfer was sent to. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), 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](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - … - `destination_payment` union — If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer. - string - Charge — The `Charge` object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://docs.stripe.com/connect/account-debits) may also create Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations. - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'transfer', required — String representing the object's type. Objects of the same type share the same value. - `reversals` object, required — A list of reversals that have been applied to the transfer. - `data` TransferReversal[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `reversed` boolean, required — Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. - `source_transaction` union — ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance. - string - Charge — The `Charge` object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://docs.stripe.com/connect/account-debits) may also create Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations. - … - `source_type` string — The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. - `transfer_group` string, nullable — A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. - TransferReversal — [Stripe Connect](https://docs.stripe.com/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. Reversing a transfer that was made for a [destination charge](/docs/connect/destination-charges) is allowed only up to the amount of the charge. It is possible to reverse a [transfer_group](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) transfer only if the destination account has enough balance to cover the reversal. Related guide: [Reverse transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#reverse-transfers) - `amount` integer, required — Amount, in cents (or local equivalent). - `balance_transaction` union — Balance transaction that describes the impact on your account balance. - string - BalanceTransaction — recursive - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `destination_payment_refund` union — Linked payment refund for the transfer reversal. - string - Refund — Refund objects allow you to refund a previously created charge that isn't refunded yet. Funds are refunded to the credit or debit card that's initially charged. Related guide: [Refunds](https://docs.stripe.com/refunds) - … - `id` string, required — Unique identifier for the object. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'transfer_reversal', required — String representing the object's type. Objects of the same type share the same value. - `source_refund` union — ID of the refund responsible for the transfer reversal. - string - Refund — Refund objects allow you to refund a previously created charge that isn't refunded yet. Funds are refunded to the credit or debit card that's initially charged. Related guide: [Refunds](https://docs.stripe.com/refunds) - … - `transfer` union, required — ID of the transfer that was reversed. - string - Transfer — A `Transfer` object is created when you move funds between Stripe accounts as part of Connect. Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a [Payout](https://api.stripe.com#payout_object) object, with corresponding payout endpoints. For more information, read about the [transfer/payout split](https://docs.stripe.com/transfer-payout-split). Related guide: [Creating separate charges and transfers](https://docs.stripe.com/connect/separate-charges-and-transfers) - … - `status` string, required — The transaction's net funds status in the Stripe balance, which are either `available` or `pending`. - `type` 'adjustment' | 'advance' | 'advance_funding' | 'anticipation_repayment' | 'application_fee' | 'application_fee_refund' | 'charge' | 'climate_order_purchase' | 'climate_order_refund' | 'connect_collection_transfer' | 'contribution' | 'fee_credit_funding' | 'inbound_transfer' | 'inbound_transfer_reversal' | 'issuing_authorization_hold' | 'issuing_authorization_release' | 'issuing_dispute' | 'issuing_transaction' | 'obligation_outbound' | 'obligation_reversal_inbound' | 'payment' | 'payment_failure_refund' | 'payment_network_reserve_hold' | 'payment_network_reserve_release' | 'payment_refund' | 'payment_reversal' | 'payment_unreconciled' | 'payout' | 'payout_cancel' | 'payout_failure' | 'payout_minimum_balance_hold' | 'payout_minimum_balance_release' | 'refund' | 'refund_failure' | 'reserve_hold' | 'reserve_release' | 'reserve_transaction' | 'reserved_funds' | 'stripe_balance_payment_debit' | 'stripe_balance_payment_debit_reversal' | 'stripe_fee' | 'stripe_fx_fee' | 'tax_fee' | 'tax_fund' | 'topup' | 'topup_reversal' | 'transfer' | 'transfer_cancel' | 'transfer_failure' | 'transfer_refund', required — Transaction type: `tax_fund`, `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `inbound_transfer`, `inbound_transfer_reversal`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, `transfer_refund`, or `fee_credit_funding`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. - `charge` union, required — ID of the charge that the application fee was taken from. - string - Charge — The `Charge` object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://docs.stripe.com/connect/account-debits) may also create Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations. - `amount` integer, required — Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). - `amount_captured` integer, required — Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made). - `amount_refunded` integer, required — Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued). - `application` union — ID of the Connect application that created the charge. - string - Application - `id` string, required — Unique identifier for the object. - `name` string, nullable — The name of the application. - `object` 'application', required — String representing the object's type. Objects of the same type share the same value. - `application_fee` union — The application fee (if any) for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details. - string - ApplicationFee — recursive - `application_fee_amount` integer, nullable — The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details. - `balance_transaction` union — ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). - string - BalanceTransaction — Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe account balance. Related guide: [Balance transaction types](https://docs.stripe.com/reports/balance-transaction-types) - `amount` integer, required — Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party. - `available_on` integer, required — The date that the transaction's net funds become available in the Stripe balance. - `balance_type` 'issuing' | 'payments' | 'refund_and_dispute_prefunding' | 'risk_reserved', required — The balance that this transaction impacts. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `exchange_rate` number, nullable — If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multiplied by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`. - `fee` integer, required — Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed. - `fee_details` Fee[], required — Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction. - `amount` integer, required — Amount of the fee, in cents. - `application` string, nullable — ID of the Connect application that earned the fee. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `type` string, required — Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee`, `tax`, or `withheld_tax`. - `id` string, required — Unique identifier for the object. - `net` integer, required — Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee` - `object` 'balance_transaction', required — String representing the object's type. Objects of the same type share the same value. - `reporting_category` string, required — Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective. - `source` union — This transaction relates to the Stripe object. - string - ApplicationFee — recursive - Charge — recursive - ConnectCollectionTransfer - … - CustomerCashBalanceTransaction — Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer. - … - Dispute — A dispute occurs when a customer questions your charge with their card issuer. When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate. Related guide: [Disputes and fraud](https://docs.stripe.com/disputes) - … - 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. Related guide: [Refunding application fees](https://docs.stripe.com/connect/destination-charges#refunding-app-fee) - … - IssuingAuthorization — When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization` object is created. [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the purchase to be completed successfully. Related guide: [Issued card authorizations](https://docs.stripe.com/issuing/purchases/authorizations) - … - IssuingDispute — As a [card issuer](https://docs.stripe.com/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with. Related guide: [Issuing disputes](https://docs.stripe.com/issuing/purchases/disputes) - … - IssuingTransaction — Any use of an [issued card](https://docs.stripe.com/issuing) that results in funds entering or leaving your Stripe account, such as a completed purchase or refund, is represented by an Issuing `Transaction` object. Related guide: [Issued card transactions](https://docs.stripe.com/issuing/purchases/transactions) - … - Payout — A `Payout` object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a [connected Stripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts, and list all payouts. Payouts are made on [varying schedules](/docs/connect/manage-payout-schedule), depending on your country and industry. Related guide: [Receiving payouts](https://docs.stripe.com/payouts) - … - Refund — Refund objects allow you to refund a previously created charge that isn't refunded yet. Funds are refunded to the credit or debit card that's initially charged. Related guide: [Refunds](https://docs.stripe.com/refunds) - … - ReserveTransaction - … - TaxDeductedAtSource - … - 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. Related guide: [Topping up your platform account](https://docs.stripe.com/connect/top-ups) - … - Transfer — A `Transfer` object is created when you move funds between Stripe accounts as part of Connect. Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a [Payout](https://api.stripe.com#payout_object) object, with corresponding payout endpoints. For more information, read about the [transfer/payout split](https://docs.stripe.com/transfer-payout-split). Related guide: [Creating separate charges and transfers](https://docs.stripe.com/connect/separate-charges-and-transfers) - … - TransferReversal — [Stripe Connect](https://docs.stripe.com/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. Reversing a transfer that was made for a [destination charge](/docs/connect/destination-charges) is allowed only up to the amount of the charge. It is possible to reverse a [transfer_group](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) transfer only if the destination account has enough balance to cover the reversal. Related guide: [Reverse transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#reverse-transfers) - … - `status` string, required — The transaction's net funds status in the Stripe balance, which are either `available` or `pending`. - `type` 'adjustment' | 'advance' | 'advance_funding' | 'anticipation_repayment' | 'application_fee' | 'application_fee_refund' | 'charge' | 'climate_order_purchase' | 'climate_order_refund' | 'connect_collection_transfer' | 'contribution' | 'fee_credit_funding' | 'inbound_transfer' | 'inbound_transfer_reversal' | 'issuing_authorization_hold' | 'issuing_authorization_release' | 'issuing_dispute' | 'issuing_transaction' | 'obligation_outbound' | 'obligation_reversal_inbound' | 'payment' | 'payment_failure_refund' | 'payment_network_reserve_hold' | 'payment_network_reserve_release' | 'payment_refund' | 'payment_reversal' | 'payment_unreconciled' | 'payout' | 'payout_cancel' | 'payout_failure' | 'payout_minimum_balance_hold' | 'payout_minimum_balance_release' | 'refund' | 'refund_failure' | 'reserve_hold' | 'reserve_release' | 'reserve_transaction' | 'reserved_funds' | 'stripe_balance_payment_debit' | 'stripe_balance_payment_debit_reversal' | 'stripe_fee' | 'stripe_fx_fee' | 'tax_fee' | 'tax_fund' | 'topup' | 'topup_reversal' | 'transfer' | 'transfer_cancel' | 'transfer_failure' | 'transfer_refund', required — Transaction type: `tax_fund`, `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `inbound_transfer`, `inbound_transfer_reversal`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, `transfer_refund`, or `fee_credit_funding`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. - `billing_details` BillingDetails, required - `address` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `email` string, nullable — Email address. - `name` string, nullable — Full name. - `phone` string, nullable — Billing phone number (including extension). - `tax_id` string, nullable — Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers. - `calculated_statement_descriptor` string, nullable — The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments. - `captured` boolean, required — If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `customer` union — ID of the customer this charge is for if one exists. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - `address` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `balance` integer — The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance). - `business_name` string — The customer's business name. - `cash_balance` CashBalance — A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account. - `available` object, nullable — A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). - `customer` string, required — The ID of the customer whose cash balance this object represents. - `customer_account` string, nullable — The ID of an Account representing a customer whose cash balance this object represents. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `object` 'cash_balance', required — String representing the object's type. Objects of the same type share the same value. - `settings` CustomerBalanceCustomerBalanceSettings, required - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, nullable — Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. - `customer_account` string, nullable — The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter. - `default_source` union — ID of the default payment source for the customer. If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead. - string - BankAccount — These bank accounts are payment methods on `Customer` objects. On the other hand [External Accounts](/api#external_accounts) are transfer destinations on `Account` objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) - … - Card — You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) - … - Source — `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). - … - `delinquent` boolean, nullable — Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`. If an invoice becomes uncollectible by [dunning](https://docs.stripe.com/billing/automatic-collection), `delinquent` doesn't reset to `false`. If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `discount` Discount — A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) - `checkout_session` string, nullable — The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode. - `customer` union — The ID of the customer associated with this discount. - … - `customer_account` string, nullable — The ID of the account representing the customer associated with this discount. - `end` integer, nullable — If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null. - `id` string, required — The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - `invoice` string, nullable — The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. - `invoice_item` string, nullable — The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. - `object` 'discount', required — String representing the object's type. Objects of the same type share the same value. - `promotion_code` union — The promotion code applied to create this discount. - … - `source` DiscountSource, required - … - `start` integer, required — Date that the coupon was applied. - `subscription` string, nullable — The subscription that this coupon is applied to, if it is applied to a particular subscription. - `subscription_item` string, nullable — The subscription item that this coupon is applied to, if it is applied to a particular subscription item. - `email` string, nullable — The customer's email address. - `id` string, required — Unique identifier for the object. - `individual_name` string — The customer's individual name. - `invoice_credit_balance` object — The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes. - `invoice_prefix` string, nullable — The prefix for the customer used to generate unique invoice numbers. - `invoice_settings` InvoiceSettingCustomerSetting - `custom_fields` InvoiceSettingCustomField[], nullable — Default custom fields to be displayed on invoices for this customer. - … - `default_payment_method` union — ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. - … - `footer` string, nullable — Default footer to be displayed on invoices for this customer. - `rendering_options` InvoiceSettingCustomerRenderingOptions - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `name` string, nullable — The customer's full name or business name. - `next_invoice_sequence` integer — The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses. - `object` 'customer', required — String representing the object's type. Objects of the same type share the same value. - `phone` string, nullable — The customer's phone number. - `preferred_locales` string[], nullable — The customer's preferred locales (languages), ordered by preference. - `shipping` Shipping - `address` Address - … - `carrier` string, nullable — The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. - `name` string — Recipient name. - `phone` string, nullable — Recipient phone (including extension). - `tracking_number` string, nullable — The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. - `sources` object — The customer's payment sources, if any. - `data` union[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `subscriptions` object — The customer's current subscriptions, if any. - `data` Subscription[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `tax` CustomerTax - `automatic_tax` 'failed' | 'not_collecting' | 'supported' | 'unrecognized_location', required — Surfaces if automatic tax computation is possible given the current customer location information. - `ip_address` string, nullable — A recent IP address of the customer used for tax reporting and tax location inference. - `location` CustomerTaxLocation - … - `provider` 'anrok' | 'avalara' | 'sphere' | 'stripe', required — The tax calculation provider used for location resolution. Defaults to `stripe` when not using a [third-party provider](/tax/third-party-apps). - `tax_exempt` 'exempt' | 'none' | 'reverse', nullable — Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**. - `tax_ids` object — The customer's tax IDs. - `data` TaxId[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `test_clock` union — ID of the test clock that this customer belongs to. - string - TestHelpersTestClock — A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time. - … - DeletedCustomer - `deleted` true, required — Always true for a deleted object - `id` string, required — Unique identifier for the object. - `object` 'customer', required — String representing the object's type. Objects of the same type share the same value. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `disputed` boolean, required — Whether the charge has been disputed. - `failure_balance_transaction` union — ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. - string - BalanceTransaction — Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe account balance. Related guide: [Balance transaction types](https://docs.stripe.com/reports/balance-transaction-types) - `amount` integer, required — Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party. - `available_on` integer, required — The date that the transaction's net funds become available in the Stripe balance. - `balance_type` 'issuing' | 'payments' | 'refund_and_dispute_prefunding' | 'risk_reserved', required — The balance that this transaction impacts. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `exchange_rate` number, nullable — If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multiplied by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`. - `fee` integer, required — Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed. - `fee_details` Fee[], required — Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction. - `amount` integer, required — Amount of the fee, in cents. - `application` string, nullable — ID of the Connect application that earned the fee. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `type` string, required — Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee`, `tax`, or `withheld_tax`. - `id` string, required — Unique identifier for the object. - `net` integer, required — Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee` - `object` 'balance_transaction', required — String representing the object's type. Objects of the same type share the same value. - `reporting_category` string, required — Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective. - `source` union — This transaction relates to the Stripe object. - string - ApplicationFee — recursive - Charge — recursive - ConnectCollectionTransfer - … - CustomerCashBalanceTransaction — Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer. - … - Dispute — A dispute occurs when a customer questions your charge with their card issuer. When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate. Related guide: [Disputes and fraud](https://docs.stripe.com/disputes) - … - 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. Related guide: [Refunding application fees](https://docs.stripe.com/connect/destination-charges#refunding-app-fee) - … - IssuingAuthorization — When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization` object is created. [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the purchase to be completed successfully. Related guide: [Issued card authorizations](https://docs.stripe.com/issuing/purchases/authorizations) - … - IssuingDispute — As a [card issuer](https://docs.stripe.com/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with. Related guide: [Issuing disputes](https://docs.stripe.com/issuing/purchases/disputes) - … - IssuingTransaction — Any use of an [issued card](https://docs.stripe.com/issuing) that results in funds entering or leaving your Stripe account, such as a completed purchase or refund, is represented by an Issuing `Transaction` object. Related guide: [Issued card transactions](https://docs.stripe.com/issuing/purchases/transactions) - … - Payout — A `Payout` object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a [connected Stripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts, and list all payouts. Payouts are made on [varying schedules](/docs/connect/manage-payout-schedule), depending on your country and industry. Related guide: [Receiving payouts](https://docs.stripe.com/payouts) - … - Refund — Refund objects allow you to refund a previously created charge that isn't refunded yet. Funds are refunded to the credit or debit card that's initially charged. Related guide: [Refunds](https://docs.stripe.com/refunds) - … - ReserveTransaction - … - TaxDeductedAtSource - … - 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. Related guide: [Topping up your platform account](https://docs.stripe.com/connect/top-ups) - … - Transfer — A `Transfer` object is created when you move funds between Stripe accounts as part of Connect. Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a [Payout](https://api.stripe.com#payout_object) object, with corresponding payout endpoints. For more information, read about the [transfer/payout split](https://docs.stripe.com/transfer-payout-split). Related guide: [Creating separate charges and transfers](https://docs.stripe.com/connect/separate-charges-and-transfers) - … - TransferReversal — [Stripe Connect](https://docs.stripe.com/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. Reversing a transfer that was made for a [destination charge](/docs/connect/destination-charges) is allowed only up to the amount of the charge. It is possible to reverse a [transfer_group](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) transfer only if the destination account has enough balance to cover the reversal. Related guide: [Reverse transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#reverse-transfers) - … - `status` string, required — The transaction's net funds status in the Stripe balance, which are either `available` or `pending`. - `type` 'adjustment' | 'advance' | 'advance_funding' | 'anticipation_repayment' | 'application_fee' | 'application_fee_refund' | 'charge' | 'climate_order_purchase' | 'climate_order_refund' | 'connect_collection_transfer' | 'contribution' | 'fee_credit_funding' | 'inbound_transfer' | 'inbound_transfer_reversal' | 'issuing_authorization_hold' | 'issuing_authorization_release' | 'issuing_dispute' | 'issuing_transaction' | 'obligation_outbound' | 'obligation_reversal_inbound' | 'payment' | 'payment_failure_refund' | 'payment_network_reserve_hold' | 'payment_network_reserve_release' | 'payment_refund' | 'payment_reversal' | 'payment_unreconciled' | 'payout' | 'payout_cancel' | 'payout_failure' | 'payout_minimum_balance_hold' | 'payout_minimum_balance_release' | 'refund' | 'refund_failure' | 'reserve_hold' | 'reserve_release' | 'reserve_transaction' | 'reserved_funds' | 'stripe_balance_payment_debit' | 'stripe_balance_payment_debit_reversal' | 'stripe_fee' | 'stripe_fx_fee' | 'tax_fee' | 'tax_fund' | 'topup' | 'topup_reversal' | 'transfer' | 'transfer_cancel' | 'transfer_failure' | 'transfer_refund', required — Transaction type: `tax_fund`, `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `inbound_transfer`, `inbound_transfer_reversal`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, `transfer_refund`, or `fee_credit_funding`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. - `failure_code` string, nullable — Error code explaining reason for charge failure if available (see [the errors section](https://docs.stripe.com/error-codes) for a list of codes). - `failure_message` string, nullable — Message to user further explaining reason for charge failure if available. - `fraud_details` ChargeFraudDetails - `stripe_report` string — Assessments from Stripe. If set, the value is `fraudulent`. - `user_report` string — Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'charge', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), 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](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - `business_profile` AccountBusinessProfile - `annual_revenue` AccountAnnualRevenue - … - `estimated_worker_count` integer, nullable — An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. - `mcc` string, nullable — [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. - `minority_owned_business_designation` string[], nullable — Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business. - `monthly_estimated_revenue` AccountMonthlyEstimatedRevenue - … - `name` string, nullable — The customer-facing business name. - `product_description` string, nullable — Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. - `support_address` Address - … - `support_email` string, nullable — A publicly available email address for sending support issues to. - `support_phone` string, nullable — A publicly available phone number to call with support issues. - `support_url` string, nullable — A publicly available website for handling support issues. - `url` string, nullable — The business's publicly available website. - `business_type` 'company' | 'government_entity' | 'individual' | 'non_profit', nullable — The business type. - `capabilities` AccountCapabilities - `acss_debit_payments` 'active' | 'inactive' | 'pending' — The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges. - `affirm_payments` 'active' | 'inactive' | 'pending' — The status of the Affirm capability of the account, or whether the account can directly process Affirm charges. - `afterpay_clearpay_payments` 'active' | 'inactive' | 'pending' — The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges. - `alma_payments` 'active' | 'inactive' | 'pending' — The status of the Alma capability of the account, or whether the account can directly process Alma payments. - `amazon_pay_payments` 'active' | 'inactive' | 'pending' — The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments. - `app_distribution` 'active' | 'inactive' | 'pending' — The status of the `app_distribution` capability of the account, or whether the platform can distribute apps to other accounts. - `au_becs_debit_payments` 'active' | 'inactive' | 'pending' — The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges. - `bacs_debit_payments` 'active' | 'inactive' | 'pending' — The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges. - `bancontact_payments` 'active' | 'inactive' | 'pending' — The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges. - `bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges. - `billie_payments` 'active' | 'inactive' | 'pending' — The status of the Billie capability of the account, or whether the account can directly process Billie payments. - `bizum_payments` 'active' | 'inactive' | 'pending' — The status of the Bizum capability of the account, or whether the account can directly process Bizum payments. - `blik_payments` 'active' | 'inactive' | 'pending' — The status of the blik payments capability of the account, or whether the account can directly process blik charges. - `boleto_payments` 'active' | 'inactive' | 'pending' — The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. - `card_issuing` 'active' | 'inactive' | 'pending' — The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards - `card_payments` 'active' | 'inactive' | 'pending' — The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. - `cartes_bancaires_payments` 'active' | 'inactive' | 'pending' — The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency. - `cashapp_payments` 'active' | 'inactive' | 'pending' — The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments. - `crypto_payments` 'active' | 'inactive' | 'pending' — The status of the Crypto capability of the account, or whether the account can directly process Crypto payments. - `eps_payments` 'active' | 'inactive' | 'pending' — The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. - `fpx_payments` 'active' | 'inactive' | 'pending' — The status of the FPX payments capability of the account, or whether the account can directly process FPX charges. - `gb_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges. - `giropay_payments` 'active' | 'inactive' | 'pending' — The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. - `grabpay_payments` 'active' | 'inactive' | 'pending' — The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. - `ideal_payments` 'active' | 'inactive' | 'pending' — The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges. - `india_international_payments` 'active' | 'inactive' | 'pending' — The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India. - `jcb_payments` 'active' | 'inactive' | 'pending' — The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency. - `jp_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges. - `kakao_pay_payments` 'active' | 'inactive' | 'pending' — The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments. - `klarna_payments` 'active' | 'inactive' | 'pending' — The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges. - `konbini_payments` 'active' | 'inactive' | 'pending' — The status of the konbini payments capability of the account, or whether the account can directly process konbini charges. - `kr_card_payments` 'active' | 'inactive' | 'pending' — The status of the KrCard capability of the account, or whether the account can directly process KrCard payments. - `legacy_payments` 'active' | 'inactive' | 'pending' — The status of the legacy payments capability of the account. - `link_payments` 'active' | 'inactive' | 'pending' — The status of the link_payments capability of the account, or whether the account can directly process Link charges. - `mb_way_payments` 'active' | 'inactive' | 'pending' — The status of the MB WAY payments capability of the account, or whether the account can directly process MB WAY charges. - `mobilepay_payments` 'active' | 'inactive' | 'pending' — The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges. - `multibanco_payments` 'active' | 'inactive' | 'pending' — The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges. - `mx_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges. - `naver_pay_payments` 'active' | 'inactive' | 'pending' — The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments. - `nz_bank_account_becs_debit_payments` 'active' | 'inactive' | 'pending' — The status of the New Zealand BECS Direct Debit payments capability of the account, or whether the account can directly process New Zealand BECS Direct Debit charges. - `oxxo_payments` 'active' | 'inactive' | 'pending' — The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. - `p24_payments` 'active' | 'inactive' | 'pending' — The status of the P24 payments capability of the account, or whether the account can directly process P24 charges. - `pay_by_bank_payments` 'active' | 'inactive' | 'pending' — The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges. - `payco_payments` 'active' | 'inactive' | 'pending' — The status of the Payco capability of the account, or whether the account can directly process Payco payments. - `paynow_payments` 'active' | 'inactive' | 'pending' — The status of the paynow payments capability of the account, or whether the account can directly process paynow charges. - `payto_payments` 'active' | 'inactive' | 'pending' — The status of the PayTo capability of the account, or whether the account can directly process PayTo charges. - `pix_payments` 'active' | 'inactive' | 'pending' — The status of the pix payments capability of the account, or whether the account can directly process pix charges. - `promptpay_payments` 'active' | 'inactive' | 'pending' — The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges. - `revolut_pay_payments` 'active' | 'inactive' | 'pending' — The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments. - `samsung_pay_payments` 'active' | 'inactive' | 'pending' — The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments. - `satispay_payments` 'active' | 'inactive' | 'pending' — The status of the Satispay capability of the account, or whether the account can directly process Satispay payments. - `scalapay_payments` 'active' | 'inactive' | 'pending' — The status of the Scalapay capability of the account, or whether the account can directly process Scalapay payments. - `sepa_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges. - `sepa_debit_payments` 'active' | 'inactive' | 'pending' — The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. - `sofort_payments` 'active' | 'inactive' | 'pending' — The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. - `sunbit_payments` 'active' | 'inactive' | 'pending' — The status of the Sunbit capability of the account, or whether the account can directly process Sunbit payments. - `swish_payments` 'active' | 'inactive' | 'pending' — The status of the Swish capability of the account, or whether the account can directly process Swish payments. - `tax_reporting_us_1099_k` 'active' | 'inactive' | 'pending' — The status of the tax reporting 1099-K (US) capability of the account. - `tax_reporting_us_1099_misc` 'active' | 'inactive' | 'pending' — The status of the tax reporting 1099-MISC (US) capability of the account. - `transfers` 'active' | 'inactive' | 'pending' — The status of the transfers capability of the account, or whether your platform can transfer funds to the account. - `treasury` 'active' | 'inactive' | 'pending' — The status of the banking capability, or whether the account can have bank accounts. - `twint_payments` 'active' | 'inactive' | 'pending' — The status of the TWINT capability of the account, or whether the account can directly process TWINT charges. - `upi_payments` 'active' | 'inactive' | 'pending' — The status of the upi payments capability of the account, or whether the account can directly process upi charges. - `us_bank_account_ach_payments` 'active' | 'inactive' | 'pending' — The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges. - `us_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges. - `zip_payments` 'active' | 'inactive' | 'pending' — The status of the Zip capability of the account, or whether the account can directly process Zip charges. - `charges_enabled` boolean — Whether the account can process charges. - `company` LegalEntityCompany - `address` Address - … - `address_kana` LegalEntityJapanAddress - … - `address_kanji` LegalEntityJapanAddress - … - `administrative_address` Address - … - `directors_provided` boolean — Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-directors_provided). - `directorship_declaration` LegalEntityDirectorshipDeclaration - … - `executives_provided` boolean — Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided. - `export_license_id` string — The export license ID number of the company, also referred as Import Export Code (India only). - `export_purpose_code` string — The purpose code to use for export transactions (India only). - `name` string, nullable — The company's legal name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `name_kana` string, nullable — The Kana variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `name_kanji` string, nullable — The Kanji variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `owners_provided` boolean — Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together). - `ownership_declaration` LegalEntityUboDeclaration - … - `ownership_exemption_reason` 'qualified_entity_exceeds_ownership_threshold' | 'qualifies_as_financial_institution' — This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details. - `phone` string, nullable — The company's phone number (used for verification). - `principal_place_of_business` Address - … - `registration_date` LegalEntityRegistrationDate - … - `representative_declaration` LegalEntityRepresentativeDeclaration - … - `structure` 'free_zone_establishment' | 'free_zone_llc' | 'government_instrumentality' | 'governmental_unit' | 'incorporated_non_profit' | 'incorporated_partnership' | 'limited_liability_partnership' | 'llc' | 'multi_member_llc' | 'private_company' | 'private_corporation' | 'private_partnership' | 'public_company' | 'public_corporation' | 'public_partnership' | 'registered_charity' | 'single_member_llc' | 'sole_establishment' | 'sole_proprietorship' | 'tax_exempt_government_instrumentality' | 'unincorporated_association' | 'unincorporated_non_profit' | 'unincorporated_partnership' — The category identifying the legal structure of the company or legal entity. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. - `tax_id_provided` boolean — Whether the company's business ID number was provided. - `tax_id_registrar` string — The jurisdiction in which the `tax_id` is registered (Germany-based companies only). - `vat_id_provided` boolean — Whether the company's business VAT number was provided. - `verification` LegalEntityCompanyVerification - … - `controller` AccountUnificationAccountController - `fees` AccountUnificationAccountControllerFees - … - `is_controller` boolean — `true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://docs.stripe.com/connect/platform-controls-for-standard-accounts). Otherwise, this field is null. - `losses` AccountUnificationAccountControllerLosses - … - `requirement_collection` 'application' | 'stripe' — A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account. - `stripe_dashboard` AccountUnificationAccountControllerStripeDashboard - … - `type` 'account' | 'application', required — The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself. - `country` string — The account's country. - `created` integer — Time at which the account was connected. Measured in seconds since the Unix epoch. - `default_currency` string — 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](https://stripe.com/docs/payouts). - `details_submitted` boolean — Whether 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](/connect/onboarding) to finish submitting account details. - `email` string, nullable — 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. - `external_accounts` object — External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true. - `data` union[], required — The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `future_requirements` AccountFutureRequirements - `alternatives` AccountRequirementsAlternative[], nullable — Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. - … - `current_deadline` integer, nullable — Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning. - `currently_due` string[], nullable — Fields that need to be resolved to keep the account enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. - `disabled_reason` 'action_required.requested_capabilities' | 'listed' | 'other' | 'platform_paused' | 'rejected.fraud' | 'rejected.incomplete_verification' | 'rejected.listed' | 'rejected.other' | 'rejected.platform_fraud' | 'rejected.platform_other' | 'rejected.platform_terms_of_service' | 'rejected.terms_of_service' | 'requirements.past_due' | 'requirements.pending_verification' | 'under_review', nullable — This is typed as an enum for consistency with `requirements.disabled_reason`. - `errors` AccountRequirementsError[], nullable — Fields that are `currently_due` and need to be collected again because validation or verification failed. - … - `eventually_due` string[], nullable — Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. - `past_due` string[], nullable — Fields that haven't been resolved by `requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`. - `pending_verification` string[], nullable — Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. - `groups` AccountGroupMembership - `payments_pricing` string, nullable — The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://docs.stripe.com/connect/platform-pricing-tools) for details. - `id` string, required — Unique identifier for the object. - `individual` Person — This 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](/api/accounts/object#account_object-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](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information). - `account` string, required — The account the person is associated with. - `additional_tos_acceptances` PersonAdditionalTosAcceptances - … - `address` Address - … - `address_kana` LegalEntityJapanAddress - … - `address_kanji` LegalEntityJapanAddress - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `dob` LegalEntityDob - … - `email` string, nullable — The person's email address. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `first_name` string, nullable — The person's first name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `first_name_kana` string, nullable — The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `first_name_kanji` string, nullable — The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `full_name_aliases` string[] — A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `future_requirements` PersonFutureRequirements - … - `gender` string, nullable — The person's gender. - `id` string, required — Unique identifier for the object. - `id_number_provided` boolean — Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`). - `id_number_secondary_provided` boolean — Whether the person's `id_number_secondary` was provided. - `last_name` string, nullable — The person's last name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `last_name_kana` string, nullable — The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `last_name_kanji` string, nullable — The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `maiden_name` string, nullable — The person's maiden name. - `metadata` object — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `nationality` string, nullable — The country where the person is a national. - `object` 'person', required — String representing the object's type. Objects of the same type share the same value. - `phone` string, nullable — The person's phone number. - `political_exposure` 'existing' | 'none' — Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. - `registered_address` Address - … - `relationship` PersonRelationship - … - `requirements` PersonRequirements - … - `ssn_last_4_provided` boolean — Whether the last four digits of the person's Social Security number have been provided (U.S. only). - `us_cfpb_data` PersonUsCfpbData - … - `verification` LegalEntityPersonVerification - … - `metadata` object — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'account', required — String representing the object's type. Objects of the same type share the same value. - `payouts_enabled` boolean — Whether the funds in this account can be paid out. - `requirements` AccountRequirements - `alternatives` AccountRequirementsAlternative[], nullable — Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. - … - `current_deadline` integer, nullable — Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected. - `currently_due` string[], nullable — Fields that need to be resolved to keep the account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account will be disabled. - `disabled_reason` 'action_required.requested_capabilities' | 'listed' | 'other' | 'platform_paused' | 'rejected.fraud' | 'rejected.incomplete_verification' | 'rejected.listed' | 'rejected.other' | 'rejected.platform_fraud' | 'rejected.platform_other' | 'rejected.platform_terms_of_service' | 'rejected.terms_of_service' | 'requirements.past_due' | 'requirements.pending_verification' | 'under_review', nullable — If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification). - `errors` AccountRequirementsError[], nullable — Fields that are `currently_due` and need to be collected again because validation or verification failed. - … - `eventually_due` string[], nullable — Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. - `past_due` string[], nullable — Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the account. - `pending_verification` string[], nullable — Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. - `settings` AccountSettings - `bacs_debit_payments` AccountBacsDebitPaymentsSettings - … - `branding` AccountBrandingSettings, required - … - `card_issuing` AccountCardIssuingSettings - … - `card_payments` AccountCardPaymentsSettings, required - … - … truncated; see the full OpenAPI document linked below ## Other responses - `default` — Error response. --- [API](https://skmtc.net/stripe/apis/stripe-api-2.md) · [All operations](https://skmtc.net/stripe/apis/stripe-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stripe/stripe-api-2/versions/3653ad45bbec/schema)