Create a charge
This method is no longer recommended—use the Payment Intents API to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge object used to request payment.
Response
Successful response.
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 in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).
Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).
The amount of the application fee (if any) requested for the charge. See the Connect documentation for details.
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.
If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
Time at which the object was created. Measured in seconds since the Unix epoch.
Three-letter ISO currency code, in lowercase. Must be a supported currency.
An arbitrary string attached to the object. Often useful for displaying to users.
Whether the charge has been disputed.
Error code explaining reason for charge failure if available (see the errors section for a list of codes).
Message to user further explaining reason for charge failure if available.
Unique identifier for the object.
If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
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.
String representing the object's type. Objects of the same type share the same value.
true if the charge succeeded, or was successfully authorized for later capture.
ID of the payment method used in this charge.
This is the email address that the receipt for this charge was sent to.
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.
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.
Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
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.
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.
A string that identifies this transaction as part of a group. See the Connect documentation for details.