Sign in

Capture a charge

Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

Uncaptured payments expire a set number of days after they are created (7 by default), after which they are marked as refunded and capture attempts will fail.

Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.

post/v1/charges/{charge}/capture

Path parameters

chargestring required

Response

Successful response.

amountinteger required

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_capturedinteger 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_refundedinteger 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_fee_amountinteger nullable

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

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

capturedboolean required

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

createdinteger required

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

currencystring currency required

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

descriptionstring nullable

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

disputedboolean required

Whether the charge has been disputed.

failure_codestring nullable

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

failure_messagestring nullable

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

idstring required

Unique identifier for the object.

livemodeboolean required

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

metadataobject required

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'charge' required

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

paidboolean required

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

payment_methodstring nullable

ID of the payment method used in this charge.

receipt_emailstring nullable

This is the email address that the receipt for this charge was sent to.

receipt_numberstring 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_urlstring 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.

refundedboolean required

Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.

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

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 nullable

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.

status'failed' | 'pending' | 'succeeded' required

The status of the payment is either succeeded, pending, or failed.

transfer_groupstring nullable

A string that identifies this transaction as part of a group. See the Connect documentation for details.

Changes

Changed in 16 of the 51 revisions of this API.297673

  • e24a26de41886See the full diff
    • ▲

      removed the required property application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the default status

      response-required-property-removed

    • ▲

      removed the required property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the default status

      response-required-property-removed

    • ▲

      removed the required property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the default status

      response-required-property-removed

    • ▲

      removed the required property failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

  • f83e9372025912See the full diff
    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/acss_debit/expected_debit_date to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/au_becs_debit/expected_debit_date to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/bacs_debit/expected_debit_date to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/nz_bank_account/expected_debit_date to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/sepa_debit/expected_debit_date to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/us_bank_account/expected_debit_date to the response with the default status

      response-optional-property-added

    • ○

      added the optional property payment_method_details/anyOf[subschema #1: payment_method_details]/acss_debit/expected_debit_date to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property payment_method_details/anyOf[subschema #1: payment_method_details]/au_becs_debit/expected_debit_date to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property payment_method_details/anyOf[subschema #1: payment_method_details]/bacs_debit/expected_debit_date to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property payment_method_details/anyOf[subschema #1: payment_method_details]/nz_bank_account/expected_debit_date to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property payment_method_details/anyOf[subschema #1: payment_method_details]/sepa_debit/expected_debit_date to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property payment_method_details/anyOf[subschema #1: payment_method_details]/us_bank_account/expected_debit_date to the response with the 200 status

      response-optional-property-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

  • 62e8dc4ed8691See the full diff
    • ○

      added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/card_present/anyOf[subschema #1: payment_method_options_card_present]/capture_method to the response with the default status

      response-optional-property-added

  • 1e483c60b4801See the full diff
    • ○

      added the optional property error/payment_intent/amount_details/anyOf[subschema #1: PaymentFlowsAmountDetails]/line_items/data/items/payment_method_options/anyOf[subschema #1: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions]/klarna/subscription_reference to the response with the default status

      response-optional-property-added

  • eb1ac21ec19c9See the full diff
    • ●

      removed the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paypay from the response with the default status

      response-optional-property-removed

    • ●

      removed the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/paypay from the response with the default status

      response-optional-property-removed

    • ●

      removed the optional property payment_method_details/anyOf[subschema #1: payment_method_details]/paypay from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new prevented enum value to the application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new prevented enum value to the balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new prevented enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status default

      response-property-enum-value-added

    • ●

      added the new prevented enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status default

      response-property-enum-value-added

    • ●

      added the new prevented enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status default

      response-property-enum-value-added

    • ●

      added the new prevented enum value to the failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status 200

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

  • 7b79777e9bbd4See the full diff
    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the default status

      response-optional-property-added

    • ○

      added the optional property payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the 200 status

      response-optional-property-added

  • c4dc6dbe947e2See the full diff
    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the default status

      response-optional-property-added

    • ○

      added the optional property payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the 200 status

      response-optional-property-added

  • 2df8ec106d3514See the full diff
    • ○

      added the optional property application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/refunds/data/items/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • ○

      added the optional property failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property refunds/data/items/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

  • 34998f9d7d7316See the full diff
    • ○

      added the optional property application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/balance_type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property balance_transaction/anyOf[subschema #2: BalanceTransaction]/balance_type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/balance_type to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/balance_type to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/balance_type to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/affirm/location to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/affirm/reader to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/wechat_pay/location to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/wechat_pay/reader to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/billie/anyOf[subschema #1: payment_method_options_billie]/capture_method to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/satispay to the response with the default status

      response-optional-property-added

    • ○

      added the optional property failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/balance_type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property payment_method_details/anyOf[subschema #1: payment_method_details]/affirm/location to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property payment_method_details/anyOf[subschema #1: payment_method_details]/affirm/reader to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property payment_method_details/anyOf[subschema #1: payment_method_details]/wechat_pay/location to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property payment_method_details/anyOf[subschema #1: payment_method_details]/wechat_pay/reader to the response with the 200 status

      response-optional-property-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

  • 0d3b125ef9f312See the full diff
    • ●

      added the new stripe_balance_payment_debit enum value to the application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit enum value to the balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit enum value to the failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit_reversal enum value to the application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit_reversal enum value to the balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit_reversal enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit_reversal enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit_reversal enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new stripe_balance_payment_debit_reversal enum value to the failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status 200

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.