Report a refund 

Report that the most recent payment attempt on the specified Payment Record was refunded.

Parameters

• idstringRequired

  The ID of the Payment Record.

• outcomeenumRequired

  The outcome of the reported refund.

  Possible enum values

  refunded The payment was refunded.

• processor_detailsobjectRequired

  Processor information for this refund.

  Hide child parameters

  • processor_details.typeenumRequired

    The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.

    Possible enum values

    custom A custom payment processor that is not included in Stripe’s standard processor types. This allows you to report refunds processed through external payment processors or custom integrations.

  • processor_details.customobject

    Information about the custom processor used to make this refund.

    Hide child parameters

    • processor_details.custom.refund_referencestringRequired

      A reference to the external refund. This field must be unique across all refunds.

• refundedobjectRequired

  Information about the payment attempt refund.

  Hide child parameters

  • refunded.refunded_attimestampRequired

    When the reported refund completed. Measured in seconds since the Unix epoch.

• amountobject

  A positive integer in the smallest currency unit representing how much of this payment to refund. Can refund only up to the remaining, unrefunded amount of the payment.

  Hide child parameters

  • amount.currencyenumRequired

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

  • amount.valueintegerRequired

    A positive integer representing the amount in the currency’s minor unit. For example, 100 can represent 1 USD or 100 JPY.

• initiated_attimestamp

  When the reported refund was initiated. Measured in seconds since the Unix epoch.

• metadataobject

  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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.