Portal Android SDK

Portal Android SDK/io.portalhq.android.api/NoahApi

NoahApi

class NoahApi(host: String, apiKey: String, requests: PortalRequests)

API class for the Noah on/off-ramp integration.

Wraps the api/v3/clients/me/integrations/noah endpoint family. Each suspend fun builds the URL, JSON-encodes the request body via Gson, calls the underlying PortalRequests transport, and decodes the response into the matching NoahXxxResponse data class. Transport failures surface in the returned Result as thrown by PortalRequests:

HTTP 400 → io.portalhq.android.exceptions.PortalException.Api.HttpBadRequest
HTTP 401 → io.portalhq.android.exceptions.PortalException.Api.HttpUnauthorized
other 4xx/5xx → io.portalhq.android.exceptions.PortalException.Api.HttpRequestFailed
network/IO failures → raw java.io.IOException

Parameters

host

The base URL of the API server (e.g. "https://api.portalhq.io").

apiKey

The API key used for authentication (sent as a bearer token).

requests

An instance of PortalRequests to handle HTTP requests.

Constructors

constructor(host: String, apiKey: String, requests: PortalRequests)

Functions

getPaymentMethods

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

Retrieves the saved payment methods available to the current customer 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 available given a country / currency / amount tuple.

getPayoutCountries

suspend fun getPayoutCountries(): Result<NoahGetPayoutCountriesResponse>

Retrieves the list of supported payout countries (and supported fiat currencies per country).

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 the user should fund.

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

Initiates a payout and returns the on-chain trigger conditions the resulting transaction must satisfy.

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

Simulates a fiat deposit landing for a payin in sandbox / test environments.