StripeAPI.Types.Charge

amount: 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: Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made).

amount_refunded: Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued).

application: ID of the Connect application that created the charge.

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

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

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

billing_details:

calculated_statement_descriptor: 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.

Constraints:

• Maximum length of 5000

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

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

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

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

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

Constraints:

• Maximum length of 40000

disputed: Whether the charge has been disputed.

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

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

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

fraud_details: Information on fraud assessments for the charge.

id: Unique identifier for the object.

Constraints:

• Maximum length of 5000

invoice: ID of the invoice this charge is for if one exists.

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

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: The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the Connect documentation for details.

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

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

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

payment_method: ID of the payment method used in this charge.

Constraints:

• Maximum length of 5000

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

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

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

Constraints:

• Maximum length of 5000

receipt_number: 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.

Constraints:

• Maximum length of 5000

receipt_url: 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.

Constraints:

• Maximum length of 5000

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

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

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

shipping: Shipping information for the charge.

source_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: For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.

Constraints:

• Maximum length of 5000

statement_descriptor_suffix: Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.

Constraints:

• Maximum length of 5000

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

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

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

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

Constraints:

• Maximum length of 5000

stripe_report: Assessments from Stripe. If set, the value is `fraudulent`.

Constraints:

• Maximum length of 5000

user_report: Assessments reported by you. If set, possible values of are `safe` and `fraudulent`.

Constraints:

• Maximum length of 5000

network_status: Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was blocked by Stripe after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.

Constraints:

• Maximum length of 5000

reason: An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See understanding declines for more details.

Constraints:

• Maximum length of 5000

risk_level: Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar.

Constraints:

• Maximum length of 5000

risk_score: Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.

rule: The ID of the Radar rule that matched the payment, if applicable.

seller_message: A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.

Constraints:

• Maximum length of 5000

type: Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See understanding declines and Radar reviews for details.

Constraints:

• Maximum length of 5000

ach_credit_transfer:

ach_debit:

acss_debit:

affirm:

afterpay_clearpay:

alipay:

au_becs_debit:

bacs_debit:

bancontact:

boleto:

card:

card_present:

customer_balance:

eps:

fpx:

giropay:

grabpay:

ideal:

interac_present:

klarna:

konbini:

link:

multibanco:

oxxo:

p24:

paynow:

promptpay:

sepa_debit:

sofort:

stripe_account:

type: The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`. An additional hash is included on `payment_method_details` with a name matching this value. It contains information specific to the payment method.

Constraints:

• Maximum length of 5000

us_bank_account:

wechat:

wechat_pay:

data: Details about each object.

has_more: True if this list has another page of items after this one that can be fetched.

url: The URL where this list can be accessed.

Constraints:

• Maximum length of 5000

address:

carrier: The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

Constraints:

• Maximum length of 5000

name: Recipient name.

Constraints:

• Maximum length of 5000

phone: Recipient phone (including extension).

Constraints:

• Maximum length of 5000

tracking_number: The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

Constraints:

• Maximum length of 5000

amount: The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.

destination: ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.