Charges
post/v1/charges

PostCharges

This 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.

Request body

FieldTypeDescription
amountinteger

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_feeinteger
application_fee_amountinteger

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 Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.

captureboolean

Whether to immediately capture the charge. Defaults to true. When false, the charge issues an authorization (or pre-authorization), and will need to be captured later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the authorizing charges and settling later documentation.

cardobject | string

A token, like the ones returned by Stripe.js.

currencystring (currency)

Three-letter ISO currency code, in lowercase. Must be a supported currency.

customerstring

The ID of an existing customer that will be charged in this request.

descriptionstring

An arbitrary string which you can attach to a Charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the description of the charge(s) that they are describing.

destinationobject | string
expandarray<string>

Specifies which fields in the response should be expanded.

metadataobject | 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 metadata.

on_behalf_ofstring

The Stripe account ID for which these funds are intended. You can specify the business of record as the connected account using the on_behalf_of attribute on the charge. For details, see Creating Separate Charges and Transfers.

radar_optionsobject

Options to configure Radar. See Radar Session for more information.

1 nested field
FieldTypeDescription
sessionstring
receipt_emailstring

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 receipt_email is specified for a charge in live mode, a receipt will be sent regardless of your email settings.

shippingobject

Shipping information for the charge. Helps prevent fraud on charges for physical goods.

5 nested fields
FieldTypeDescription
address*object
6 nested fields
FieldTypeDescription
citystring
countrystring
line1string
line2string
postal_codestring
statestring
carrierstring
name*string
phonestring
tracking_numberstring
sourcestring

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_descriptorstring

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, in which case this value is used as the suffix.

statement_descriptor_suffixstring

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_dataobject

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
FieldTypeDescription
amountinteger
descriptionstring
destination*string
transfer_groupstring

A string that identifies this transaction as part of a group. For details, see Grouping transactions.

Response

FieldTypeDescription
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).

applicationstring | application

ID of the Connect application that created the charge.

application_feestring | application_fee

The application fee (if any) for the charge. See the Connect documentation for details.

application_fee_amountinteger

The amount of the application fee (if any) requested for the charge. See the Connect documentation for details.

balance_transactionstring | 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
FieldTypeDescription
addressaddress

Billing address.

emailstring

Email address.

namestring

Full name.

phonestring

Billing phone number (including extension).

tax_idstring

Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.

calculated_statement_descriptorstring

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.

customerstring | customer | deleted_customer

ID of the customer this charge is for if one exists.

descriptionstring

An arbitrary string attached to the object. Often useful for displaying to users.

disputed*boolean

Whether the charge has been disputed.

failure_balance_transactionstring | balance_transaction

ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.

failure_codestring

Error code explaining reason for charge failure if available (see the errors section for a list of codes).

failure_messagestring

Message to user further explaining reason for charge failure if available.

fraud_detailscharge_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 true. If the object exists in test mode, the value is false.

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_ofstring | account

The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the Connect documentation for details.

outcomecharge_outcome

Details about whether the payment was accepted, and why. See understanding declines for details.

paid*boolean

true if the charge succeeded, or was successfully authorized for later capture.

payment_intentstring | payment_intent

ID of the PaymentIntent associated with this charge, if one exists.

payment_methodstring

ID of the payment method used in this charge.

payment_method_detailspayment_method_details

Details about the payment method at the time of the transaction.

presentment_detailspayment_flows_payment_intent_presentment_details
2 nested fields
FieldTypeDescription
presentment_amount*integer

Amount intended to be collected by this payment, denominated in presentment_currency.

presentment_currency*string

Currency presented to the customer during payment.