stellar-sdk/com.soneso.stellar.sdk.horizon.responses/ClaimableBalanceResponse

ClaimableBalanceResponse

@Serializable

data class ClaimableBalanceResponse(val id: String, val assetString: String, val amount: String, val sponsor: String? = null, val lastModifiedLedger: Long? = null, val lastModifiedTime: String? = null, val claimants: List<Claimant> = emptyList(), val flags: ClaimableBalanceResponse.Flags? = null, val pagingToken: String, val links: ClaimableBalanceResponse.Links) : Response, Pageable

Represents a claimable balance response from the Horizon API.

Claimable balances are used for trustless, non-interactive asset transfers. They can be claimed by the intended destination account(s) when certain conditions are met.

See also

Claimable Balance documentation

Constructors

ClaimableBalanceResponse

constructor(id: String, assetString: String, amount: String, sponsor: String? = null, lastModifiedLedger: Long? = null, lastModifiedTime: String? = null, claimants: List<Claimant> = emptyList(), flags: ClaimableBalanceResponse.Flags? = null, pagingToken: String, links: ClaimableBalanceResponse.Links)

Types

@Serializable

data class Flags(val clawbackEnabled: Boolean? = null)

Flags set on this claimable balance.

@Serializable

data class Links(val self: Link, val transactions: Link? = null, val operations: Link? = null)

HAL links connected to this claimable balance.

Properties

@SerialName(value = "amount")

val amount: String

The amount of the asset that can be claimed

@SerialName(value = "asset")

val assetString: String

The asset available to be claimed (in canonical form)

@SerialName(value = "claimants")

val claimants: List<Claimant>

The list of entities who can claim the balance

@SerialName(value = "flags")

val flags: ClaimableBalanceResponse.Flags?

Flags set on this claimable balance

@SerialName(value = "id")

Unique identifier for this claimable balance

lastModifiedLedger

@SerialName(value = "last_modified_ledger")

val lastModifiedLedger: Long?

The sequence number of the last ledger in which this claimable balance was modified

lastModifiedTime

@SerialName(value = "last_modified_time")

val lastModifiedTime: String?

An ISO 8601 formatted string of the last time this claimable balance was modified

@SerialName(value = "_links")

val links: ClaimableBalanceResponse.Links

HAL links related to this claimable balance

@SerialName(value = "paging_token")

open override val pagingToken: String

A cursor value for use in pagination

@SerialName(value = "sponsor")

val sponsor: String?

The account ID of the sponsor who is paying the reserves for this claimable balance