Documentation

Onramps

onramps

Domain types

BridgeFiatCustomerResponse = { has_accepted_terms, provider, status, 2 more... }

The response for getting a native onramp provider customer.

BridgeFiatRejectionReason = { reason }

A rejection reason for a customer KYC verification.

BridgeSandboxFiatCustomerResponse = { has_accepted_terms, provider, status, 2 more... }

The response for getting a native onramp provider customer.

Caip2ChainID = string

A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:1" for Ethereum mainnet, "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).

CreateLinkAuthIntentInput = { email }

Input for creating a Link auth intent to initiate Stripe onramp authentication.

CreateLinkAuthIntentResponse = { data }

The created Link auth intent.

CreateOrUpdateFiatCustomerRequestInput = { has_accepted_terms, provider, kyc_redirect_url }

The request input for creating (or updating) a native onramp provider customer.

CreateStripeOnrampSessionInput = { environment, session, session_id }

Input for creating a Stripe onramp session.

CreateStripeOnrampSessionResponse = { id, session_id, transaction_details }

The created onramp session.

CryptoCurrencyCode = string

Cryptocurrency symbol. Uppercase alphanumeric, 2-10 characters.

ExchangeStripeTokensInput = { auth_intent_id, crypto_customer_id }

Input for exchanging a Link auth intent for OAuth tokens.

ExchangeStripeTokensResponse = { crypto_customer_id }

Confirmation that tokens were exchanged and stored.

FiatAmount = string

A positive decimal amount as a string (e.g. "100", "50.25", "0.001").

FiatCurrencyCode = string

ISO 4217 fiat currency code. Three uppercase ASCII letters.

FiatCustomerResponse =
BridgeFiatCustomerResponse
|
BridgeSandboxFiatCustomerResponse

The response for getting a native onramp provider customer.

FiatOnrampDestination = { address, asset, chain }

Destination cryptocurrency details for a fiat onramp quote request.

FiatOnrampEnvironment = "sandbox" | "production"

Whether to use the sandbox or production environment for fiat onramp.

FiatOnrampProvider = "meld" | "meld-sandbox" | "moonpay" | 5 more...

The fiat onramp provider to use.

FiatOnrampProviderError = { error, provider }

An error from a specific fiat onramp provider when fetching quotes.

FiatOnrampQuote = { payment_method, provider, destination_currency_code, 3 more... }

A single fiat onramp quote from a provider.

FiatOnrampSource = { amount, asset }

Source currency details for a fiat onramp quote request.

FiatOnrampStripeSDKSessionResponse = { network, publishable_key, session_id, 1 more... }

Provider session initialization for embedded SDK providers (Stripe).

FiatOnrampTransactionStatus = "pending" | "processing" | "completed" | 4 more...

Normalized fiat onramp transaction status.

FiatOnrampURLSessionResponse = { session_id, type, url }

Provider session initialization for popup-based providers.

GetFiatCustomerRequestInput = { provider, kyc_redirect_url }

The request input for getting a native onramp provider customer.

GetFiatOnrampQuotesInput = { destination, environment, source }

The request input for getting fiat onramp quotes.

GetFiatOnrampQuotesResponse = { quotes, provider_errors }

The response containing fiat onramp quotes.

GetFiatOnrampTransactionStatusInput = { provider, session_id }

The request input for checking a fiat onramp session status.

GetFiatOnrampTransactionStatusResponse = { raw_status, session_id, status, 1 more... }

The response containing the fiat onramp session status.

GetFiatOnrampURLInput = { destination, payment_method, provider, 3 more... }

The request input for getting a fiat onramp provider session URL.

GetFiatOnrampURLResponse =
FiatOnrampURLSessionResponse
|
FiatOnrampStripeSDKSessionResponse

Provider session initialization — either a hosted URL or embedded SDK config.

GetStripeCryptoCustomerResponse = { data }

Stripe onramp session status and customer verification info.

LinkAuthIntentCreated = { id, status }

Auth intent created. Pass id to authenticate().

LinkAuthIntentNoAccount = { status }

No Link account for this email. Call registerLinkUser() then retry.

ListStripeConsumerWalletsResponse = { data }

List of registered wallets for a crypto customer.

ListStripePaymentTokensResponse = { data }

List of payment tokens for a crypto customer.

OnrampSessionFees = { network_fee_amount, transaction_fee_amount }

Fee breakdown for a Stripe onramp transaction.

OnrampSessionParams = { crypto_customer_id, destination_currency, destination_network, 4 more... }

Parameters for creating a Stripe onramp session.

OnrampSessionTransactionDetails = { destination_amount, destination_currency, destination_network, 3 more... }

Transaction details returned from a Stripe onramp session.

RefreshStripeQuoteResponse = { quote }

Refreshed quote with new expiry.

StripeConsumerWallet = { id, network, wallet_address }

A registered consumer wallet.

StripeCryptoCustomerActive = { crypto_customer_id, status, verifications }

Active onramp session with customer verifications.

StripeCryptoCustomerExpired = { crypto_customer_id, status }

Expired onramp session. Token refresh failed, re-authentication required.

StripeCryptoCustomerNone = { status }

No onramp session. User must authenticate via Link.

StripeOnrampCheckoutResponse = { client_secret, transaction_details }

Checkout confirmation with client secret.

StripeOnrampSessionStatus = "active" | "expired" | "none"

The state of the user's Stripe onramp session.

StripePaymentToken = { id, type }

A saved payment token.

StripeQuote = { expires_at }

A refreshed quote.

StripeTransactionDetails = { last_error }

Transaction details from checkout.

StripeVerification = { name, status }

A verification entry on a CryptoCustomer.