Interface Charge

Export

Charge

Hierarchy

  • Charge

Properties

amount_captured: number

Amount (in the smallest currency unit) captured. Can be less than the amount on the PaymentIntent if a partial capture was made.

Memberof

Charge

amount_refunded: number

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

Memberof

Charge

balance_transaction?: BalanceTransaction

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

Memberof

Charge

Deprecated

captured: boolean

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

Memberof

Charge

captured_at?: string

Time at which the charge was captured.

Memberof

Charge

created_at: string

Time at which the object was created.

Memberof

Charge

details?: object

AVS and CVS checks and other payment details.

Memberof

Charge

failed_at?: string

Time at which the charge failed.

Memberof

Charge

failure_code?: ChargeFailureCode

Error code explaining reason for charge failure.

Memberof

Charge

failure_message?: string

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

Memberof

Charge

id: string

Unique identifier for the object.

Memberof

Charge

next_steps?: string

Message to user explaining how to remedy a failure.

Memberof

Charge

payment_intent_id: string

The ID of the PaymentIntent associated with this charge.

Memberof

Charge

payment_method_id: string

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

Memberof

Charge

platform_fee?: PlatformFee

The platform fee (if any) for the charge.

Memberof

Charge

refunded: boolean

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

Memberof

Charge

refunds: Refund[]

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

Memberof

Charge

status: ChargeStatus

The status of the payment.

Memberof

Charge

updated_at: string

Time at which the object was updated.

Memberof

Charge

Generated using TypeDoc