Documentation

Client Auth

client_auth

Domain types

BridgeBrlFiatVirtualAccountDepositInstructions = { account_holder_name, asset, bank_address, 3 more... }

The deposit instructions for a virtual account.

BridgeDestinationAsset = "usdb" | "usdc" | "usdt" | 3 more...
BridgeEurFiatVirtualAccountDepositInstructions = { account_holder_name, asset, bank_address, 4 more... }

The deposit instructions for a virtual account.

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.

BridgeFiatVirtualAccountDepositInstructions =
BridgeUsdFiatVirtualAccountDepositInstructions
|
BridgeEurFiatVirtualAccountDepositInstructions
|
BridgeMxnFiatVirtualAccountDepositInstructions
| 2 more...

The deposit instructions for a virtual account.

BridgeFiatVirtualAccountDestination = { address, asset, chain }
BridgeFiatVirtualAccountRequest = { destination, provider, source }

The request input for creating virtual account.

BridgeFiatVirtualAccountResponse = { deposit_instructions, destination, provider, 1 more... }

The response for creating virtual account.

BridgeFiatVirtualAccountSource = { asset }
BridgeGbpFiatVirtualAccountDepositInstructions = { account_holder_name, account_number, asset, 4 more... }

The deposit instructions for a virtual account.

BridgeMxnFiatVirtualAccountDepositInstructions = { account_holder_name, asset, bank_address, 3 more... }

The deposit instructions for a virtual account.

BridgeOnrampProvider = "bridge" | "bridge-sandbox"

Bridge provider variant — production or sandbox.

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

The response for getting a native onramp provider customer.

BridgeSandboxFiatVirtualAccountRequest = { destination, provider, source }

The request input for creating virtual account.

BridgeSandboxFiatVirtualAccountResponse = { deposit_instructions, destination, provider, 1 more... }

The response for creating virtual account.

BridgeSourceAsset = "usd" | "eur" | "mxn" | 2 more...
BridgeUsdFiatVirtualAccountDepositInstructions = { asset, bank_account_number, bank_address, 5 more... }

The deposit instructions for a virtual account.

Caip2ChainID = string

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

CreateOrUpdateFiatCustomerRequestInput = { has_accepted_terms, provider, kyc_redirect_url }

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

CryptoCurrencyCode = string

Cryptocurrency symbol. Uppercase alphanumeric, 2-10 characters.

CustomOAuthProviderID = string

The ID of a custom OAuth provider, set up for this app. Must start with "custom:".

ExternalOAuthProviderID = "google" | "discord" | "twitter" | 8 more...

The ID of an external OAuth provider.

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" | 1 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.

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

Normalized fiat onramp transaction status.

FiatVirtualAccountRequest =
BridgeFiatVirtualAccountRequest
|
BridgeSandboxFiatVirtualAccountRequest

The request input for creating virtual account.

FiatVirtualAccountResponse =
BridgeFiatVirtualAccountResponse
|
BridgeSandboxFiatVirtualAccountResponse

The response for creating virtual account.

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 = { session_id, url }

The response containing a fiat onramp provider session URL.

OAuthProviderID =
ExternalOAuthProviderID
|
PrivyOAuthProviderID

The ID of an OAuth provider.

OnrampProvider = "bridge" | "bridge-sandbox"

Valid set of onramp providers

PrivyOAuthProviderID = string

The ID of a Privy app as an OAuth provider. Must start with "privy:".