FrameSDK/com.framepayments.framesdk.refunds/Refund

Refund

data class Refund(val id: String?, val charge: String?, val currency: String?, val description: String?, val status: String?, val created: Int?, val updated: Int?, val amountCaptured: Int?, val amountRefunded: Int?, val chargeIntent: String?, val failureReason: String?, val refundObject: String?)

Represents a refund issued against a charge or charge intent.

Constructors

constructor(id: String?, charge: String?, currency: String?, description: String?, status: String?, created: Int?, updated: Int?, amountCaptured: Int?, amountRefunded: Int?, chargeIntent: String?, failureReason: String?, refundObject: String?)

Properties

@SerializedName(value = "amount_captured")

val amountCaptured: Int?

Amount that was captured on the original charge, in the smallest currency unit.

@SerializedName(value = "amount_refunded")

val amountRefunded: Int?

Amount refunded, in the smallest currency unit.

val charge: String?

ID of the charge this refund is applied to.

@SerializedName(value = "charge_intent")

val chargeIntent: String?

ID of the charge intent associated with this refund.

val created: Int?

Unix timestamp of when the refund was created.

val currency: String?

Three-letter ISO currency code for the refund amount.

val description: String?

Optional description provided when the refund was created.

@SerializedName(value = "failure_reason")

val failureReason: String?

Reason for refund failure, if applicable.

val id: String?

Unique identifier for the refund.

@SerializedName(value = "object")

val refundObject: String?

String identifier for the object type, always "refund".

val status: String?

Current status of the refund (e.g., "succeeded", "pending", "failed").

val updated: Int?

Unix timestamp of when the refund was last updated.