tbDEX SDK Documentation/tbdex.sdk.protocol.models/PayoutMethod

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.

Constructors

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

Properties

val description: String? = null

Blurb containing helpful information about the payment method. Expected to be rendered on screen. e.g. "segwit addresses only"

estimatedSettlementTime

val estimatedSettlementTime: Int

Estimated time taken to settle an order. Expressed in seconds.

val fee: String? = null

Fee charged to use this payment method. Absence of this field implies that there is no additional fee associated to the respective payment method.

val group: String? = null

Value that can be used to group specific payment methods together e.g. Mobile Money vs. Direct Bank Deposit

val kind: String

Unique string identifying a single kind of payment method.

val max: String? = null

Maximum amount allowed when using this payment method.

val min: String? = null

Minimum amount required to use this payment method.

val name: String? = null

Payment Method name. Expected to be rendered on screen.

requiredPaymentDetails

val requiredPaymentDetails: <Error class: unknown class>? = null

A JSON Schema containing the fields that need to be collected in the RFQ's selected payment methods in order to use this payment method.

Functions

getRequiredPaymentDetailsSchema

fun getRequiredPaymentDetailsSchema(): <Error class: unknown class>?

Parse the contents of requiredPaymentDetails into a JsonSchema that can do validation.