Portal Android SDK

Portal Android SDK/io.portalhq.android.ramps.noah/Noah

Noah

class Noah(api: NoahApi)

Noah on/off-ramp provider implementation.

This class is the developer-facing facade for the Noah ramps integration. Each method forwards to the matching NoahApi call, preserving the Result<T> envelope so callers can inspect failures without try/catch.

Usage Example

// Initiate KYC
val request = NoahInitiateKycRequest(returnUrl = "https://example.com/kyc-return")
val result = portal.ramps.noah.initiateKyc(request)
result.onSuccess { response ->
    val hostedUrl = response.data.hostedUrl
    // open hostedUrl in a browser
}

Constructors

constructor(api: NoahApi)

Functions

getPaymentMethods

suspend fun getPaymentMethods(request: NoahGetPaymentMethodsRequest = NoahGetPaymentMethodsRequest()): Result<NoahGetPaymentMethodsResponse>

Retrieves the saved payment methods available for payouts.

getPayoutChannelForm

suspend fun getPayoutChannelForm(channelId: String): Result<NoahGetPayoutChannelFormResponse>

Retrieves the input form schema for a specific payout channel.

getPayoutChannels

suspend fun getPayoutChannels(request: NoahGetPayoutChannelsRequest): Result<NoahGetPayoutChannelsResponse>

Retrieves the list of payout channels for a given country / currency / amount tuple.

getPayoutCountries

suspend fun getPayoutCountries(): Result<NoahGetPayoutCountriesResponse>

Retrieves the list of supported payout countries.

suspend fun getPayoutQuote(request: NoahGetPayoutQuoteRequest): Result<NoahGetPayoutQuoteResponse>

Requests a payout quote (price + fees) for a given channel and amount.

suspend fun initiateKyc(request: NoahInitiateKycRequest): Result<NoahInitiateKycResponse>

Initiates a hosted KYC flow for the current customer.

suspend fun initiatePayin(request: NoahInitiatePayinRequest): Result<NoahInitiatePayinResponse>

Initiates a fiat -> crypto payin and returns the bank instructions to fund.

suspend fun initiatePayout(request: NoahInitiatePayoutRequest): Result<NoahInitiatePayoutResponse>

Initiates a payout, returning the on-chain trigger conditions the resulting transaction must satisfy.

suspend fun simulatePayin(request: NoahSimulatePayinRequest): Result<NoahSimulatePayinResponse>

Simulates a fiat deposit for an existing payin (sandbox / test only).