Capture a payment

The amount to capture, which must be less than or equal to the original amount.

An application fee to add on to this charge.

An application fee amount to add on to this charge, which must be less than or equal to the original amount.

Specifies which fields in the response should be expanded.

The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.

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.

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.

An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.

A string that identifies this transaction as part of a group. transfer_group may only be provided if it has not been set. See the Connect documentation for details.

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 in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).

Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).

ID of the Connect application that created the charge.

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

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

ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).

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.

If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.

Time at which the object was created. Measured in seconds since the Unix epoch.

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

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

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

Whether the charge has been disputed.

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

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

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

Information on fraud assessments for the charge.

Unique identifier for the object.

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

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.

String representing the object's type. Objects of the same type share the same value.

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

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

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

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

ID of the payment method used in this charge.

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