Portal Android SDK/io.portalhq.android.api.data.noah/NoahGetPayoutQuoteRequest

NoahGetPayoutQuoteRequest

data class NoahGetPayoutQuoteRequest(val channelId: String, val cryptoCurrency: String, val fiatAmount: String? = null, val cryptoAmount: String? = null, val quoted: Boolean? = null, val form: Map<String, Any>? = null, val fiatCurrency: String? = null, val paymentMethodId: String? = null, val formSessionId: String? = null, val businessFee: NoahBusinessFee? = null)

Request body for POST /api/v3/clients/me/integrations/noah/payouts/quote.

Exactly one of fiatAmount or cryptoAmount is set. Prefer the withFiatAmount / withCryptoAmount factory helpers so invalid states (both or neither) cannot be constructed. The primary constructor also enforces this at runtime.

Parameters

channelId

The channel id returned by NoahGetPayoutChannelsResponse.

cryptoCurrency

Crypto asset symbol funding the payout.

fiatAmount

Fiat amount the user expects to receive. Mutually exclusive with cryptoAmount.

cryptoAmount

Crypto amount to sell. Mutually exclusive with fiatAmount.

quoted

Request a signed, rate-locked quote. Required to later submit a NoahQuotedOnchainDepositSourceTriggerInput payout.

form

Optional form payload satisfying the schema returned by NoahGetPayoutChannelFormResponse.

fiatCurrency

Optional ISO-4217 fiat currency override.

paymentMethodId

Optional saved payment method id to settle the payout to.

formSessionId

Optional existing form session to continue (reuses a prepared payout intent for multi-step forms).

businessFee

Optional business (partner) fee. Forwarded to Noah as BusinessFee.

Constructors

NoahGetPayoutQuoteRequest

constructor(channelId: String, cryptoCurrency: String, fiatAmount: String? = null, cryptoAmount: String? = null, quoted: Boolean? = null, form: Map<String, Any>? = null, fiatCurrency: String? = null, paymentMethodId: String? = null, formSessionId: String? = null, businessFee: NoahBusinessFee? = null)