/v1/chargesThis method is no longer recommended—use the Payment Intents API
to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge
object used to request payment.
| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| amount | integer | Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (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. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). | |||||||||||||||||||||||||||||||||||||||
| application_fee | integer | ||||||||||||||||||||||||||||||||||||||||
| application_fee_amount | integer | A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the | |||||||||||||||||||||||||||||||||||||||
| capture | boolean | Whether to immediately capture the charge. Defaults to | |||||||||||||||||||||||||||||||||||||||
| card | object | string | A token, like the ones returned by Stripe.js. | |||||||||||||||||||||||||||||||||||||||
| currency | string (currency) | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |||||||||||||||||||||||||||||||||||||||
| customer | string | The ID of an existing customer that will be charged in this request. | |||||||||||||||||||||||||||||||||||||||
| description | string | An arbitrary string which you can attach to a | |||||||||||||||||||||||||||||||||||||||
| destination | object | string | ||||||||||||||||||||||||||||||||||||||||
| expand | array<string> | Specifies which fields in the response should be expanded. | |||||||||||||||||||||||||||||||||||||||
| metadata | object | string | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to | |||||||||||||||||||||||||||||||||||||||
| on_behalf_of | string | The Stripe account ID for which these funds are intended. You can specify the business of record as the connected account using the | |||||||||||||||||||||||||||||||||||||||
| radar_options | object | Options to configure Radar. See Radar Session for more information. 1 nested field
| |||||||||||||||||||||||||||||||||||||||
| receipt_email | string | The email address to which this charge's receipt will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a Customer, the email address specified here will override the customer's email address. If | |||||||||||||||||||||||||||||||||||||||
| shipping | object | Shipping information for the charge. Helps prevent fraud on charges for physical goods. 5 nested fields
| |||||||||||||||||||||||||||||||||||||||
| source | string | A payment source to be charged. This can be the ID of a card (i.e., credit or debit card), a bank account, a source, a token, or a connected account. For certain sources---namely, cards, bank accounts, and attached sources---you must also pass the ID of the associated customer. | |||||||||||||||||||||||||||||||||||||||
| statement_descriptor | string | 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.
For a card charge, this value is ignored unless you don't specify a | |||||||||||||||||||||||||||||||||||||||
| statement_descriptor_suffix | string | Provides information about a card charge. Concatenated to the account's statement descriptor prefix 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. | |||||||||||||||||||||||||||||||||||||||
| transfer_data | object | An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details. 3 nested fields
| |||||||||||||||||||||||||||||||||||||||
| transfer_group | string | A string that identifies this transaction as part of a group. For details, see Grouping transactions. |
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| amount* | integer | Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (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. 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 | 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 | Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued). | ||||||||||||||||||
| application | string | application | ID of the Connect application that created the charge. | ||||||||||||||||||
| application_fee | string | application_fee | The application fee (if any) for the charge. See the Connect documentation for details. | ||||||||||||||||||
| application_fee_amount | integer | The amount of the application fee (if any) requested for the charge. See the Connect documentation for details. | ||||||||||||||||||
| balance_transaction | string | balance_transaction | ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). | ||||||||||||||||||
| billing_details* | billing_details | 5 nested fields
| ||||||||||||||||||
| calculated_statement_descriptor | string | 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 | If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. | ||||||||||||||||||
| created* | integer (unix-time) | Time at which the object was created. Measured in seconds since the Unix epoch. | ||||||||||||||||||
| currency* | string (currency) | Three-letter ISO currency code, in lowercase. Must be a supported currency. | ||||||||||||||||||
| customer | string | customer | deleted_customer | ID of the customer this charge is for if one exists. | ||||||||||||||||||
| description | string | An arbitrary string attached to the object. Often useful for displaying to users. | ||||||||||||||||||
| disputed* | boolean | Whether the charge has been disputed. | ||||||||||||||||||
| failure_balance_transaction | string | balance_transaction | ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. | ||||||||||||||||||
| failure_code | string | Error code explaining reason for charge failure if available (see the errors section for a list of codes). | ||||||||||||||||||
| failure_message | string | Message to user further explaining reason for charge failure if available. | ||||||||||||||||||
| fraud_details | charge_fraud_details | Information on fraud assessments for the charge. | ||||||||||||||||||
| id* | string | Unique identifier for the object. | ||||||||||||||||||
| livemode* | boolean | If the object exists in live mode, the value is | ||||||||||||||||||
| metadata* | object | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. | ||||||||||||||||||
| object* | string | String representing the object's type. Objects of the same type share the same value. | ||||||||||||||||||
| on_behalf_of | string | account | The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the Connect documentation for details. | ||||||||||||||||||
| outcome | charge_outcome | Details about whether the payment was accepted, and why. See understanding declines for details. | ||||||||||||||||||
| paid* | boolean |
| ||||||||||||||||||
| payment_intent | string | payment_intent | ID of the PaymentIntent associated with this charge, if one exists. | ||||||||||||||||||
| payment_method | string | ID of the payment method used in this charge. | ||||||||||||||||||
| payment_method_details | payment_method_details | Details about the payment method at the time of the transaction. | ||||||||||||||||||
| presentment_details | payment_flows_payment_intent_presentment_details | 2 nested fields
|