--- title: "List all top-ups" method: GET path: "/v1/topups" --- # List all top-ups `GET /v1/topups` Returns a list of top-ups. ## Query parameters - `amount` union - object - `gt` integer - `gte` integer - `lt` integer - `lte` integer - integer - `created` union - object - `gt` integer - `gte` integer - `lt` integer - `lte` integer - integer - `ending_before` string - `expand` string[] - `limit` integer - `starting_after` string - `status` 'canceled' | 'failed' | 'pending' | 'succeeded' ## Response `200` Successful response. - object - `data` Topup[], required - `amount` integer, required — Amount transferred. - `balance_transaction` union — ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up. - string - BalanceTransaction — Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe account balance. Related guide: [Balance transaction types](https://docs.stripe.com/reports/balance-transaction-types) - `amount` integer, required — Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party. - `available_on` integer, required — The date that the transaction's net funds become available in the Stripe balance. - `balance_type` 'issuing' | 'payments' | 'refund_and_dispute_prefunding' | 'risk_reserved', required — The balance that this transaction impacts. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `exchange_rate` number, nullable — If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multiplied by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`. - `fee` integer, required — Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed. - `fee_details` Fee[], required — Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction. - `amount` integer, required — Amount of the fee, in cents. - `application` string, nullable — ID of the Connect application that earned the fee. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `type` string, required — Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee`, `tax`, or `withheld_tax`. - `id` string, required — Unique identifier for the object. - `net` integer, required — Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee` - `object` 'balance_transaction', required — String representing the object's type. Objects of the same type share the same value. - `reporting_category` string, required — Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective. - `source` union — This transaction relates to the Stripe object. - string - ApplicationFee - `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 — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `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. - … - 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 — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'charge', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. - … - `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. - 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. - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `object` 'connect_collection_transfer', required — String representing the object's type. Objects of the same type share the same value. - CustomerCashBalanceTransaction — Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer. - `adjusted_for_overdraft` CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft - … - `applied_to_payment` CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction - … - `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. - … - `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 - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `net_amount` integer, required — The amount by which the cash balance changed, represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance. - `object` 'customer_cash_balance_transaction', required — String representing the object's type. Objects of the same type share the same value. - `refunded_from_payment` CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction - … - `transferred_to_balance` CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance - … - `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 - … - Dispute — A dispute occurs when a customer questions your charge with their card issuer. When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate. Related guide: [Disputes and fraud](https://docs.stripe.com/disputes) - `amount` integer, required — Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed). - `balance_transactions` BalanceTransaction[], required — List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute. - `charge` union, required — ID of the charge that's disputed. - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `enhanced_eligibility_types` string[], required — List of eligibility types that are included in `enhanced_evidence`. - `evidence` DisputeEvidence, required - … - `evidence_details` DisputeEvidenceDetails, required - … - `id` string, required — Unique identifier for the object. - `is_charge_refundable` boolean, required — If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'dispute', required — String representing the object's type. Objects of the same type share the same value. - `payment_intent` union — ID of the PaymentIntent that's disputed. - … - `payment_method_details` DisputePaymentMethodDetails - … - `reason` string, required — Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://docs.stripe.com/disputes/categories). - `status` 'lost' | 'needs_response' | 'prevented' | 'under_review' | 'warning_closed' | 'warning_needs_response' | 'warning_under_review' | 'won', required — The current status of a dispute. Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`. - FeeRefund — `Application Fee Refund` objects allow you to refund an application fee that has previously been created but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected. Related guide: [Refunding application fees](https://docs.stripe.com/connect/destination-charges#refunding-app-fee) - `amount` integer, required — Amount, in cents (or local equivalent). - `balance_transaction` union — Balance transaction that describes the impact on your account balance. - … - `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. - 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. - … - `card_presence` 'not_present' | 'present', nullable — Whether the card was present at the point of sale for the authorization. - `cardholder` union — The cardholder to whom this authorization belongs. - … - `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 — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `merchant_amount` integer, required — The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different. - `merchant_currency` string, currency, required — The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `merchant_data` IssuingAuthorizationMerchantData, required - … - `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. - 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 — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `loss_reason` 'cardholder_authentication_issuer_liability' | 'eci5_token_transaction_with_tavv' | 'excess_disputes_in_timeframe' | 'has_not_met_the_minimum_dispute_amount_requirements' | 'invalid_duplicate_dispute' | 'invalid_incorrect_amount_dispute' | 'invalid_no_authorization' | 'invalid_use_of_disputes' | 'merchandise_delivered_or_shipped' | 'merchandise_or_service_as_described' | 'not_cancelled' | 'other' | 'refund_issued' | 'submitted_beyond_allowable_time_limit' | 'transaction_3ds_required' | 'transaction_approved_after_prior_fraud_dispute' | 'transaction_authorized' | 'transaction_electronically_read' | 'transaction_qualifies_for_visa_easy_payment_service' | 'transaction_unattended' — The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'issuing.dispute', required — String representing the object's type. Objects of the same type share the same value. - `status` 'expired' | 'lost' | 'submitted' | 'unsubmitted' | 'won', required — Current status of the dispute. - `transaction` union, required — The transaction being disputed. - … - `treasury` IssuingDisputeTreasury - … - 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 — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `merchant_amount` integer, required — The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. - `merchant_currency` string, currency, required — The currency with which the merchant is taking payment. - `merchant_data` IssuingAuthorizationMerchantData, required - … - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `network_data` IssuingTransactionNetworkData - … - `object` 'issuing.transaction', required — String representing the object's type. Objects of the same type share the same value. - `purchase_details` IssuingTransactionPurchaseDetails - … - `token` union — [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. - … - `treasury` IssuingTransactionTreasury - … - `type` 'capture' | 'refund', required — The nature of the transaction. - `wallet` 'apple_pay' | 'google_pay' | 'samsung_pay', nullable — The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. - 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. - … - `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. - … - `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. - … - `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. - … - `failure_code` string, nullable — Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://docs.stripe.com/api#payout_failures). - `failure_message` string, nullable — Message that provides the reason for a payout failure, if available. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `method` string, required — The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks). - `object` 'payout', required — String representing the object's type. Objects of the same type share the same value. - `original_payout` union — If the payout reverses another, this is the ID of the original payout. - … - `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. - … - `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 - … - `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. - … - `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). - `customer` union — ID of the customer of this refund. - … - `customer_account` string, nullable — ID of the account of this refund. - `description` string — An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only). - `destination_details` RefundDestinationDetails - … - `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. - … - `payment_method` union — ID of the payment method associated with this refund. - … - `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. - … - ReserveTransaction - `amount` integer, required - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `id` string, required — Unique identifier for the object. - `object` 'reserve_transaction', required — String representing the object's type. Objects of the same type share the same value. - TaxDeductedAtSource - `id` string, required — Unique identifier for the object. - `object` 'tax_deducted_at_source', required — String representing the object's type. Objects of the same type share the same value. - `period_end` integer, required — The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. - `period_start` integer, required — The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. - `tax_deduction_account_number` string, required — The TAN that was supplied to Stripe when TDS was assessed - Topup — recursive - 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 — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'transfer', required — String representing the object's type. Objects of the same type share the same value. - `reversals` object, required — A list of reversals that have been applied to the transfer. - … - `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. - TransferReversal — [Stripe Connect](https://docs.stripe.com/connect) platforms can reverse transfers made to a connected account, either entirely or partially, and can also specify whether to refund any related application fees. Transfer reversals add to the platform's balance and subtract from the destination account's balance. Reversing a transfer that was made for a [destination charge](/docs/connect/destination-charges) is allowed only up to the amount of the charge. It is possible to reverse a [transfer_group](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) transfer only if the destination account has enough balance to cover the reversal. Related guide: [Reverse transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#reverse-transfers) - `amount` integer, required — Amount, in cents (or local equivalent). - `balance_transaction` union — Balance transaction that describes the impact on your account balance. - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `destination_payment_refund` union — Linked payment refund for the transfer reversal. - … - `id` string, required — Unique identifier for the object. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'transfer_reversal', required — String representing the object's type. Objects of the same type share the same value. - `source_refund` union — ID of the refund responsible for the transfer reversal. - … - `transfer` union, required — ID of the transfer that was reversed. - … - `status` string, required — The transaction's net funds status in the Stripe balance, which are either `available` or `pending`. - `type` 'adjustment' | 'advance' | 'advance_funding' | 'anticipation_repayment' | 'application_fee' | 'application_fee_refund' | 'charge' | 'climate_order_purchase' | 'climate_order_refund' | 'connect_collection_transfer' | 'contribution' | 'fee_credit_funding' | 'inbound_transfer' | 'inbound_transfer_reversal' | 'issuing_authorization_hold' | 'issuing_authorization_release' | 'issuing_dispute' | 'issuing_transaction' | 'obligation_outbound' | 'obligation_reversal_inbound' | 'payment' | 'payment_failure_refund' | 'payment_network_reserve_hold' | 'payment_network_reserve_release' | 'payment_refund' | 'payment_reversal' | 'payment_unreconciled' | 'payout' | 'payout_cancel' | 'payout_failure' | 'payout_minimum_balance_hold' | 'payout_minimum_balance_release' | 'refund' | 'refund_failure' | 'reserve_hold' | 'reserve_release' | 'reserve_transaction' | 'reserved_funds' | 'stripe_balance_payment_debit' | 'stripe_balance_payment_debit_reversal' | 'stripe_fee' | 'stripe_fx_fee' | 'tax_fee' | 'tax_fund' | 'topup' | 'topup_reversal' | 'transfer' | 'transfer_cancel' | 'transfer_failure' | 'transfer_refund', required — Transaction type: `tax_fund`, `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `inbound_transfer`, `inbound_transfer_reversal`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, `transfer_refund`, or `fee_credit_funding`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `expected_availability_date` integer, nullable — Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up. - `failure_code` string, nullable — Error code explaining reason for top-up failure if available (see [the errors section](/api/errors) for a list of codes). - `failure_message` string, nullable — Message to user further explaining reason for top-up failure if available. - `id` string, required — Unique identifier for the object. - `initiated_by` 'stripe' | 'user', nullable — Indicates whether the top-up was initiated by Stripe or by the user. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'topup', required — String representing the object's type. Objects of the same type share the same value. - `payment_method` union — The ID of a PaymentMethod representing the payment method used for the top-up. A PaymentMethod of type `us_bank_account` can be used. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - `acss_debit` PaymentMethodAcssDebit - `bank_name` string, nullable — Name of the bank associated with the bank account. - `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. - `transit_number` string, nullable — Transit number of the bank account. - `affirm` PaymentMethodAffirm - `afterpay_clearpay` PaymentMethodAfterpayClearpay - `alipay` PaymentFlowsPrivatePaymentMethodsAlipay - `allow_redisplay` 'always' | 'limited' | 'unspecified' — 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”. - `alma` PaymentMethodAlma - `amazon_pay` PaymentMethodAmazonPay - `au_becs_debit` PaymentMethodAuBecsDebit - `bsb_number` string, nullable — Six-digit number identifying bank and branch associated with this bank account. - `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. - `bacs_debit` PaymentMethodBacsDebit - `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. - `sort_code` string, nullable — Sort code of the bank account. (e.g., `10-20-30`) - `bancontact` PaymentMethodBancontact - `billie` PaymentMethodBillie - `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. - `bizum` PaymentMethodBizum - `buyer_id` string, nullable — A unique identifier for the buyer as determined by the local payment processor. - `blik` PaymentMethodBlik - `buyer_id` string, nullable — A unique and immutable identifier assigned by BLIK to every buyer. - `boleto` PaymentMethodBoleto - `tax_id` string, required — Uniquely identifies the customer tax id (CNPJ or CPF) - `card` PaymentMethodCard - `brand` string, required — Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. - `checks` PaymentMethodCardChecks - `address_line1_check` string, nullable — If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. - `address_postal_code_check` string, nullable — If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. - `cvc_check` string, nullable — If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. - `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. - `display_brand` string, nullable — The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future. - `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`. - `generated_from` PaymentMethodCardGeneratedCard - `charge` string, nullable — The charge that created this object. - `payment_method_details` CardGeneratedFromPaymentMethodDetails - … - `setup_attempt` union — The ID of the SetupAttempt that generated this PaymentMethod, if any. - … - `last4` string, required — The last four digits of the card. - `networks` Networks - `available` string[], required — All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network). - `preferred` string, nullable — The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. - `regulated_status` 'regulated' | 'unregulated', nullable — Status of a card based on the card issuer. - `three_d_secure_usage` ThreeDSecureUsage - `supported` boolean, required — Whether 3D Secure is supported on this card. - `wallet` PaymentMethodCardWallet - `amex_express_checkout` PaymentMethodCardWalletAmexExpressCheckout - `apple_pay` PaymentMethodCardWalletApplePay - `dynamic_last4` string, nullable — (For tokenized numbers only.) The last four digits of the device account number. - `google_pay` PaymentMethodCardWalletGooglePay - `link` PaymentMethodCardWalletLink - `masterpass` PaymentMethodCardWalletMasterpass - … - `samsung_pay` PaymentMethodCardWalletSamsungPay - `type` 'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'link' | 'masterpass' | 'samsung_pay' | 'visa_checkout', required — The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. - `visa_checkout` PaymentMethodCardWalletVisaCheckout - … - `card_present` PaymentMethodCardPresent - `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. - `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. - `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`. - `issuer` string, nullable — The name of the card's issuing bank. - `last4` string, nullable — The last four digits of the card. - `networks` PaymentMethodCardPresentNetworks - `available` string[], required — All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network). - `preferred` string, nullable — The preferred network for the card. - `offline` PaymentMethodDetailsCardPresentOffline - `stored_at` integer, nullable — Time at which the payment was collected while offline - `type` 'deferred', nullable — The method used to process this payment method offline. Only deferred is allowed. - `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. - `wallet` PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet - `type` 'apple_pay' | 'google_pay' | 'samsung_pay' | 'unknown', required — The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`. - `cashapp` PaymentMethodCashapp - `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. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `crypto` PaymentMethodCrypto - `custom` PaymentMethodCustom - `display_name` string, nullable — Display name of the Dashboard-only CustomPaymentMethodType. - `logo` CustomLogo - `content_type` string, nullable — Content type of the Dashboard-only CustomPaymentMethodType logo. - `url` string, required — URL of the Dashboard-only CustomPaymentMethodType logo. - `type` string, required — ID of the Dashboard-only CustomPaymentMethodType. Not expandable. - `customer` union — The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. - 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 — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `name` string, nullable — The customer's full name or business name. - `next_invoice_sequence` integer — The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses. - `object` 'customer', required — String representing the object's type. Objects of the same type share the same value. - `phone` string, nullable — The customer's phone number. - `preferred_locales` string[], nullable — The customer's preferred locales (languages), ordered by preference. - `shipping` Shipping - … - `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 - `customer_balance` PaymentMethodCustomerBalance - `eps` PaymentMethodEps - `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`. - `fpx` PaymentMethodFpx - `bank` 'affin_bank' | 'agrobank' | 'alliance_bank' | 'ambank' | 'bank_islam' | 'bank_muamalat' | 'bank_of_china' | 'bank_rakyat' | 'bnp_paribas' | 'bsn' | 'cimb' | 'citibank' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | 'mbsb_bank' | 'ocbc' | 'pb_enterprise' | 'public_bank' | 'rhb' | 'standard_chartered' | 'uob', required — The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bnp_paribas`, `bank_rakyat`, `bsn`, `cimb`, `citibank`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `mbsb_bank`, `pb_enterprise`, or `bank_of_china`. - `giropay` PaymentMethodGiropay - `grabpay` PaymentMethodGrabpay - `id` string, required — Unique identifier for the object. - `ideal` PaymentMethodIdeal - `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, if provided. 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, if the bank was provided. - `interac_present` PaymentMethodInteracPresent - `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. - `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`. - `issuer` string, nullable — The name of the card's issuing bank. - `last4` string, nullable — The last four digits of the card. - `networks` PaymentMethodCardPresentNetworks - `available` string[], required — All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network). - `preferred` string, nullable — The preferred network for the card. - `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. - `kakao_pay` PaymentMethodKakaoPay - `klarna` PaymentMethodKlarna - `dob` PaymentFlowsPrivatePaymentMethodsKlarnaDob - `day` integer, nullable — The day of birth, between 1 and 31. - `month` integer, nullable — The month of birth, between 1 and 12. - `year` integer, nullable — The four-digit year of birth. - `konbini` PaymentMethodKonbini - `kr_card` PaymentMethodKrCard - `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. - `last4` string, nullable — The last four digits of the card. This may not be present for American Express cards. - `link` PaymentMethodLink - `email` string, nullable — Account owner's email address. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `mb_way` PaymentMethodMbWay - `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. - `mobilepay` PaymentMethodMobilepay - `multibanco` PaymentMethodMultibanco - `naver_pay` PaymentMethodNaverPay - `buyer_id` string, nullable — Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same. - `funding` 'card' | 'points', required — Whether to fund this transaction with Naver Pay points or a card. - `nz_bank_account` PaymentMethodNzBankAccount - `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. - `last4` string, required — Last four digits of the bank account number. - `suffix` string, nullable — The suffix of the bank account number. - `object` 'payment_method', required — String representing the object's type. Objects of the same type share the same value. - `oxxo` PaymentMethodOxxo - `p24` PaymentMethodP24 - `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, if provided. - `pay_by_bank` PaymentMethodPayByBank - `payco` PaymentMethodPayco - `paynow` PaymentMethodPaynow - `paypal` PaymentMethodPaypal - `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. - `payto` PaymentMethodPayto - `bsb_number` string, nullable — Bank-State-Branch number of the bank account. - `last4` string, nullable — Last four digits of the bank account number. - `pay_id` string, nullable — The PayID alias for the bank account. - `pix` PaymentMethodPix - `fingerprint` string, nullable — Uniquely identifies this particular Pix account. You can use this attribute to check whether two Pix accounts are the same. - `promptpay` PaymentMethodPromptpay - `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. - `revolut_pay` PaymentMethodRevolutPay - `samsung_pay` PaymentMethodSamsungPay - `satispay` PaymentMethodSatispay - `scalapay` PaymentMethodScalapay - `sepa_debit` PaymentMethodSepaDebit - `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. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `generated_from` SepaDebitGeneratedFrom - `charge` union — The ID of the Charge that generated this PaymentMethod, if any. - … - `setup_attempt` union — The ID of the SetupAttempt that generated this PaymentMethod, if any. - … - `last4` string, nullable — Last four characters of the IBAN. - `sofort` PaymentMethodSofort - `country` string, nullable — Two-letter ISO code representing the country the bank account is located in. - `sunbit` PaymentMethodSunbit - `swish` PaymentMethodSwish - `twint` PaymentMethodTwint - `type` 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sofort' | 'sunbit' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip', required — The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. - `upi` PaymentMethodUpi - `vpa` string, nullable — Customer's unique Virtual Payment Address - `us_bank_account` PaymentMethodUsBankAccount - `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 — The name of the bank. - `financial_connections_account` string, nullable — The ID of the Financial Connections Account used to create the payment method. - `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. - `networks` UsBankAccountNetworks - `preferred` string, nullable — The preferred network. - `supported` string[], required — All supported networks. - `routing_number` string, nullable — Routing number of the bank account. - `status_details` PaymentMethodUsBankAccountStatusDetails - `blocked` PaymentMethodUsBankAccountBlocked - … - `wechat_pay` PaymentMethodWechatPay - `zip` PaymentMethodZip - `payment_method_options` TopupResourcePaymentMethodOptions - `us_bank_account` TopupResourceUsBankAccount - `network` 'ach', required — The US bank transfer network used for this top-up. The default is `ach`. - `source` Source — `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). - `ach_credit_transfer` SourceTypeAchCreditTransfer - `account_number` string, nullable - `bank_name` string, nullable - `fingerprint` string, nullable - `refund_account_holder_name` string, nullable - `refund_account_holder_type` string, nullable - `refund_routing_number` string, nullable - `routing_number` string, nullable - `swift_code` string, nullable - `ach_debit` SourceTypeAchDebit - `bank_name` string, nullable - `country` string, nullable - `fingerprint` string, nullable - `last4` string, nullable - `routing_number` string, nullable - `type` string, nullable - `acss_debit` SourceTypeAcssDebit - `bank_address_city` string, nullable - `bank_address_line_1` string, nullable - `bank_address_line_2` string, nullable - `bank_address_postal_code` string, nullable - `bank_name` string, nullable - `category` string, nullable - `country` string, nullable - `fingerprint` string, nullable - `last4` string, nullable - `routing_number` string, nullable - `alipay` SourceTypeAlipay - `data_string` string, nullable - `native_url` string, nullable - `statement_descriptor` string, nullable - `allow_redisplay` 'always' | 'limited' | 'unspecified', nullable — This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. - `amount` integer, nullable — A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. - `au_becs_debit` SourceTypeAuBecsDebit - `bsb_number` string, nullable - `fingerprint` string, nullable - `last4` string, nullable - `bancontact` SourceTypeBancontact - `bank_code` string, nullable - `bank_name` string, nullable - `bic` string, nullable - `iban_last4` string, nullable - `preferred_language` string, nullable - `statement_descriptor` string, nullable - `card` SourceTypeCard - `address_line1_check` string, nullable - `address_zip_check` string, nullable - `brand` string, nullable - `country` string, nullable - `cvc_check` string, nullable - `dynamic_last4` string, nullable - `exp_month` integer, nullable - `exp_year` integer, nullable - `fingerprint` string - `funding` string, nullable - `last4` string, nullable - `name` string, nullable - `three_d_secure` string - `tokenization_method` string, nullable - `card_present` SourceTypeCardPresent - `application_cryptogram` string - `application_preferred_name` string - `authorization_code` string, nullable - `authorization_response_code` string - `brand` string, nullable - `country` string, nullable - `cvm_type` string - `data_type` string, nullable - `dedicated_file_name` string - `emv_auth_data` string - `evidence_customer_signature` string, nullable - `evidence_transaction_certificate` string, nullable - `exp_month` integer, nullable - `exp_year` integer, nullable - `fingerprint` string - `funding` string, nullable - `last4` string, nullable - `pos_device_id` string, nullable - `pos_entry_mode` string - `read_method` string, nullable - `reader` string, nullable - `terminal_verification_results` string - `transaction_status_information` string - `client_secret` string, required — The client secret of the source. Used for client-side retrieval using a publishable key. - `code_verification` SourceCodeVerificationFlow - `attempts_remaining` integer, required — The number of attempts remaining to authenticate the source object with a verification code. - `status` string, required — The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0). - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, nullable — Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. - `customer` string — The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer. - `eps` SourceTypeEps - `reference` string, nullable - `statement_descriptor` string, nullable - `flow` string, required — The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. - `giropay` SourceTypeGiropay - `bank_code` string, nullable - `bank_name` string, nullable - `bic` string, nullable - `statement_descriptor` string, nullable - `id` string, required — Unique identifier for the object. - `ideal` SourceTypeIdeal - `bank` string, nullable - `bic` string, nullable - `iban_last4` string, nullable - `statement_descriptor` string, nullable - `klarna` SourceTypeKlarna - `background_image_url` string - `client_token` string, nullable - `first_name` string - `last_name` string - `locale` string - `logo_url` string - `page_title` string - `pay_later_asset_urls_descriptive` string - `pay_later_asset_urls_standard` string - `pay_later_name` string - `pay_later_redirect_url` string - `pay_now_asset_urls_descriptive` string - `pay_now_asset_urls_standard` string - `pay_now_name` string - `pay_now_redirect_url` string - `pay_over_time_asset_urls_descriptive` string - `pay_over_time_asset_urls_standard` string - `pay_over_time_name` string - `pay_over_time_redirect_url` string - `payment_method_categories` string - `purchase_country` string - `purchase_type` string - `redirect_url` string - `shipping_delay` integer - `shipping_first_name` string - `shipping_last_name` string - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `multibanco` SourceTypeMultibanco - `entity` string, nullable - `reference` string, nullable - `refund_account_holder_address_city` string, nullable - `refund_account_holder_address_country` string, nullable - `refund_account_holder_address_line1` string, nullable - `refund_account_holder_address_line2` string, nullable - `refund_account_holder_address_postal_code` string, nullable - `refund_account_holder_address_state` string, nullable - `refund_account_holder_name` string, nullable - `refund_iban` string, nullable - `object` 'source', required — String representing the object's type. Objects of the same type share the same value. - `owner` SourceOwner - `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 — Owner's email address. - `name` string, nullable — Owner's full name. - `phone` string, nullable — Owner's phone number (including extension). - `verified_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)). - `verified_email` string, nullable — Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. - `verified_name` string, nullable — Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. - `verified_phone` string, nullable — Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. - `p24` SourceTypeP24 - `reference` string, nullable - `receiver` SourceReceiverFlow - `address` string, nullable — The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. - `amount_charged` integer, required — The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency. - `amount_received` integer, required — The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency. - `amount_returned` integer, required — The total amount that was returned to the customer. The amount returned is expressed in the source's currency. - `refund_attributes_method` string, required — Type of refund attribute method, one of `email`, `manual`, or `none`. - `refund_attributes_status` string, required — Type of refund attribute status, one of `missing`, `requested`, or `available`. - `redirect` SourceRedirectFlow - `failure_reason` string, nullable — The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`. - `return_url` string, required — The URL you provide to redirect the customer to after they authenticated their payment. - `status` string, required — The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (successful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused). - `url` string, required — The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. - `sepa_debit` SourceTypeSepaDebit - `bank_code` string, nullable - `branch_code` string, nullable - `country` string, nullable - `fingerprint` string, nullable - `last4` string, nullable - `mandate_reference` string, nullable - `mandate_url` string, nullable - `sofort` SourceTypeSofort - `bank_code` string, nullable - `bank_name` string, nullable - `bic` string, nullable - `country` string, nullable - `iban_last4` string, nullable - `preferred_language` string, nullable - `statement_descriptor` string, nullable - `source_order` SourceOrder - `amount` integer, required — A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order. - `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). - `email` string — The email address of the customer placing the order. - `items` SourceOrderItem[], nullable — List of items constituting the order. - `amount` integer, nullable — The amount (price) for this order item. - `currency` string, nullable — This currency of this order item. Required when `amount` is present. - `description` string, nullable — Human-readable description for this order item. - `parent` string, nullable — The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). - `quantity` integer — The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. - `type` string, nullable — The type of this order item. Must be `sku`, `tax`, or `shipping`. - `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. - `statement_descriptor` string, nullable — Extra information about a source. This will appear on your customer's statement every time you charge the source. - `status` string, required — The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. - `three_d_secure` SourceTypeThreeDSecure - `address_line1_check` string, nullable - `address_zip_check` string, nullable - `authenticated` boolean, nullable - `brand` string, nullable - `card` string, nullable - `country` string, nullable - `customer` string, nullable - `cvc_check` string, nullable - `dynamic_last4` string, nullable - `exp_month` integer, nullable - `exp_year` integer, nullable - `fingerprint` string - `funding` string, nullable - `last4` string, nullable - `name` string, nullable - `three_d_secure` string - `tokenization_method` string, nullable - `type` 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'alipay' | 'au_becs_debit' | 'bancontact' | 'card' | 'card_present' | 'eps' | 'giropay' | 'ideal' | 'klarna' | 'multibanco' | 'p24' | 'sepa_debit' | 'sofort' | 'three_d_secure' | 'wechat', required — The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://docs.stripe.com/sources) used. - `usage` string, nullable — Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned. - `wechat` SourceTypeWechat - `prepay_id` string - `qr_code_url` string, nullable - `statement_descriptor` string - `statement_descriptor` string, nullable — Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter. - `status` 'canceled' | 'failed' | 'pending' | 'reversed' | 'succeeded', required — The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. - `transfer_group` string, nullable — A string that identifies this top-up as part of a group. - `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. ## Other responses - `default` — Error response. --- [API](https://skmtc.net/stripe/apis/spec3.md) · [All operations](https://skmtc.net/stripe/apis/spec3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stripe/spec3/revisions/3653ad45bbec/schema)