RefundParameters

The RefundParameters object allows you to set the options you need to create a refund for an existing charge. For more information, see:

https://stripe.com/docs/api/refunds/create

To create an instance of this class, use the provided Builder.

Use of this SDK is subject to the Stripe Terminal Terms: https://stripe.com/terminal/legal

Types

sealed interface Builder

class ByChargeId(val id: String, val amount: Long, val currency: String) : RefundParameters.Builder

Use this builder to create a RefundParameters instance when you have a Charge ID.

class ByPaymentIntentId(val id: String, val clientSecret: String, val amount: Long, val currency: String) : RefundParameters.Builder

Use this builder to create a RefundParameters instance when you have a Payment Intent ID and Client Secret.

val amount: Long

val chargeId: String?

val clientSecret: String?

val currency: String

@Transient

val metadata: Map<String, String>?