--- title: "Update a dispute" method: POST path: "/v1/disputes/{dispute}" --- # Update a dispute `POST /v1/disputes/{dispute}` When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your [dashboard](https://dashboard.stripe.com/disputes), but if you prefer, you can use the API to submit evidence programmatically. Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](/docs/disputes/categories). ## Path parameters - `dispute` string, required ## Response `200` Successful response. - 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. - `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, multipled 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` or `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 - `account` union, required — ID of the Stripe account this fee was taken from. - string - Account — This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. 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 - … - `business_type` 'company' | 'government_entity' | 'individual' | 'non_profit', nullable — The business type. - `capabilities` AccountCapabilities - … - `charges_enabled` boolean — Whether the account can process charges. - `company` LegalEntityCompany - … - `controller` AccountUnificationAccountController - … - `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. - … - `future_requirements` AccountFutureRequirements - … - `groups` AccountGroupMembership - … - `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). - … - `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 - … - `settings` AccountSettings - … - `tos_acceptance` AccountTosAcceptance - … - `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 — recursive - `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. - … - `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. - … - `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). - … - `billing_details` BillingDetails, required - … - `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. - … - `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. - … - `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 - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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. - … - `outcome` ChargeOutcome - … - `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. - … - `payment_method` string, nullable — ID of the payment method used in this charge. - `payment_method_details` PaymentMethodDetails - … - `presentment_details` PaymentFlowsPaymentIntentPresentmentDetails - … - `radar_options` RadarRadarOptions — Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. - … - `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. - … - `review` union — ID of the review associated with this charge if one exists. - … - `shipping` Shipping - … - `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. - … - `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). - … - `transfer_data` ChargeTransferData - … - `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. - `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_source` PlatformEarningFeeSource - `charge` string — Charge ID that created this application fee. - `payout` string — Payout ID that created this application fee. - `type` 'charge' | 'payout', required — Type of object that created the application fee. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `object` 'application_fee', required — String representing the object's type. Objects of the same type share the same value. - `originating_transaction` union — ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. - 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. - … - `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. - … - `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). - … - `billing_details` BillingDetails, required - … - `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. - … - `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. - … - `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 - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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. - … - `outcome` ChargeOutcome - … - `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. - … - `payment_method` string, nullable — ID of the payment method used in this charge. - `payment_method_details` PaymentMethodDetails - … - `presentment_details` PaymentFlowsPaymentIntentPresentmentDetails - … - `radar_options` RadarRadarOptions — Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. - … - `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. - … - `review` union — ID of the review associated with this charge if one exists. - … - `shipping` Shipping - … - `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. - … - `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). - … - `transfer_data` ChargeTransferData - … - `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. - `refunded` boolean, required — Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. - `refunds` object, required — A list of refunds that have been applied to the fee. - `data` FeeRefund[], required — Details about each object. - `amount` integer, required — Amount, in cents (or local equivalent). - `balance_transaction` union — Balance transaction that describes the impact on your account balance. - … - `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. - … - `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. - `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. - 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 - `account` union, required — ID of the Stripe account this fee was taken from. - … - `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. - … - `balance_transaction` union — Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). - … - `charge` union, required — ID of the charge that the application fee was taken from. - … - `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_source` PlatformEarningFeeSource - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `object` 'application_fee', required — String representing the object's type. Objects of the same type share the same value. - `originating_transaction` union — ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. - … - `refunded` boolean, required — Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. - `refunds` object, required — A list of refunds that have been applied to the fee. - … - `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 - `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 - … - `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. - … - `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. - … - `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) - … - `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 - … - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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 - … - `sources` object — The customer's payment sources, if any. - … - `subscriptions` object — The customer's current subscriptions, if any. - … - `tax` CustomerTax - … - `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. - … - `test_clock` union — ID of the test clock that this customer belongs to. - … - 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 — 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 — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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 — 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 - … - `business_type` 'company' | 'government_entity' | 'individual' | 'non_profit', nullable — The business type. - `capabilities` AccountCapabilities - … - `charges_enabled` boolean — Whether the account can process charges. - `company` LegalEntityCompany - … - `controller` AccountUnificationAccountController - … - `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. - … - `future_requirements` AccountFutureRequirements - … - `groups` AccountGroupMembership - … - `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). - … - `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 - … - `settings` AccountSettings - … - `tos_acceptance` AccountTosAcceptance - … - `type` 'custom' | 'express' | 'none' | 'standard' — The Stripe account type. Can be `standard`, `express`, `custom`, or `none`. - `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. - string - Rule - … - `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) - `amount` integer — Amount intended to be collected by this PaymentIntent. 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_capturable` integer — Amount that can be captured from this PaymentIntent. - `amount_details` union - … - `amount_received` integer — Amount that this PaymentIntent collects. - `application` union — ID of the Connect application that created the PaymentIntent. - … - `application_fee_amount` integer, nullable — The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). - `automatic_payment_methods` PaymentFlowsAutomaticPaymentMethodsPaymentIntent - … - `canceled_at` integer, nullable — Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. - `cancellation_reason` 'abandoned' | 'automatic' | 'duplicate' | 'expired' | 'failed_invoice' | 'fraudulent' | 'requested_by_customer' | 'void_invoice', nullable — Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, `automatic`, or `expired`). - `capture_method` 'automatic' | 'automatic_async' | 'manual' — Controls when the funds will be captured from the customer's account. - `client_secret` string, nullable — The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs to [accept a payment](https://docs.stripe.com/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled. - `confirmation_method` 'automatic' | 'manual' — Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency — 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 PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. - … - `customer_account` string, nullable — ID of the Account representing the customer that this PaymentIntent belongs to, if one exists. Payment methods attached to other Accounts cannot be used with this PaymentIntent. If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `excluded_payment_method_types` string[], nullable — The list of payment method types to exclude from use with this payment. - `hooks` PaymentFlowsPaymentIntentAsyncWorkflows - … - `id` string, required — Unique identifier for the object. - `last_payment_error` ApiErrors - … - `latest_charge` union — ID of the latest [Charge object](https://docs.stripe.com/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted. - … - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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. Learn more about [storing information in metadata](https://docs.stripe.com/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). - `next_action` PaymentIntentNextAction - … - `object` 'payment_intent', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — You can specify the settlement merchant as the connected account using the `on_behalf_of` attribute on the charge. See the PaymentIntents [use case for connected accounts](/payments/connected-accounts) for details. - … - `payment_details` PaymentFlowsPaymentDetails - … - `payment_method` union — ID of the payment method used in this PaymentIntent. - … - `payment_method_configuration_details` PaymentMethodConfigBizPaymentMethodConfigurationDetails - … - `payment_method_options` PaymentIntentPaymentMethodOptions - … - `payment_method_types` string[] — The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. A comprehensive list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). - `presentment_details` PaymentFlowsPaymentIntentPresentmentDetails - … - `processing` PaymentIntentProcessing - … - `receipt_email` string, nullable — Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). - `review` union — ID of the review associated with this PaymentIntent, if any. - … - `setup_future_usage` 'off_session' | 'on_session', nullable — Indicates that you intend to make future payments with this PaymentIntent's payment method. If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). - `shipping` Shipping - … - `statement_descriptor` string, nullable — Text that appears on the customer's statement as the statement descriptor for a non-card charge. 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). Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead. - `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. - `status` 'canceled' | 'processing' | 'requires_action' | 'requires_capture' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded', required — Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://docs.stripe.com/payments/intents#intent-statuses). - `transfer_data` TransferData - … - `transfer_group` string, nullable — A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers). - `payment_method` string, nullable — ID of the payment method used in this charge. - `payment_method_details` PaymentMethodDetails - `ach_credit_transfer` PaymentMethodDetailsAchCreditTransfer - `account_number` string, nullable — Account number to transfer funds to. - `bank_name` string, nullable — Name of the bank associated with the routing number. - `routing_number` string, nullable — Routing transit number for the bank account to transfer funds to. - `swift_code` string, nullable — SWIFT code of the bank associated with the routing number. - `ach_debit` PaymentMethodDetailsAchDebit - `account_holder_type` 'company' | 'individual', nullable — Type of entity that holds the account. This can be either `individual` or `company`. - `bank_name` string, nullable — Name of the bank associated with the bank account. - `country` string, nullable — Two-letter ISO code representing the country the bank account is located in. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `last4` string, nullable — Last four digits of the bank account number. - `routing_number` string, nullable — Routing transit number of the bank account. - `acss_debit` PaymentMethodDetailsAcssDebit - `bank_name` string, nullable — Name of the bank associated with the bank account. - `expected_debit_date` string — Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `institution_number` string, nullable — Institution number of the bank account - `last4` string, nullable — Last four digits of the bank account number. - `mandate` string — ID of the mandate used to make this payment. - `transit_number` string, nullable — Transit number of the bank account. - `affirm` PaymentMethodDetailsAffirm - `location` string — ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. - `reader` string — ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. - `transaction_id` string, nullable — The Affirm transaction ID associated with this payment. - `afterpay_clearpay` PaymentMethodDetailsAfterpayClearpay - `order_id` string, nullable — The Afterpay order ID associated with this payment intent. - `reference` string, nullable — Order identifier shown to the merchant in Afterpay’s online portal. - `alipay` PaymentFlowsPrivatePaymentMethodsAlipayDetails - `buyer_id` string — Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. - `fingerprint` string, nullable — Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. - `transaction_id` string, nullable — Transaction ID of this particular Alipay transaction. - `alma` PaymentMethodDetailsAlma - `installments` AlmaInstallments - … - `transaction_id` string, nullable — The Alma transaction ID associated with this payment. - `amazon_pay` PaymentMethodDetailsAmazonPay - `funding` AmazonPayUnderlyingPaymentMethodFundingDetails - … - `transaction_id` string, nullable — The Amazon Pay transaction ID associated with this payment. - `au_becs_debit` PaymentMethodDetailsAuBecsDebit - `bsb_number` string, nullable — Bank-State-Branch number of the bank account. - `expected_debit_date` string — Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `last4` string, nullable — Last four digits of the bank account number. - `mandate` string — ID of the mandate used to make this payment. - `bacs_debit` PaymentMethodDetailsBacsDebit - `expected_debit_date` string — Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `last4` string, nullable — Last four digits of the bank account number. - `mandate` string, nullable — ID of the mandate used to make this payment. - `sort_code` string, nullable — Sort code of the bank account. (e.g., `10-20-30`) - `bancontact` PaymentMethodDetailsBancontact - `bank_code` string, nullable — Bank code of bank associated with the bank account. - `bank_name` string, nullable — Name of the bank associated with the bank account. - `bic` string, nullable — Bank Identifier Code of the bank associated with the bank account. - `generated_sepa_debit` union — The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. - … - `generated_sepa_debit_mandate` union — The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. - … - `iban_last4` string, nullable — Last four characters of the IBAN. - `preferred_language` 'de' | 'en' | 'fr' | 'nl', nullable — Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` - `verified_name` string, nullable — Owner's verified full name. Values are verified or provided by Bancontact directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. - `billie` PaymentMethodDetailsBillie - `transaction_id` string, nullable — The Billie transaction ID associated with this payment. - `blik` PaymentMethodDetailsBlik - `buyer_id` string, nullable — A unique and immutable identifier assigned by BLIK to every buyer. - `boleto` PaymentMethodDetailsBoleto - `tax_id` string, required — The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) - `card` PaymentMethodDetailsCard - `amount_authorized` integer, nullable — The authorized amount. - `authorization_code` string, nullable — Authorization code on the charge. - `brand` string, nullable — Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. - `capture_before` integer — When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured. - `checks` PaymentMethodDetailsCardChecks - … - `country` string, nullable — Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. - `exp_month` integer, required — Two-digit number representing the card's expiration month. - `exp_year` integer, required — Four-digit number representing the card's expiration year. - `extended_authorization` PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization - … - `fingerprint` string, nullable — Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* - `funding` string, nullable — Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - `incremental_authorization` PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization - … - `installments` PaymentMethodDetailsCardInstallments - … - `last4` string, nullable — The last four digits of the card. - `mandate` string, nullable — ID of the mandate used to make this payment or created by it. - `multicapture` PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceMulticapture - … - `network` string, nullable — Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. - `network_token` PaymentMethodDetailsCardNetworkToken - … - `network_transaction_id` string, nullable — This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. - `overcapture` PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesOvercaptureOvercapture - … - `regulated_status` 'regulated' | 'unregulated', nullable — Status of a card based on the card issuer. - `three_d_secure` ThreeDSecureDetailsCharge - … - `wallet` PaymentMethodDetailsCardWallet - … - `card_present` PaymentMethodDetailsCardPresent - `amount_authorized` integer, nullable — The authorized amount - `brand` string, nullable — Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. - `brand_product` string, nullable — The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. - `capture_before` integer — When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured. - `cardholder_name` string, nullable — The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. - `country` string, nullable — Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. - `description` string, nullable — A high-level description of the type of cards issued in this range. - `emv_auth_data` string, nullable — Authorization response cryptogram. - `exp_month` integer, required — Two-digit number representing the card's expiration month. - `exp_year` integer, required — Four-digit number representing the card's expiration year. - `fingerprint` string, nullable — Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* - `funding` string, nullable — Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - `generated_card` string, nullable — ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. - `incremental_authorization_supported` boolean, required — Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). - `issuer` string, nullable — The name of the card's issuing bank. - `last4` string, nullable — The last four digits of the card. - `network` string, nullable — Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. - `network_transaction_id` string, nullable — This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. - `offline` PaymentMethodDetailsCardPresentOffline - … - `overcapture_supported` boolean, required — Defines whether the authorized amount can be over-captured or not - `preferred_locales` string[], nullable — The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip. - `read_method` 'contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2', nullable — How card details were read in this transaction. - `receipt` PaymentMethodDetailsCardPresentReceipt - … - `wallet` PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet - … - `cashapp` PaymentMethodDetailsCashapp - `buyer_id` string, nullable — A unique and immutable identifier assigned by Cash App to every buyer. - `cashtag` string, nullable — A public identifier for buyers using Cash App. - `transaction_id` string, nullable — A unique and immutable identifier of payments assigned by Cash App - `crypto` PaymentMethodDetailsCrypto - `buyer_address` string — The wallet address of the customer. - `network` 'base' | 'ethereum' | 'polygon' | 'solana' — The blockchain network that the transaction was sent on. - `token_currency` 'usdc' | 'usdg' | 'usdp' — The token currency that the transaction was sent with. - `transaction_hash` string — The blockchain transaction hash of the crypto payment. - `customer_balance` PaymentMethodDetailsCustomerBalance - `eps` PaymentMethodDetailsEps - `bank` 'arzte_und_apotheker_bank' | 'austrian_anadi_bank_ag' | 'bank_austria' | 'bankhaus_carl_spangler' | 'bankhaus_schelhammer_und_schattera_ag' | 'bawag_psk_ag' | 'bks_bank_ag' | 'brull_kallmus_bank_ag' | 'btv_vier_lander_bank' | 'capital_bank_grawe_gruppe_ag' | 'deutsche_bank_ag' | 'dolomitenbank' | 'easybank_ag' | 'erste_bank_und_sparkassen' | 'hypo_alpeadriabank_international_ag' | 'hypo_bank_burgenland_aktiengesellschaft' | 'hypo_noe_lb_fur_niederosterreich_u_wien' | 'hypo_oberosterreich_salzburg_steiermark' | 'hypo_tirol_bank_ag' | 'hypo_vorarlberg_bank_ag' | 'marchfelder_bank' | 'oberbank_ag' | 'raiffeisen_bankengruppe_osterreich' | 'schoellerbank_ag' | 'sparda_bank_wien' | 'volksbank_gruppe' | 'volkskreditbank_ag' | 'vr_bank_braunau', nullable — The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`. - `verified_name` string, nullable — Owner's verified full name. Values are verified or provided by EPS directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. EPS rarely provides this information so the attribute is usually empty. - `fpx` PaymentMethodDetailsFpx - `bank` 'affin_bank' | 'agrobank' | 'alliance_bank' | 'ambank' | 'bank_islam' | 'bank_muamalat' | 'bank_of_china' | 'bank_rakyat' | 'bsn' | 'cimb' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | 'ocbc' | 'pb_enterprise' | 'public_bank' | 'rhb' | 'standard_chartered' | 'uob', required — The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`. - `transaction_id` string, nullable — Unique transaction id generated by FPX for every request from the merchant - `giropay` PaymentMethodDetailsGiropay - `bank_code` string, nullable — Bank code of bank associated with the bank account. - `bank_name` string, nullable — Name of the bank associated with the bank account. - `bic` string, nullable — Bank Identifier Code of the bank associated with the bank account. - `verified_name` string, nullable — Owner's verified full name. Values are verified or provided by Giropay directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Giropay rarely provides this information so the attribute is usually empty. - `grabpay` PaymentMethodDetailsGrabpay - `transaction_id` string, nullable — Unique transaction id generated by GrabPay - `ideal` PaymentMethodDetailsIdeal - `bank` 'abn_amro' | 'adyen' | 'asn_bank' | 'bunq' | 'buut' | 'finom' | 'handelsbanken' | 'ing' | 'knab' | 'mollie' | 'moneyou' | 'n26' | 'nn' | 'rabobank' | 'regiobank' | 'revolut' | 'sns_bank' | 'triodos_bank' | 'van_lanschot' | 'yoursafe', nullable — The customer's bank. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. - `bic` 'ABNANL2A' | 'ADYBNL2A' | 'ASNBNL21' | 'BITSNL2A' | 'BUNQNL2A' | 'BUUTNL2A' | 'FNOMNL22' | 'FVLBNL22' | 'HANDNL2A' | 'INGBNL2A' | 'KNABNL2H' | 'MLLENL2A' | 'MOYONL21' | 'NNBANL2G' | 'NTSBDEB1' | 'RABONL2U' | 'RBRBNL21' | 'REVOIE23' | 'REVOLT21' | 'SNSBNL2A' | 'TRIONL2U', nullable — The Bank Identifier Code of the customer's bank. - `generated_sepa_debit` union — The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. - … - `generated_sepa_debit_mandate` union — The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. - … - `iban_last4` string, nullable — Last four characters of the IBAN. - `transaction_id` string, nullable — Unique transaction ID generated by iDEAL. - `verified_name` string, nullable — Owner's verified full name. Values are verified or provided by iDEAL directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. - `interac_present` PaymentMethodDetailsInteracPresent - `brand` string, nullable — Card brand. Can be `interac`, `mastercard` or `visa`. - `cardholder_name` string, nullable — The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. - `country` string, nullable — Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. - `description` string, nullable — A high-level description of the type of cards issued in this range. - `emv_auth_data` string, nullable — Authorization response cryptogram. - `exp_month` integer, required — Two-digit number representing the card's expiration month. - `exp_year` integer, required — Four-digit number representing the card's expiration year. - `fingerprint` string, nullable — Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* - `funding` string, nullable — Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - `generated_card` string, nullable — ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. - `issuer` string, nullable — The name of the card's issuing bank. - `last4` string, nullable — The last four digits of the card. - `network` string, nullable — Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. - `network_transaction_id` string, nullable — This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. - `preferred_locales` string[], nullable — The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip. - `read_method` 'contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2', nullable — How card details were read in this transaction. - `receipt` PaymentMethodDetailsInteracPresentReceipt - … - `kakao_pay` PaymentMethodDetailsKakaoPay - `buyer_id` string, nullable — A unique identifier for the buyer as determined by the local payment processor. - `transaction_id` string, nullable — The Kakao Pay transaction ID associated with this payment. - `klarna` PaymentMethodDetailsKlarna - `payer_details` KlarnaPayerDetails - … - `payment_method_category` string, nullable — The Klarna payment method used for this transaction. Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments` - `preferred_locale` string, nullable — Preferred language of the Klarna authorization page that the customer is redirected to. Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH` - `konbini` PaymentMethodDetailsKonbini - `store` PaymentMethodDetailsKonbiniStore - … - `kr_card` PaymentMethodDetailsKrCard - `brand` 'bc' | 'citi' | 'hana' | 'hyundai' | 'jeju' | 'jeonbuk' | 'kakaobank' | 'kbank' | 'kdbbank' | 'kookmin' | 'kwangju' | 'lotte' | 'mg' | 'nh' | 'post' | 'samsung' | 'savingsbank' | 'shinhan' | 'shinhyup' | 'suhyup' | 'tossbank' | 'woori', nullable — The local credit or debit card brand. - `buyer_id` string, nullable — A unique identifier for the buyer as determined by the local payment processor. - `last4` string, nullable — The last four digits of the card. This may not be present for American Express cards. - `transaction_id` string, nullable — The Korean Card transaction ID associated with this payment. - `link` PaymentMethodDetailsLink - `country` string, nullable — Two-letter ISO code representing the funding source country beneath the Link payment. You could use this attribute to get a sense of international fees. - `mb_way` PaymentMethodDetailsMbWay - `mobilepay` PaymentMethodDetailsMobilepay - `card` InternalCard - … - `multibanco` PaymentMethodDetailsMultibanco - `entity` string, nullable — Entity number associated with this Multibanco payment. - `reference` string, nullable — Reference number associated with this Multibanco payment. - `naver_pay` PaymentMethodDetailsNaverPay - `buyer_id` string, nullable — A unique identifier for the buyer as determined by the local payment processor. - `transaction_id` string, nullable — The Naver Pay transaction ID associated with this payment. - `nz_bank_account` PaymentMethodDetailsNzBankAccount - `account_holder_name` string, nullable — The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details. - `bank_code` string, required — The numeric code for the bank account's bank. - `bank_name` string, required — The name of the bank. - `branch_code` string, required — The numeric code for the bank account's bank branch. - `expected_debit_date` string — Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. - `last4` string, required — Last four digits of the bank account number. - `suffix` string, nullable — The suffix of the bank account number. - `oxxo` PaymentMethodDetailsOxxo - `number` string, nullable — OXXO reference number - `p24` PaymentMethodDetailsP24 - `bank` 'alior_bank' | 'bank_millennium' | 'bank_nowy_bfg_sa' | 'bank_pekao_sa' | 'banki_spbdzielcze' | 'blik' | 'bnp_paribas' | 'boz' | 'citi_handlowy' | 'credit_agricole' | 'envelobank' | 'etransfer_pocztowy24' | 'getin_bank' | 'ideabank' | 'ing' | 'inteligo' | 'mbank_mtransfer' | 'nest_przelew' | 'noble_pay' | 'pbac_z_ipko' | 'plus_bank' | 'santander_przelew24' | 'tmobile_usbugi_bankowe' | 'toyota_bank' | 'velobank' | 'volkswagen_bank', nullable — The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`. - `reference` string, nullable — Unique reference for this Przelewy24 payment. - `verified_name` string, nullable — Owner's verified full name. Values are verified or provided by Przelewy24 directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Przelewy24 rarely provides this information so the attribute is usually empty. - `pay_by_bank` PaymentMethodDetailsPayByBank - `payco` PaymentMethodDetailsPayco - `buyer_id` string, nullable — A unique identifier for the buyer as determined by the local payment processor. - `transaction_id` string, nullable — The Payco transaction ID associated with this payment. - `paynow` PaymentMethodDetailsPaynow - `location` string — ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. - `reader` string — ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. - `reference` string, nullable — Reference number associated with this PayNow payment - `paypal` PaymentMethodDetailsPaypal - `country` string, nullable — Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. - `payer_email` string, nullable — Owner's email. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. - `payer_id` string, nullable — PayPal account PayerID. This identifier uniquely identifies the PayPal customer. - `payer_name` string, nullable — Owner's full name. Values provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. - `seller_protection` PaypalSellerProtection - … - `transaction_id` string, nullable — A unique ID generated by PayPal for this transaction. - `payto` PaymentMethodDetailsPayto - `bsb_number` string, nullable — Bank-State-Branch number of the bank account. - `last4` string, nullable — Last four digits of the bank account number. - `mandate` string — ID of the mandate used to make this payment. - `pay_id` string, nullable — The PayID alias for the bank account. - `pix` PaymentMethodDetailsPix - `bank_transaction_id` string, nullable — Unique transaction id generated by BCB - `promptpay` PaymentMethodDetailsPromptpay - `reference` string, nullable — Bill reference generated by PromptPay - `revolut_pay` PaymentMethodDetailsRevolutPay - `funding` RevolutPayUnderlyingPaymentMethodFundingDetails - … - `transaction_id` string, nullable — The Revolut Pay transaction ID associated with this payment. - `samsung_pay` PaymentMethodDetailsSamsungPay - `buyer_id` string, nullable — A unique identifier for the buyer as determined by the local payment processor. - `transaction_id` string, nullable — The Samsung Pay transaction ID associated with this payment. - `satispay` PaymentMethodDetailsSatispay - `transaction_id` string, nullable — The Satispay transaction ID associated with this payment. - `sepa_debit` PaymentMethodDetailsSepaDebit - `bank_code` string, nullable — Bank code of bank associated with the bank account. - `branch_code` string, nullable — Branch code of bank associated with the bank account. - `country` string, nullable — Two-letter ISO code representing the country the bank account is located in. - `expected_debit_date` string — Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `last4` string, nullable — Last four characters of the IBAN. - `mandate` string, nullable — Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://docs.stripe.com/api/mandates/retrieve). - `sofort` PaymentMethodDetailsSofort - `bank_code` string, nullable — Bank code of bank associated with the bank account. - `bank_name` string, nullable — Name of the bank associated with the bank account. - `bic` string, nullable — Bank Identifier Code of the bank associated with the bank account. - `country` string, nullable — Two-letter ISO code representing the country the bank account is located in. - `generated_sepa_debit` union — The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. - … - `generated_sepa_debit_mandate` union — The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. - … - `iban_last4` string, nullable — Last four characters of the IBAN. - `preferred_language` 'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl', nullable — Preferred language of the SOFORT authorization page that the customer is redirected to. Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl` - `verified_name` string, nullable — Owner's verified full name. Values are verified or provided by SOFORT directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. - `stripe_account` PaymentMethodDetailsStripeAccount - `swish` PaymentMethodDetailsSwish - `fingerprint` string, nullable — Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer - `payment_reference` string, nullable — Payer bank reference number for the payment - `verified_phone_last4` string, nullable — The last four digits of the Swish account phone number - `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. - `us_bank_account` PaymentMethodDetailsUsBankAccount - `account_holder_type` 'company' | 'individual', nullable — Account holder type: individual or company. - `account_type` 'checking' | 'savings', nullable — Account type: checkings or savings. Defaults to checking if omitted. - `bank_name` string, nullable — Name of the bank associated with the bank account. - `expected_debit_date` string — Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `last4` string, nullable — Last four digits of the bank account number. - `mandate` union — ID of the mandate used to make this payment. - … - `payment_reference` string, nullable — Reference number to locate ACH payments with customer's bank. - `routing_number` string, nullable — Routing number of the bank account. - `wechat` PaymentMethodDetailsWechat - `wechat_pay` PaymentMethodDetailsWechatPay - `fingerprint` string, nullable — Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. - `location` string — ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. - `reader` string — ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. - `transaction_id` string, nullable — Transaction ID of this particular WeChat Pay transaction. - `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. - `amount` integer, required — Amount, in cents (or local equivalent). - `balance_transaction` union — Balance transaction that describes the impact on your account balance. - … - `charge` union — ID of the charge that's refunded. - … - `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 — An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only). - `destination_details` RefundDestinationDetails - … - `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. - … - `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 - … - `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. - … - `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 - … - `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. - … - `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. - … - `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). - `billing_zip` string, nullable — The ZIP or postal code of the card used, if applicable. - `charge` union — The charge associated with this review. - … - `closed_reason` 'acknowledged' | 'approved' | 'canceled' | 'disputed' | 'payment_never_settled' | 'redacted' | 'refunded' | 'refunded_as_fraud', nullable — The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `id` string, required — Unique identifier for the object. - `ip_address` string, nullable — The IP address where the payment originated. - `ip_address_location` RadarReviewResourceLocation - … - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `object` 'review', required — String representing the object's type. Objects of the same type share the same value. - `open` boolean, required — If `true`, the review needs action. - `opened_reason` 'manual' | 'rule', required — The reason the review was opened. One of `rule` or `manual`. - `payment_intent` union — The PaymentIntent ID associated with this review, if one exists. - … - `reason` string, required — The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`. - `session` RadarReviewResourceSession - … - `shipping` Shipping - `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)). - `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) - `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. - … - `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. - … - `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. - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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. - … - `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. - … - `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. - `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) - `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. - … - `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. - … - `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. - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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. - … - `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. - … - `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. - `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. - string - Account — This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. 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). - … - `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 — 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 - … - `business_type` 'company' | 'government_entity' | 'individual' | 'non_profit', nullable — The business type. - `capabilities` AccountCapabilities - … - `charges_enabled` boolean — Whether the account can process charges. - `company` LegalEntityCompany - … - `controller` AccountUnificationAccountController - … - `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. - … - `future_requirements` AccountFutureRequirements - … - `groups` AccountGroupMembership - … - `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). - … - `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 - … - `settings` AccountSettings - … - `tos_acceptance` AccountTosAcceptance - … - `type` 'custom' | 'express' | 'none' | 'standard' — The Stripe account type. Can be `standard`, `express`, `custom`, or `none`. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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. - string - BalanceTransaction — recursive - `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. - string - CustomerCashBalanceTransaction — recursive - `applied_to_payment` CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction - `payment_intent` union, required — The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were applied to. - 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) - … - `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. - `address` Address - … - `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. - … - `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. - … - `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) - … - `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 - … - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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 - … - `sources` object — The customer's payment sources, if any. - … - `subscriptions` object — The customer's current subscriptions, if any. - … - `tax` CustomerTax - … - `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. - … - `test_clock` union — ID of the test clock that this customer belongs to. - … - `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 - `eu_bank_transfer` CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer - … - `gb_bank_transfer` CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer - … - `jp_bank_transfer` CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer - … - `reference` string, nullable — The user-supplied reference field on the bank transfer. - `type` 'eu_bank_transfer' | 'gb_bank_transfer' | 'jp_bank_transfer' | 'mx_bank_transfer' | 'us_bank_transfer', required — The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. - `us_bank_transfer` CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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. - 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) - … - `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. - string - BalanceTransaction — recursive - `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. - 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) - … - Dispute — recursive - 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 - `account` union, required — ID of the Stripe account this fee was taken from. - … - `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. - … - `balance_transaction` union — Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). - … - `charge` union, required — ID of the charge that the application fee was taken from. - … - `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_source` PlatformEarningFeeSource - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `object` 'application_fee', required — String representing the object's type. Objects of the same type share the same value. - `originating_transaction` union — ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. - … - `refunded` boolean, required — Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. - `refunds` object, required — A list of refunds that have been applied to the fee. - … - `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' | '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) - `billing` IssuingCardholderAddress, required - … - `company` IssuingCardholderCompany - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `email` string, nullable — The cardholder's email address. - `id` string, required — Unique identifier for the object. - `individual` IssuingCardholderIndividual - … - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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. - `name` string, required — The cardholder's name. This will be printed on cards issued to them. - `object` 'issuing.cardholder', required — String representing the object's type. Objects of the same type share the same value. - `phone_number` string, nullable — The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details. - `preferred_locales` string[], nullable — The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder. - `requirements` IssuingCardholderRequirements, required - … - `spending_controls` IssuingCardholderAuthorizationControls - … - `status` 'active' | 'blocked' | 'inactive', required — Specifies whether to permit authorizations on this cardholder's cards. - `type` 'company' | 'individual', required — One of `individual` or `company`. See [Choose a cardholder type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details. - `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 - `started_at` integer, nullable — Timestamp of the most recent fraud warning. - `type` 'card_testing_exposure' | 'fraud_dispute_filed' | 'third_party_reported' | 'user_indicated_fraud', nullable — The type of fraud warning that most recently took place on this card. This field updates with every new fraud warning, so the value changes over time. If populated, cancel and reissue the card. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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. - string - IssuingPersonalizationDesign — A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line. - … - `replaced_by` union — The latest card that replaces this card, if any. - string - IssuingCard — recursive - `replacement_for` union — The card this card replaces, if any. - string - IssuingCard — recursive - `replacement_reason` 'damaged' | 'expired' | '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 - `address` Address, required - … - `address_validation` IssuingCardShippingAddressValidation - … - `carrier` 'dhl' | 'fedex' | 'royal_mail' | 'usps', nullable — The delivery company that shipped a card. - `customs` IssuingCardShippingCustoms - … - `eta` integer, nullable — A unix timestamp representing a best estimate of when the card will be delivered. - `name` string, required — Recipient name. - `phone_number` string, nullable — The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created. - `require_signature` boolean, nullable — Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true. - `service` 'express' | 'priority' | 'standard', required — Shipment service, such as `standard` or `express`. - `status` 'canceled' | 'delivered' | 'failure' | 'pending' | 'returned' | 'shipped' | 'submitted', nullable — The delivery status of the card. - `tracking_number` string, nullable — A tracking number for a card shipment. - `tracking_url` string, nullable — A link to the shipping carrier's site where you can view detailed information about a card shipment. - `type` 'bulk' | 'individual', required — Packaging options. - `spending_controls` IssuingCardAuthorizationControls, required - `allowed_categories` string[], nullable — Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. - `allowed_merchant_countries` string[], nullable — Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. - `blocked_categories` string[], nullable — Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. - `blocked_merchant_countries` string[], nullable — Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. - `spending_limits` IssuingCardSpendingLimit[], nullable — Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). - … - `spending_limits_currency` string, currency, nullable — Currency of the amounts within `spending_limits`. Always the same as the currency of the card. - `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 - `apple_pay` IssuingCardApplePay, required - … - `google_pay` IssuingCardGooglePay, required - … - `primary_account_identifier` string, nullable — Unique identifier for a card used with digital wallets - `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) - `billing` IssuingCardholderAddress, required - … - `company` IssuingCardholderCompany - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `email` string, nullable — The cardholder's email address. - `id` string, required — Unique identifier for the object. - `individual` IssuingCardholderIndividual - … - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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. - `name` string, required — The cardholder's name. This will be printed on cards issued to them. - `object` 'issuing.cardholder', required — String representing the object's type. Objects of the same type share the same value. - `phone_number` string, nullable — The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details. - `preferred_locales` string[], nullable — The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder. - `requirements` IssuingCardholderRequirements, required - … - `spending_controls` IssuingCardholderAuthorizationControls - … - `status` 'active' | 'blocked' | 'inactive', required — Specifies whether to permit authorizations on this cardholder's cards. - `type` 'company' | 'individual', required — One of `individual` or `company`. See [Choose a cardholder type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details. - `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 - `alphanumeric_id` string, nullable — [Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID. - `driver_id` string, nullable — Driver ID. - `odometer` integer, nullable — Odometer reading. - `unspecified_id` string, nullable — An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type. - `user_id` string, nullable — User ID. - `vehicle_number` string, nullable — Vehicle number. - `purchase_type` 'fuel_and_non_fuel_purchase' | 'fuel_purchase' | 'non_fuel_purchase', nullable — The type of purchase. - `reported_breakdown` IssuingAuthorizationFleetReportedBreakdown - `fuel` IssuingAuthorizationFleetFuelPriceData - … - `non_fuel` IssuingAuthorizationFleetNonFuelPriceData - … - `tax` IssuingAuthorizationFleetTaxData - … - `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 — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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 - `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. - `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 - `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 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' | '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. - `card` union, required — Card associated with this token. - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `device_fingerprint` string, nullable — The hashed ID derived from the device ID from the card network associated with the token. - `id` string, required — Unique identifier for the object. - `last4` string — The last four digits of the token. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `network` 'mastercard' | 'visa', required — The token service provider / card network associated with the token. - `network_data` IssuingNetworkTokenNetworkData - … - `network_updated_at` integer, required — Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch. - `object` 'issuing.token', required — String representing the object's type. Objects of the same type share the same value. - `status` 'active' | 'deleted' | 'requested' | 'suspended', required — The usage state of the token. - `wallet_provider` 'apple_pay' | 'google_pay' | 'samsung_pay' — The digital wallet for this token, if one was used. - `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 - `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 — recursive - `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 — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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`. - `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 - `claimed_by` 'acquirer' | 'issuer', required — The entity that requested the exemption, either the acquiring merchant or the Issuing user. - `type` 'low_value_transaction' | 'transaction_risk_analysis' | 'unknown', required — The specific exemption claimed for this authorization. - `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 - `result` 'attempt_acknowledged' | 'authenticated' | 'failed' | 'required', required — The outcome of the 3D Secure authentication request. - `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 - `additional_documentation` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. - … - `canceled_at` integer, nullable — Date when order was canceled. - `cancellation_policy_provided` boolean, nullable — Whether the cardholder was provided with a cancellation policy. - `cancellation_reason` string, nullable — Reason for canceling the order. - `expected_at` integer, nullable — Date when the cardholder expected to receive the product. - `explanation` string, nullable — Explanation of why the cardholder is disputing this transaction. - `product_description` string, nullable — Description of the merchandise or service that was purchased. - `product_type` 'merchandise' | 'service', nullable — Whether the product was a merchandise or service. - `return_status` 'merchant_rejected' | 'successful', nullable — Result of cardholder's attempt to return the product. - `returned_at` integer, nullable — Date when the product was returned or attempted to be returned. - `duplicate` IssuingDisputeDuplicateEvidence - `additional_documentation` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. - … - `card_statement` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for. - … - `cash_receipt` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash. - … - `check_image` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product. - … - `explanation` string, nullable — Explanation of why the cardholder is disputing this transaction. - `original_transaction` string, nullable — Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one. - `fraudulent` IssuingDisputeFraudulentEvidence - `additional_documentation` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. - … - `explanation` string, nullable — Explanation of why the cardholder is disputing this transaction. - `merchandise_not_as_described` IssuingDisputeMerchandiseNotAsDescribedEvidence - `additional_documentation` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. - … - `explanation` string, nullable — Explanation of why the cardholder is disputing this transaction. - `received_at` integer, nullable — Date when the product was received. - `return_description` string, nullable — Description of the cardholder's attempt to return the product. - `return_status` 'merchant_rejected' | 'successful', nullable — Result of cardholder's attempt to return the product. - `returned_at` integer, nullable — Date when the product was returned or attempted to be returned. - `no_valid_authorization` IssuingDisputeNoValidAuthorizationEvidence - `additional_documentation` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. - … - `explanation` string, nullable — Explanation of why the cardholder is disputing this transaction. - `not_received` IssuingDisputeNotReceivedEvidence - `additional_documentation` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. - … - `expected_at` integer, nullable — Date when the cardholder expected to receive the product. - `explanation` string, nullable — Explanation of why the cardholder is disputing this transaction. - `product_description` string, nullable — Description of the merchandise or service that was purchased. - `product_type` 'merchandise' | 'service', nullable — Whether the product was a merchandise or service. - `other` IssuingDisputeOtherEvidence - `additional_documentation` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. - … - `explanation` string, nullable — Explanation of why the cardholder is disputing this transaction. - `product_description` string, nullable — Description of the merchandise or service that was purchased. - `product_type` 'merchandise' | 'service', nullable — Whether the product was a merchandise or service. - `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 - `additional_documentation` union — (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. - … - `canceled_at` integer, nullable — Date when order was canceled. - `cancellation_reason` string, nullable — Reason for canceling the order. - `explanation` string, nullable — Explanation of why the cardholder is disputing this transaction. - `received_at` integer, nullable — Date when the product was received. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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) - `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 — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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` 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) - `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 - … - `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. - … - `cardholder` union — The cardholder to whom this authorization belongs. - … - `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 - … - `fraud_challenges` IssuingAuthorizationFraudChallenge[], nullable — Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons. - … - `fuel` IssuingAuthorizationFuelData - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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 - … - `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 - … - `object` 'issuing.authorization', required — String representing the object's type. Objects of the same type share the same value. - `pending_request` IssuingAuthorizationPendingRequest - … - `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. - … - `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. - … - `transactions` IssuingTransaction[], required — List of [transactions](https://docs.stripe.com/api/issuing/transactions) associated with this authorization. - `treasury` IssuingAuthorizationTreasury - … - `verification_data` IssuingAuthorizationVerificationData, required - … - `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. - `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. - `brand` string, required — The brand of the card. - `cancellation_reason` 'design_rejected' | '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 - … - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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' | '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 - … - `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) - `billing` IssuingCardholderAddress, required - … - `company` IssuingCardholderCompany - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `email` string, nullable — The cardholder's email address. - `id` string, required — Unique identifier for the object. - `individual` IssuingCardholderIndividual - … - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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. - `name` string, required — The cardholder's name. This will be printed on cards issued to them. - `object` 'issuing.cardholder', required — String representing the object's type. Objects of the same type share the same value. - `phone_number` string, nullable — The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details. - `preferred_locales` string[], nullable — The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder. - `requirements` IssuingCardholderRequirements, required - … - `spending_controls` IssuingCardholderAuthorizationControls - … - `status` 'active' | 'blocked' | 'inactive', required — Specifies whether to permit authorizations on this cardholder's cards. - `type` 'company' | 'individual', required — One of `individual` or `company`. See [Choose a cardholder type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details. - `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) - `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 - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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. - … - `treasury` IssuingDisputeTreasury - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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 - `cardholder_prompt_data` IssuingTransactionFleetCardholderPromptData - … - `purchase_type` string, nullable — The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`. - `reported_breakdown` IssuingTransactionFleetReportedBreakdown - … - `service_type` string, nullable — The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`. - `flight` IssuingTransactionFlightData - `departure_at` integer, nullable — The time that the flight departed. - `passenger_name` string, nullable — The name of the passenger. - `refundable` boolean, nullable — Whether the ticket is refundable. - `segments` IssuingTransactionFlightDataLeg[], nullable — The legs of the trip. - … - `travel_agency` string, nullable — The travel agency that issued the ticket. - `fuel` IssuingTransactionFuelData - `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` string, required — The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. - `unit` string, required — The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`. - `unit_cost_decimal` string, decimal, required — The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. - `lodging` IssuingTransactionLodgingData - `check_in_at` integer, nullable — The time of checking into the lodging. - `nights` integer, nullable — The number of nights stayed at the lodging. - `receipt` IssuingTransactionReceiptData[], nullable — The line items in the purchase. - `description` string, nullable — The description of the item. The maximum length of this field is 26 characters. - `quantity` number, nullable — The quantity of the item. - `total` integer, nullable — The total for this line item in cents. - `unit_cost` integer, nullable — The unit cost of the item in cents. - `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. - `card` union, required — Card associated with this token. - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `device_fingerprint` string, nullable — The hashed ID derived from the device ID from the card network associated with the token. - `id` string, required — Unique identifier for the object. - `last4` string — The last four digits of the token. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `network` 'mastercard' | 'visa', required — The token service provider / card network associated with the token. - `network_data` IssuingNetworkTokenNetworkData - … - `network_updated_at` integer, required — Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch. - `object` 'issuing.token', required — String representing the object's type. Objects of the same type share the same value. - `status` 'active' | 'deleted' | 'requested' | 'suspended', required — The usage state of the token. - `wallet_provider` 'apple_pay' | 'google_pay' | 'samsung_pay' — The digital wallet for this token, if one was used. - `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 - `account` union, required — ID of the Stripe account this fee was taken from. - … - `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. - … - `balance_transaction` union — Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). - … - `charge` union, required — ID of the charge that the application fee was taken from. - … - `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_source` PlatformEarningFeeSource - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `object` 'application_fee', required — String representing the object's type. Objects of the same type share the same value. - `originating_transaction` union — ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. - … - `refunded` boolean, required — Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. - `refunds` object, required — A list of refunds that have been applied to the fee. - … - `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) - `account` union — The account this bank account belongs to. Only applicable on Accounts (not customers or recipients) This property is only available when returned as an [External Account](/api/external_account_bank_accounts/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`. - … - `account_holder_name` string, nullable — The name of the person or business that owns the bank account. - `account_holder_type` string, nullable — The type of entity that holds the account. This can be either `individual` or `company`. - `account_type` string, nullable — The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. - `available_payout_methods` string[], nullable — A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout. - `bank_name` string, nullable — Name of the bank associated with the routing number (e.g., `WELLS FARGO`). - `country` string, required — Two-letter ISO code representing the country the bank account is located in. - `currency` string, currency, required — Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. - `customer` union — The ID of the customer that the bank account is associated with. - … - `default_for_currency` boolean, nullable — Whether this bank account is the default external account for its currency. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `future_requirements` ExternalAccountRequirements - … - `id` string, required — Unique identifier for the object. - `last4` string, required — The last four digits of the bank account number. - `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` 'bank_account', required — String representing the object's type. Objects of the same type share the same value. - `requirements` ExternalAccountRequirements - … - `routing_number` string, nullable — The routing transit number for the bank account. - `status` string, required — For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, `tokenized_account_number_deactivated` or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If the status is `tokenized_account_number_deactivated`, the account utilizes a tokenized account number which has been deactivated due to expiration or revocation. This account will need to be reverified to continue using it for money movement. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated. For external accounts, possible values are `new`, `errored`, `verification_failed`, and `tokenized_account_number_deactivated`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. - 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) - `account` union - … - `address_city` string, nullable — City/District/Suburb/Town/Village. - `address_country` string, nullable — Billing address country, if provided when creating card. - `address_line1` string, nullable — Address line 1 (Street address/PO Box/Company name). - `address_line1_check` string, nullable — If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. - `address_line2` string, nullable — Address line 2 (Apartment/Suite/Unit/Building). - `address_state` string, nullable — State/County/Province/Region. - `address_zip` string, nullable — ZIP or postal code. - `address_zip_check` string, nullable — If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. - `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”. - `available_payout_methods` string[], nullable — A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. - `brand` string, required — Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. - `country` string, nullable — Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. - `currency` string, currency, nullable — Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`. - `customer` union — The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. - … - `cvc_check` string, nullable — If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge). - `default_for_currency` boolean, nullable — Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. - `dynamic_last4` string, nullable — (For tokenized numbers only.) The last four digits of the device account number. - `exp_month` integer, required — Two-digit number representing the card's expiration month. - `exp_year` integer, required — Four-digit number representing the card's expiration year. - `fingerprint` string, nullable — Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* - `funding` string, required — Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - `id` string, required — Unique identifier for the object. - `iin` string — Issuer identification number of the card. - `last4` string, required — The last four digits of the card. - `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. - `name` string, nullable — Cardholder name. - `networks` TokenCardNetworks - … - `object` 'card', required — String representing the object's type. Objects of the same type share the same value. - `regulated_status` 'regulated' | 'unregulated', nullable — Status of a card based on the card issuer. - `status` string, nullable — For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated. - `tokenization_method` string, nullable — If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null. - DeletedBankAccount - `currency` string, nullable — Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. - `deleted` true, required — Always true for a deleted object - `id` string, required — Unique identifier for the object. - `object` 'bank_account', required — String representing the object's type. Objects of the same type share the same value. - DeletedCard - `currency` string, nullable — Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. - `deleted` true, required — Always true for a deleted object - `id` string, required — Unique identifier for the object. - `object` 'card', required — String representing the object's type. Objects of the same type share the same value. - `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 — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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. - `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. - … - `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. - … - `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). - … - `billing_details` BillingDetails, required - … - `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. - … - `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. - … - `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 - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `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. - … - `outcome` ChargeOutcome - … - `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. - … - `payment_method` string, nullable — ID of the payment method used in this charge. - `payment_method_details` PaymentMethodDetails - … - `presentment_details` PaymentFlowsPaymentIntentPresentmentDetails - … - `radar_options` RadarRadarOptions — Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. - … - `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. - … - `review` union — ID of the review associated with this charge if one exists. - … - `shipping` Shipping - … - `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. - … - `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). - … - `transfer_data` ChargeTransferData - … - `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. - `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 — 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 - `network_decline_code` string, nullable — For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. - `reference` string, nullable — The reference assigned to the refund. - `reference_status` string, nullable — Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. - `br_bank_transfer` RefundDestinationDetailsBrBankTransfer - `reference` string, nullable — The reference assigned to the refund. - `reference_status` string, nullable — Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. - `card` RefundDestinationDetailsCard - `reference` string — Value of the reference number assigned to the refund. - `reference_status` string — Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`. - `reference_type` string — Type of the reference number assigned to the refund. - `type` 'pending' | 'refund' | 'reversal', required — The type of refund. This can be `refund`, `reversal`, or `pending`. - `cashapp` DestinationDetailsUnimplemented - `crypto` RefundDestinationDetailsCrypto - `reference` string, nullable — The transaction hash of the refund. - `customer_cash_balance` DestinationDetailsUnimplemented - `eps` DestinationDetailsUnimplemented - `eu_bank_transfer` RefundDestinationDetailsEuBankTransfer - `reference` string, nullable — The reference assigned to the refund. - `reference_status` string, nullable — Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. - `gb_bank_transfer` RefundDestinationDetailsGbBankTransfer - `reference` string, nullable — The reference assigned to the refund. - `reference_status` string, nullable — Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. - `giropay` DestinationDetailsUnimplemented - `grabpay` DestinationDetailsUnimplemented - `jp_bank_transfer` RefundDestinationDetailsJpBankTransfer - `reference` string, nullable — The reference assigned to the refund. - `reference_status` string, nullable — Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. - `klarna` DestinationDetailsUnimplemented - `mb_way` RefundDestinationDetailsMbWay - `reference` string, nullable — The reference assigned to the refund. - `reference_status` string, nullable — Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. - `multibanco` RefundDestinationDetailsMultibanco - `reference` string, nullable — The reference assigned to the refund. - `reference_status` string, nullable — Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. - `mx_bank_transfer` RefundDestinationDetailsMxBankTransfer - `reference` string, nullable — The reference assigned to the refund. - `reference_status` string, nullable — Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. - … truncated; see the full OpenAPI document linked below ## Other responses - `default` — Error response. --- [API](https://skmtc.net/stainless-api/apis/stripe-api.md) · [All operations](https://skmtc.net/stainless-api/apis/stripe-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stainless-api/stripe-api/versions/d7db5d2f2f83/schema)