The Refund object 

Attributes

• idstring

  Unique identifier for the object.

• amountinteger

  Amount, in cents.

• chargenullable stringExpandable

  ID of the charge that’s refunded.

• currencyenum

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

• descriptionnullable string

  An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).

• metadatanullable object

  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.

• payment_intentnullable stringExpandable

  ID of the PaymentIntent that’s refunded.

• reasonnullable enum

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

• statusnullable string

  Status of the refund. This can be pending, requires_action, succeeded, failed, or canceled. Learn more about failed refunds.

More attributes

Collapse all

• objectstring

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

• balance_transactionnullable stringExpandable

  Balance transaction that describes the impact on your account balance.

• createdtimestamp

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

• destination_detailsnullable object

  Transaction-specific details for the refund.

  Hide child attributes

  • destination_details.affirmnullable object

    If this is a affirm refund, this hash contains the transaction specific details of the affirm refund method.

  • destination_details.afterpay_clearpaynullable object

    If this is a afterpay_clearpay refund, this hash contains the transaction specific details of the afterpay_clearpay refund method.

  • destination_details.alipaynullable object

    If this is a alipay refund, this hash contains the transaction specific details of the alipay refund method.

  • destination_details.almanullable object

    If this is a alma refund, this hash contains the transaction specific details of the alma refund method.

  • destination_details.amazon_paynullable object

    If this is a amazon_pay refund, this hash contains the transaction specific details of the amazon_pay refund method.

  • destination_details.au_bank_transfernullable object

    If this is a au_bank_transfer refund, this hash contains the transaction specific details of the au_bank_transfer refund method.

  • destination_details.bliknullable objectPreview feature

    If this is a blik refund, this hash contains the transaction specific details of the blik refund method.

    Hide child attributes

    • destination_details.blik.network_decline_codenullable string

      For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.

    • destination_details.blik.referencenullable string

      The reference assigned to the refund.

    • destination_details.blik.reference_statusnullable string

      Status of the reference on the refund. This can be pending, available or unavailable.

  • destination_details.br_bank_transfernullable object

    If this is a br_bank_transfer refund, this hash contains the transaction specific details of the br_bank_transfer refund method.

    Hide child attributes

    • destination_details.br_bank_transfer.referencenullable string

      The reference assigned to the refund.

    • destination_details.br_bank_transfer.reference_statusnullable string

      Status of the reference on the refund. This can be pending, available or unavailable.

  • destination_details.cardnullable object

    If this is a card refund, this hash contains the transaction specific details of the card refund method.

    Hide child attributes

    • destination_details.card.referencenullable string

      Value of the reference number assigned to the refund.

    • destination_details.card.reference_statusnullable string

      Status of the reference number on the refund. This can be pending, available or unavailable.

    • destination_details.card.reference_typenullable string

      Type of the reference number assigned to the refund.

    • destination_details.card.typeenum

      The type of refund. This can be refund, reversal, or pending.

      Possible enum values

      pending The refund is still processing and its type is not confirmed yet.

      refund The refund will show as a credit entry on the bank statement.

      reversal The refund goes through as a reversal. The original charge will drop off the bank statement altogether.

  • destination_details.cashappnullable object

    If this is a cashapp refund, this hash contains the transaction specific details of the cashapp refund method.

  • destination_details.customer_cash_balancenullable object

    If this is a customer_cash_balance refund, this hash contains the transaction specific details of the customer_cash_balance refund method.

  • destination_details.epsnullable object

    If this is a eps refund, this hash contains the transaction specific details of the eps refund method.

  • destination_details.eu_bank_transfernullable object

    If this is a eu_bank_transfer refund, this hash contains the transaction specific details of the eu_bank_transfer refund method.

    Hide child attributes

    • destination_details.eu_bank_transfer.referencenullable string

      The reference assigned to the refund.

    • destination_details.eu_bank_transfer.reference_statusnullable string

      Status of the reference on the refund. This can be pending, available or unavailable.

  • destination_details.gb_bank_transfernullable object

    If this is a gb_bank_transfer refund, this hash contains the transaction specific details of the gb_bank_transfer refund method.

    Hide child attributes

    • destination_details.gb_bank_transfer.referencenullable string

      The reference assigned to the refund.

    • destination_details.gb_bank_transfer.reference_statusnullable string

      Status of the reference on the refund. This can be pending, available or unavailable.

  • destination_details.giropaynullable object

    If this is a giropay refund, this hash contains the transaction specific details of the giropay refund method.

  • destination_details.grabpaynullable object

    If this is a grabpay refund, this hash contains the transaction specific details of the grabpay refund method.

  • destination_details.jp_bank_transfernullable object

    If this is a jp_bank_transfer refund, this hash contains the transaction specific details of the jp_bank_transfer refund method.

    Hide child attributes

    • destination_details.jp_bank_transfer.referencenullable string

      The reference assigned to the refund.

    • destination_details.jp_bank_transfer.reference_statusnullable string

      Status of the reference on the refund. This can be pending, available or unavailable.

  • destination_details.klarnanullable object

    If this is a klarna refund, this hash contains the transaction specific details of the klarna refund method.

  • destination_details.multibanconullable object

    If this is a multibanco refund, this hash contains the transaction specific details of the multibanco refund method.

    Hide child attributes

    • destination_details.multibanco.referencenullable string

      The reference assigned to the refund.

    • destination_details.multibanco.reference_statusnullable string

      Status of the reference on the refund. This can be pending, available or unavailable.

  • destination_details.mx_bank_transfernullable object

    If this is a mx_bank_transfer refund, this hash contains the transaction specific details of the mx_bank_transfer refund method.

    Hide child attributes

    • destination_details.mx_bank_transfer.referencenullable string

      The reference assigned to the refund.

    • destination_details.mx_bank_transfer.reference_statusnullable string

      Status of the reference on the refund. This can be pending, available or unavailable.

  • destination_details.nz_bank_transfernullable objectPreview feature

    If this is a nz_bank_transfer refund, this hash contains the transaction specific details of the nz_bank_transfer refund method.

  • destination_details.p24nullable object

    If this is a p24 refund, this hash contains the transaction specific details of the p24 refund method.

    Hide child attributes

    • destination_details.p24.referencenullable string

      The reference assigned to the refund.

    • destination_details.p24.reference_statusnullable string

      Status of the reference on the refund. This can be pending, available or unavailable.

  • destination_details.paynownullable object

    If this is a paynow refund, this hash contains the transaction specific details of the paynow refund method.

  • destination_details.paypalnullable object

    If this is a paypal refund, this hash contains the transaction specific details of the paypal refund method.

    Hide child attributes

    • destination_details.paypal.network_decline_codenullable string

      For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.

  • destination_details.pixnullable objectPreview feature

    If this is a pix refund, this hash contains the transaction specific details of the pix refund method.

  • destination_details.revolutnullable object

    If this is a revolut refund, this hash contains the transaction specific details of the revolut refund method.

  • destination_details.sofortnullable object

    If this is a sofort refund, this hash contains the transaction specific details of the sofort refund method.

  • destination_details.swishnullable object

    If this is a swish refund, this hash contains the transaction specific details of the swish refund method.

    Hide child attributes

    • destination_details.swish.network_decline_codenullable string

      For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.

    • destination_details.swish.referencenullable string

      The reference assigned to the refund.

    • destination_details.swish.reference_statusnullable string

      Status of the reference on the refund. This can be pending, available or unavailable.

  • destination_details.th_bank_transfernullable object

    If this is a th_bank_transfer refund, this hash contains the transaction specific details of the th_bank_transfer refund method.

    Hide child attributes

    • destination_details.th_bank_transfer.referencenullable string

      The reference assigned to the refund.

    • destination_details.th_bank_transfer.reference_statusnullable string

      Status of the reference on the refund. This can be pending, available or unavailable.

  • destination_details.typestring

    The type of transaction-specific details of the payment method used in the refund (e.g., card). An additional hash is included on destination_details with a name matching this value. It contains information specific to the refund transaction.

  • destination_details.us_bank_transfernullable object

    If this is a us_bank_transfer refund, this hash contains the transaction specific details of the us_bank_transfer refund method.

    Hide child attributes

    • destination_details.us_bank_transfer.referencenullable string

      The reference assigned to the refund.

    • destination_details.us_bank_transfer.reference_statusnullable string

      Status of the reference on the refund. This can be pending, available or unavailable.

  • destination_details.wechat_paynullable object

    If this is a wechat_pay refund, this hash contains the transaction specific details of the wechat_pay refund method.

  • destination_details.zipnullable object

    If this is a zip refund, this hash contains the transaction specific details of the zip refund method.

