Mayson Monorepo Documentation
    Preparing search index...

    The Charge object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but Account Debits may also create Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations.

    interface Charge {
        id: string;
        object: "charge";
        amount: number;
        amount_captured: number;
        amount_refunded: number;
        application: string | Application;
        application_fee: string | Stripe.ApplicationFee;
        application_fee_amount: number;
        authorization_code?: string;
        balance_transaction: string | Stripe.BalanceTransaction;
        billing_details: Stripe.Charge.BillingDetails;
        calculated_statement_descriptor: string;
        captured: boolean;
        created: number;
        currency: string;
        customer: string | Stripe.Customer | DeletedCustomer;
        description: string;
        disputed: boolean;
        failure_balance_transaction: string | Stripe.BalanceTransaction;
        failure_code: string;
        failure_message: string;
        fraud_details: Stripe.Charge.FraudDetails;
        level3?: Stripe.Charge.Level3;
        livemode: boolean;
        metadata: Metadata;
        on_behalf_of: string | Stripe.Account;
        outcome: Stripe.Charge.Outcome;
        paid: boolean;
        payment_intent: string | Stripe.PaymentIntent;
        payment_method: string;
        payment_method_details: Stripe.Charge.PaymentMethodDetails;
        presentment_details?: Stripe.Charge.PresentmentDetails;
        radar_options?: Stripe.Charge.RadarOptions;
        receipt_email: string;
        receipt_number: string;
        receipt_url: string;
        refunded: boolean;
        refunds?: ApiList<Stripe.Refund>;
        review: string | Stripe.Review;
        shipping: Stripe.Charge.Shipping;
        source: CustomerSource;
        source_transfer: string | Transfer;
        statement_descriptor: string;
        statement_descriptor_suffix: string;
        status: Stripe.Charge.Status;
        transfer?: string | Transfer;
        transfer_data: Stripe.Charge.TransferData;
        transfer_group: string;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "charge"

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

    amount: number

    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: number

    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: number

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

    application: string | Application

    ID of the Connect application that created the charge.

    application_fee: string | Stripe.ApplicationFee

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

    application_fee_amount: number

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

    authorization_code?: string

    Authorization code on the charge.

    balance_transaction: string | Stripe.BalanceTransaction

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

    billing_details: Stripe.Charge.BillingDetails
    calculated_statement_descriptor: string

    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: number

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

    currency: string

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

    customer: string | Stripe.Customer | DeletedCustomer

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

    description: string

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

    disputed: boolean

    Whether the charge has been disputed.

    failure_balance_transaction: string | Stripe.BalanceTransaction

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

    failure_code: string

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

    failure_message: string

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

    fraud_details: Stripe.Charge.FraudDetails

    Information on fraud assessments for the charge.

    livemode: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    metadata: Metadata

    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.

    on_behalf_of: string | Stripe.Account

    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.

    paid: boolean

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

    payment_intent: string | Stripe.PaymentIntent

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

    payment_method: string

    ID of the payment method used in this charge.

    payment_method_details: Stripe.Charge.PaymentMethodDetails

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

    presentment_details?: Stripe.Charge.PresentmentDetails
    radar_options?: Stripe.Charge.RadarOptions

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

    receipt_email: string

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

    receipt_number: string

    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_url: string

    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.

    refunded: boolean

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

    refunds?: ApiList<Stripe.Refund>

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

    review: string | Stripe.Review

    ID of the review associated with this charge if one exists.

    Shipping information for the charge.

    This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to payment_method or payment_method_details instead.

    source_transfer: string | Transfer

    The transfer ID which created this charge. Only present if the charge came from another Stripe account. See the Connect documentation for details.

    statement_descriptor: string

    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_suffix: string

    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.

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

    transfer?: string | Transfer

    ID of the transfer to the destination account (only applicable if the charge was created using the destination parameter).

    transfer_data: Stripe.Charge.TransferData

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

    transfer_group: string

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