Documentation

Fields

• refundAmount :: Int

  amount: Amount, in %s.

• refundBalanceTransaction :: Maybe RefundBalanceTransaction'Variants

  balance_transaction: Balance transaction that describes the impact on your account balance.

• refundCharge :: Maybe RefundCharge'Variants

  charge: ID of the charge that was refunded.

• refundCreated :: Int

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

• refundCurrency :: Text

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

• refundDescription :: Maybe Text

  description: An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only)

  Constraints:

  • Maximum length of 5000
• refundFailureBalanceTransaction :: Maybe RefundFailureBalanceTransaction'Variants

  failure_balance_transaction: If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.

• refundFailureReason :: Maybe Text

  failure_reason: If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, or `unknown`.

  Constraints:

  • Maximum length of 5000
• refundId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• refundMetadata :: Maybe Object

  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.

• refundPaymentIntent :: Maybe RefundPaymentIntent'Variants

  payment_intent: ID of the PaymentIntent that was refunded.

• refundReason :: Maybe Text

  reason: Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).

  Constraints:

  • Maximum length of 5000
• refundReceiptNumber :: Maybe Text

  receipt_number: This is the transaction number that appears on email receipts sent for this refund.

  Constraints:

  • Maximum length of 5000
• refundSourceTransferReversal :: Maybe RefundSourceTransferReversal'Variants

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

• refundStatus :: Maybe Text

  status: Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `succeeded`, `failed`, or `canceled`. Refer to our refunds documentation for more details.

  Constraints:

  • Maximum length of 5000
• refundTransferReversal :: Maybe RefundTransferReversal'Variants

  transfer_reversal: If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter.