Refund

  • Type: object

    Refund objects allow you to refund a previously created payment that isn't refunded yet. Funds are refunded to the credit or debit card that's initially charged.

    • amount
      Type: integer · amountWithCurrencyPrecisionFormat: int64
      required

      Integer amount in minor units (e.g. cents) specific to the currency. Example: 100 for €1.00

    • created
      Type: stringFormat: date-time
      required

      Unix timestamp when refund was created

    • currency
      Type: object · Currency
      required

      Three-letter ISO currency code

    • id
      Type: string
      required

      Unique identifier for the refund

    • destination_details
      Type: object · RefundDestinationDetails

      Details about the destination account to which the refund was credited.

    • failure_reason
      Type: string
      max length:  
      5000

      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.

    • payment
      • Type: string · PaymentId
        max length:  
        100

        The identifier of the Payment to refund

    • payment_intent
      • Type: string · IntentId
        max length:  
        100

        The identifier of the PaymentIntent to refund

    • pending_reason
      Type: stringenum

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

      values
      • charge_pending
      • insufficient_funds
      • processing
    • reason
      Type: string
      max length:  
      100      enum

      String indicating the reason for the refund. If set, possible values are duplicate, fraudulent, and requested_by_customer.

      values
      • duplicate
      • fraudulent
      • requested_by_customer
    • status
      Type: string | null
      max length:  
      100

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

    • updated
      Type: stringFormat: date-time

      When the transaction was last updated