external/com.stripe.stripeterminal.external.models/RefundParameters/ByChargeId

ByChargeId

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.

Parameters

id

The ID of the Charge to be refunded.

amount

The amount to be refunded, provided in the currency's smallest unit.

currency

Three-letter ISO currency code. Must be a supported currency.

Constructors

constructor(id: String, amount: Long, currency: String)

Properties

open override val amount: Long

open override val clientSecret: String? = null

The client secret of the original payment intent.

open override val currency: String

open override val id: String

open override var metadata: Map<String, String>?

refundApplicationFee

open override var refundApplicationFee: Boolean

reverseTransfer

open override var reverseTransfer: Boolean

Functions

open fun build(): RefundParameters

Create a final instance of RefundParameters with the parameters that have been set with this builder.

open fun setMetadata(value: Map<String, String>): RefundParameters.Builder

Set of key-value pairs that you can attach to an object.

setRefundApplicationFee

open fun setRefundApplicationFee(value: Boolean): RefundParameters.Builder

Connect only: Nullable boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded.

setReverseTransfer

open fun setReverseTransfer(value: Boolean): RefundParameters.Builder

Connect only: Nullable boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).