FrameSDK/com.framepayments.framesdk.transfersv2/TransferV2Payment

TransferV2Payment

data class TransferV2Payment(val status: String? = null, val authorizationMode: String? = null, val receiptEmail: String? = null, val statementDescriptor: String? = null, val productId: String? = null, val paymentLinkId: String? = null, val subscriptionId: String? = null, val invoiceId: String? = null, val cartData: Map<String, String>? = null, val amountAuthorized: TransferV2Money? = null, val amountCaptured: TransferV2Money? = null, val amountRefunded: TransferV2Money? = null, val failureCode: String? = null, val failureReason: String? = null, val shipping: TransferV2Shipping? = null)

Nested payment detail on a payment-type V2 transfer.

Constructors

Link copied to clipboard
constructor(status: String? = null, authorizationMode: String? = null, receiptEmail: String? = null, statementDescriptor: String? = null, productId: String? = null, paymentLinkId: String? = null, subscriptionId: String? = null, invoiceId: String? = null, cartData: Map<String, String>? = null, amountAuthorized: TransferV2Money? = null, amountCaptured: TransferV2Money? = null, amountRefunded: TransferV2Money? = null, failureCode: String? = null, failureReason: String? = null, shipping: TransferV2Shipping? = null)

Properties

Link copied to clipboard
@SerializedName(value = "amount_authorized")
val amountAuthorized: TransferV2Money? = null

Amount authorized, if any.

Link copied to clipboard
@SerializedName(value = "amount_captured")
val amountCaptured: TransferV2Money? = null

Amount captured, if any.

Link copied to clipboard
@SerializedName(value = "amount_refunded")
val amountRefunded: TransferV2Money? = null

Amount refunded, if any.

Link copied to clipboard
@SerializedName(value = "authorization_mode")
val authorizationMode: String? = null

"automatic" or "manual" for a card payment.

Link copied to clipboard
@SerializedName(value = "cart_data")
val cartData: Map<String, String>? = null

Itemized cart attached to the payment, if any.

Link copied to clipboard
@SerializedName(value = "failure_code")
val failureCode: String? = null

Machine-readable failure code, if the payment failed.

Link copied to clipboard
@SerializedName(value = "failure_reason")
val failureReason: String? = null

Cardholder-safe failure text, if the payment failed.

Link copied to clipboard
@SerializedName(value = "invoice_id")
val invoiceId: String? = null

Invoice this payment belongs to, if any.

Link copied to clipboard
@SerializedName(value = "payment_link_id")
val paymentLinkId: String? = null

Payment link this payment was created from, if any.

Link copied to clipboard
@SerializedName(value = "product_id")
val productId: String? = null

Product this payment was created for, if any.

Link copied to clipboard
@SerializedName(value = "receipt_email")
val receiptEmail: String? = null

Email the receipt was sent to, if any.

Link copied to clipboard
val shipping: TransferV2Shipping? = null

Shipping attached to the payment, if any.

Link copied to clipboard
@SerializedName(value = "statement_descriptor")
val statementDescriptor: String? = null

Text shown on the cardholder statement, if any.

Link copied to clipboard
val status: String? = null

Payment status, such as "succeeded" or "requires_confirmation".

Link copied to clipboard
@SerializedName(value = "subscription_id")
val subscriptionId: String? = null

Subscription this payment belongs to, if any.