PostCharges

{
  "type": "object",
  "description": "To charge a credit or a debit card, you create a `Charge` object. You can\nretrieve and refund individual charges as well as list all charges. Charges\nare identified by a unique, random ID.\n\nRelated guide: [Accept a payment with the Charges API](https://stripe.com/docs/payments/accept-a-payment-charges).",
  "required": [
    "amount",
    "amount_captured",
    "amount_refunded",
    "billing_details",
    "captured",
    "created",
    "currency",
    "disputed",
    "id",
    "livemode",
    "metadata",
    "object",
    "paid",
    "refunded",
    "status"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (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](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."
    },
    "amount_captured": {
      "type": "integer",
      "description": "Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made)."
    },
    "amount_refunded": {
      "type": "integer",
      "description": "Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued)."
    },
    "application": {
      "description": "ID of the Connect application that created the charge.",
      "type": "object"
    },
    "application_fee": {
      "description": "The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details.",
      "type": "object"
    },
    "application_fee_amount": {
      "type": "integer",
      "description": "The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details."
    },
    "balance_transaction": {
      "description": "ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).",
      "type": "object"
    },
    "billing_details": {
      "type": "object",
      "properties": {
        "address": {
          "description": "Billing address.",
          "type": "object"
        },
        "email": {
          "type": "string",
          "description": "Email address."
        },
        "name": {
          "type": "string",
          "description": "Full name."
        },
        "phone": {
          "type": "string",
          "description": "Billing phone number (including extension)."
        }
      }
    },
    "calculated_statement_descriptor": {
      "type": "string",
      "description": "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."
    },
    "captured": {
      "type": "boolean",
      "description": "If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "customer": {
      "description": "ID of the customer this charge is for if one exists.",
      "type": "object"
    },
    "description": {
      "type": "string",
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "disputed": {
      "type": "boolean",
      "description": "Whether the charge has been disputed."
    },
    "failure_balance_transaction": {
      "description": "ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.",
      "type": "object"
    },
    "failure_code": {
      "type": "string",
      "description": "Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes)."
    },
    "failure_message": {
      "type": "string",
      "description": "Message to user further explaining reason for charge failure if available."
    },
    "fraud_details": {
      "description": "Information on fraud assessments for the charge.",
      "type": "object"
    },
    "id": {
      "type": "string",
      "description": "Unique identifier for the object."
    },
    "invoice": {
      "description": "ID of the invoice this charge is for if one exists.",
      "type": "object"
    },
    "livemode": {
      "type": "boolean",
      "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."
    },
    "object": {
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value.",
      "enum": [
        "charge"
      ]
    },
    "on_behalf_of": {
      "description": "The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers) for details.",
      "type": "object"
    },
    "outcome": {
      "description": "Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.",
      "type": "object"
    },
    "paid": {
      "type": "boolean",
      "description": "`true` if the charge succeeded, or was successfully authorized for later capture."
    },
    "payment_intent": {
      "description": "ID of the PaymentIntent associated with this charge, if one exists.",
      "type": "object"
    },
    "payment_method": {
      "type": "string",
      "description": "ID of the payment method used in this charge."
    },
    "payment_method_details": {
      "description": "Details about the payment method at the time of the transaction.",
      "type": "object"
    },
    "radar_options": {
      "type": "object",
      "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.",
      "properties": {
        "session": {
          "type": "string",
          "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments."
        }
      }
    },
    "receipt_email": {
      "type": "string",
      "description": "This is the email address that the receipt for this charge was sent to."
    },
    "receipt_number": {
      "type": "string",
      "description": "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": {
      "type": "string",
      "description": "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": {
      "type": "boolean",
      "description": "Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false."
    },
    "refunds": {
      "type": "object",
      "description": "A list of refunds that have been applied to the charge.",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "data": {
          "type": "array",
          "description": "Details about each object.",
          "items": {
            "type": "object",
            "description": "`Refund` objects allow you to refund a charge that has previously been created\nbut not yet refunded. Funds will be refunded to the credit or debit card that\nwas originally charged.\n\nRelated guide: [Refunds](https://stripe.com/docs/refunds).",
            "required": [
              "amount",
              "created",
              "currency",
              "id",
              "object"
            ],
            "properties": {
              "amount": {
                "type": "integer",
                "description": "Amount, in %s."
              },
              "balance_transaction": {
                "description": "Balance transaction that describes the impact on your account balance.",
                "type": "object"
              },
              "charge": {
                "description": "ID of the charge that was refunded.",
                "type": "object"
              },
              "created": {
                "type": "integer",
                "format": "unix-time",
                "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
              },
              "currency": {
                "type": "string",
                "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
              },
              "description": {
                "type": "string",
                "description": "An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only)"
              },
              "failure_balance_transaction": {
                "description": "If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.",
                "type": "object"
              },
              "failure_reason": {
                "type": "string",
                "description": "If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request` or `unknown`."
              },
              "id": {
                "type": "string",
                "description": "Unique identifier for the object."
              },
              "instructions_email": {
                "type": "string",
                "description": "Email to which refund instructions, if required, are sent to."
              },
              "metadata": {
                "type": "object",
                "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."
              },
              "next_action": {
                "type": "object",
                "required": [
                  "type"
                ],
                "properties": {
                  "display_details": {
                    "description": "Contains the refund details.",
                    "type": "object"
                  },
                  "type": {
                    "type": "string",
                    "description": "Type of the next action to perform."
                  }
                }
              },
              "object": {
                "type": "string",
                "description": "String representing the object's type. Objects of the same type share the same value.",
                "enum": [
                  "refund"
                ]
              },
              "payment_intent": {
                "description": "ID of the PaymentIntent that was refunded.",
                "type": "object"
              },
              "reason": {
                "type": "string",
                "description": "Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).",
                "enum": [
                  "duplicate",
                  "expired_uncaptured_charge",
                  "fraudulent",
                  "requested_by_customer"
                ]
              },
              "receipt_number": {
                "type": "string",
                "description": "This is the transaction number that appears on email receipts sent for this refund."
              },
              "source_transfer_reversal": {
                "description": "The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details.",
                "type": "object"
              },
              "status": {
                "type": "string",
                "description": "Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Refer to our [refunds](https://stripe.com/docs/refunds#failed-refunds) documentation for more details."
              },
              "transfer_reversal": {
                "description": "If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter.",
                "type": "object"
              }
            }
          }
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        },
        "object": {
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
          "enum": [
            "list"
          ]
        },
        "url": {
          "type": "string",
          "description": "The URL where this list can be accessed."
        }
      }
    },
    "review": {
      "description": "ID of the review associated with this charge if one exists.",
      "type": "object"
    },
    "shipping": {
      "description": "Shipping information for the charge.",
      "type": "object"
    },
    "source_transfer": {
      "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.",
      "type": "object"
    },
    "statement_descriptor": {
      "type": "string",
      "description": "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."
    },
    "statement_descriptor_suffix": {
      "type": "string",
      "description": "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."
    },
    "status": {
      "type": "string",
      "description": "The status of the payment is either `succeeded`, `pending`, or `failed`.",
      "enum": [
        "failed",
        "pending",
        "succeeded"
      ]
    },
    "transfer": {
      "description": "ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).",
      "type": "object"
    },
    "transfer_data": {
      "description": "An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.",
      "type": "object"
    },
    "transfer_group": {
      "type": "string",
      "description": "A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details."
    }
  }
}