tbDEX SDK Documentation/tbdex.sdk.protocol.models

Package-level declarations

Types

class Balance(val metadata: ResourceMetadata, val data: BalanceData, var signature: String? = null) : Resource

Balance is a protected resource used to communicate the available amount of each currency held by the PFI on behalf of its customer.

BalanceData

class BalanceData(val currencyCode: String, val available: String) : ResourceData

A data class implementing ResourceData, which represents the contents of a Balance.

class Close : Message

A class representing the Close message. Close implements the Message class and contains close specific data

CloseData

class CloseData(val reason: String? = null, val success: Boolean? = null) : MessageData

A data class implementing MessageData that represents the contents of a Close.

CreateRfqData

class CreateRfqData(val offeringId: String, val payin: CreateSelectedPayinMethod, val payout: CreateSelectedPayoutMethod, val claims: List<String>)

Data contained in a RFQ message, including data which will be placed in Rfq.privateDAta. Used for creating an RFQ.

CreateSelectedPayinMethod

class CreateSelectedPayinMethod(val kind: String, val paymentDetails: Map<String, Any>? = null, val amount: String) : CreateSelectedPaymentMethod

A data class representing the payin method selected, including the cleartext payin details.

CreateSelectedPaymentMethod

sealed class CreateSelectedPaymentMethod(val kind: String, val paymentDetails: Map<String, Any>? = null)

A data class representing the payment method selected, including the cleartext payment details. Used for creating an RFQ.

CreateSelectedPayoutMethod

class CreateSelectedPayoutMethod(val kind: String, val paymentDetails: Map<String, Any>? = null) : CreateSelectedPaymentMethod

A data class representing the payin method selected, including the cleartext payout details.

Data

sealed interface Data

An interface that represents the data content of any tbDEX object.

Message

sealed class Message

An abstract class representing the structure and common functionality available on all Messages.

MessageData

sealed interface MessageData : Data

An interface that represents the contents of a Message.

MessageKind

enum MessageKind : Enum<MessageKind>

An enum representing all possible Message kinds.

MessageMetadata

class MessageMetadata(val from: String, val to: String, val kind: MessageKind, val id: String, val exchangeId: String, val externalId: String? = null, val createdAt: OffsetDateTime, val protocol: String) : Metadata

A data class representing the metadata present on every Message

Metadata

sealed interface Metadata

An interface that represents the metadata of a tbDEX object.

Offering

class Offering : Resource

A class representing the Offering resource. Offering implements the Resource class and contains Offering specific data

OfferingData

class OfferingData(val description: String, val payoutUnitsPerPayinUnit: String, val payin: PayinDetails, val payout: PayoutDetails, val requiredClaims: <Error class: unknown class>?) : ResourceData

A data class implementing ResourceData, which represents the contents of an Offering.

Order

class Order : Message

A class representing the Order message. Order implements the Message class and contains close specific data

OrderData

class OrderData : MessageData

A data class implementing MessageData that represents the contents of an Order.

OrderStatus

class OrderStatus : Message

A class representing the OrderStatus message. OrderStatus implements the Message class and contains close specific data

OrderStatusData

class OrderStatusData(val orderStatus: String) : MessageData

A data class implementing MessageData that represents the contents of an OrderStatus.

PayinDetails

class PayinDetails(val currencyCode: String, val min: String? = null, val max: String? = null, val methods: List<PayinMethod>) : PaymentDetails

A data class containing information pertaining to payin.

PayinMethod

class PayinMethod(val kind: String, val name: String? = null, val description: String? = null, val group: String? = null, val requiredPaymentDetails: <Error class: unknown class>? = null, val fee: String? = null, val min: String? = null, val max: String? = null) : PaymentMethod

A data class containing information pertaining to payin method.

PaymentDetails

sealed class PaymentDetails(val currencyCode: String, val min: String? = null, val max: String? = null, val methods: List<PaymentMethod>)

A data class representing the structure and common functionality available on PayinDetails and PayoutDetails.

PaymentInstruction

class PaymentInstruction(val link: String?, val instruction: String?)

Payment instruction

PaymentMethod

sealed class PaymentMethod(val kind: String, val name: String? = null, val description: String? = null, val group: String? = null, val requiredPaymentDetails: <Error class: unknown class>? = null, val fee: String? = null, val min: String? = null, val max: String? = null)

An abstract class representing the structure and common functionality available on all PaymentMethods.

PayoutDetails

class PayoutDetails(val currencyCode: String, val min: String? = null, val max: String? = null, val methods: List<PayoutMethod>) : PaymentDetails

A data class containing information pertaining to payout.

PayoutMethod

class PayoutMethod(val kind: String, val name: String? = null, val description: String? = null, val group: String? = null, val requiredPaymentDetails: <Error class: unknown class>? = null, val fee: String? = null, val min: String? = null, val max: String? = null, val estimatedSettlementTime: Int) : PaymentMethod

A data class containing information pertaining to payout method.

PrivatePaymentDetails

class PrivatePaymentDetails(val paymentDetails: Map<String, Any>? = null)

A container for the cleartext paymentDetails

Quote

class Quote : Message

A class representing the Quote message. Quote implements the Message class and contains close specific data

QuoteData

class QuoteData(val expiresAt: OffsetDateTime, val payin: QuoteDetails, val payout: QuoteDetails) : MessageData

A data class implementing MessageData that represents the contents of a Quote.

QuoteDetails

class QuoteDetails(val currencyCode: String, val amount: String, val fee: String? = null, val paymentInstruction: PaymentInstruction? = null)

A data class representing details for payin and payout amounts.

Resource

sealed class Resource

An abstract class representing the structure and common functionality available on all Resources.

ResourceData

sealed interface ResourceData : Data

An interface that represents the contents of a Resource.

ResourceKind

enum ResourceKind : Enum<ResourceKind>

An enum representing all possible Resource kinds.

ResourceMetadata

class ResourceMetadata(val kind: ResourceKind, val from: String, val id: String, val protocol: String, val createdAt: OffsetDateTime, val updatedAt: OffsetDateTime?) : Metadata

A data class representing the metadata present on every Resource.

Rfq

class Rfq : Message

A class representing the Rfq message. Rfq implements the Message class and contains close specific data

RfqData

class RfqData(val offeringId: String, val payin: SelectedPayinMethod, val payout: SelectedPayoutMethod, var claimsHash: String? = null) : MessageData

A data class implementing MessageData that represents the contents of an Rfq. This includes salted hashes of fields in RfqPrivateData.

RfqPrivateData

class RfqPrivateData(val salt: String, val payin: PrivatePaymentDetails? = null, val payout: PrivatePaymentDetails? = null, val claims: List<String>? = null)

Private data contained in a RFQ message, including data which will be placed in {@link RfqPrivateData}

SelectedPayinMethod

class SelectedPayinMethod(val kind: String, var paymentDetailsHash: String? = null, val amount: String) : SelectedPaymentMethod

A data class representing the payin method selected.

SelectedPaymentMethod

sealed class SelectedPaymentMethod(val kind: String, var paymentDetailsHash: String? = null) : MessageData

A data class representing the payment method selected.

SelectedPayoutMethod

class SelectedPayoutMethod(val kind: String, var paymentDetailsHash: String? = null) : SelectedPaymentMethod

A data class representing the payout method selected.