FrameSDK/com.framepayments.framesdk.checkoutsessions/CheckoutSession

CheckoutSession

data class CheckoutSession(val id: String?, val accountId: String?, val clientSecret: String?, val sessionObject: String?, val expiresAt: Long?, val livemode: Boolean?, val amount: TransferV2Money? = null, val authorizationMode: String? = null, val destinationAccountId: String? = null)

The checkout session returned by POST /v1/checkout_sessions.

Constructors

CheckoutSession

constructor(id: String?, accountId: String?, clientSecret: String?, sessionObject: String?, expiresAt: Long?, livemode: Boolean?, amount: TransferV2Money? = null, authorizationMode: String? = null, destinationAccountId: String? = null)

Properties

@SerializedName(value = "account_id")

val accountId: String?

The account the token may read.

val amount: TransferV2Money? = null

Present only when the session was minted with a locked amount and can create a transfer.

authorizationMode

@SerializedName(value = "authorization_mode")

val authorizationMode: String? = null

The authorization mode the server stamps on transfers created by this session.

@SerializedName(value = "client_secret")

val clientSecret: String?

The chk_sess_… bearer token.

destinationAccountId

@SerializedName(value = "destination_account_id")

val destinationAccountId: String? = null

Destination the server stamps when the session was minted with one.

@SerializedName(value = "expires_at")

val expiresAt: Long?

Unix timestamp, in seconds, when the token expires.

val id: String?

The session identifier.

val livemode: Boolean?

true for a live-mode session.

@SerializedName(value = "object")

val sessionObject: String?

The object type. Always "checkout_session".