Charges

200Charge

• amount_authorizednumberrequired

  Amount (in the smallest currency unit) originally authorized. Fixed at creation — does not include later increases from incremental authorizations (see amount_incremented). The charge's current authorization hold is amount_authorized + amount_incremented.

• amount_capturednumberrequired

  Amount (in the smallest currency unit) captured. Can be greater/less than the amount on the PaymentIntent if a partial/over capture was made. Includes any surcharge_amount.

• amount_incrementednumberrequired

  Amount (in the smallest currency unit) by which the authorization hold on this charge has been raised via incremental authorizations (e.g. overcapture on card-not-present transactions).

• amount_refundednumberrequired

  Amount (in the smallest currency unit) refunded. Can be less than the amount on the PaymentIntent if a partial refund was made. Includes any surcharge refunded.

• authorized_atstring date-timeoptional

  Time at which the charge was authorized.

• balance_transactionBalanceTransactionoptional

  The balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). Note: Multiple balance transactions may be associated with this resource and you can fetch them all with /balance-transactions?source_id={id}.

• capturedbooleanrequired

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

• captured_atstring date-timeoptional

  Time at which the charge was captured.

• created_atstring date-timerequired

  Time at which the object was created.

• detailsobjectoptional

  AVS and CVS checks and other payment details.

• failed_atstring date-timeoptional

  Time at which the charge failed.

• failure_codestring (partial_authorization | account_closed | account_frozen | account_number_invalid | authorization_revoked | avs_check_failed | bank_account_blocked | call_issuer | …)optional

  Error code explaining reason for charge failure.

• failure_messagestringoptional

  Message to user further explaining the reason for the charge failure.

• idstringrequired

  Unique identifier for the object.

• next_stepsstringoptional

  Message to user explaining how to remedy a failure.

• payment_intent_idstringrequired

  The ID of the PaymentIntent associated with this charge.

• payment_method_idstringrequired

  The id of the PaymentMethod at the time of the transaction.

• platform_feePlatformFeeoptional

  The platform fee (if any) for the charge.

• refundedbooleanrequired

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

• refundsarray of Refundrequired

  A list of refunds that have been applied to the charge.

• source_transaction_idstringoptional

• source_typestring (external)optional

  Indicates whether the transaction was external.

• statusstring (succeeded | pending | failed)required

  The status of the payment.

• surcharge_amountnumberrequired

  Amount (in the smallest currency unit) of the surcharge applied to the charge.

• tip_amountnumberoptional

  Portion of the amount that is a tip/gratuity (if any).

• updated_atstring date-timerequired

  Time at which the object was updated.