• failure_balance_transactionnullable stringExpandable

  After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.

• failure_reasonnullable string

  Provides the reason for the refund failure. Possible values are: lost_or_stolen_card, expired_or_canceled_card, charge_for_pending_refund_disputed, insufficient_funds, declined, merchant_request, or unknown.

• instructions_emailnullable string

  For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.

• next_actionnullable object

  If the refund has a status of requires_action, this property describes what the refund needs to continue processing.

  Hide child attributes

  • next_action.display_detailsnullable object

    Contains the refund details.

    Hide child attributes

    • next_action.display_details.email_sentobject

      Contains information about the email sent to the customer.

      Hide child attributes

      • next_action.display_details.email_sent.email_sent_attimestamp

        The timestamp when the email was sent.

      • next_action.display_details.email_sent.email_sent_tostring

        The recipient’s email address.

    • next_action.display_details.expires_attimestamp

      The expiry timestamp.

  • next_action.typestring

    Type of the next action to perform.

• pending_reasonnullable enum

  Provides the reason for why the refund is pending. Possible values are: processing, insufficient_funds, or charge_pending.

• receipt_numbernullable string

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

• source_transfer_reversalnullable stringExpandableConnect only

  The transfer reversal that’s associated with the refund. Only present if the charge came from another Stripe account.

• transfer_reversalnullable stringExpandableConnect only

  This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.