SDK Reference - On-Ramp

Structs

---

FImmutableOnRampQueryParams

Represents the query parameters for generating an on-ramp URL.

• FString DefaultCryptoCurrency The cryptocurrency to purchase (default: "IMX").
• FString DefaultFiatAmount The amount of fiat currency to spend when purchasing cryptocurrency (default: "50").
• FString DefaultFiatCurrency The fiat currency to use (default: "USD").
• FString CryptoCurrencyList A comma-separated list of available cryptocurrencies for purchase (default: "imx,eth,usdc").

Static Functions

---

UImmutableMarketplaceLinkFactory::GenerateOnRampLink

Generates a URL for the on-ramp flow.

Method parameters

---

EImmutableEnvironmentEnvironmentREQUIRED

Specifies the environment (Sandbox or Production).

FStringEmailREQUIRED

The user's email address, pre-filled in the on-ramp flow.

FStringWalletAddressREQUIRED

The user's wallet address, where tokens will be sent.

const FImmutableOnRampQueryParams&QueryParamsREQUIRED

The query parameters for the on-ramp flow. Uses default values if not specified.

TMap<FString, FString>ExtraQueryParamsREQUIRED

Additional query parameters. See Transak Query Parameters for possible fields.

If ExtraQueryParams includes any fields that are already defined in QueryParams, the values in QueryParams will take precedence.

For example, if ExtraQueryParams contains "defaultFiatAmount", it will be ignored and the value from QueryParams.DefaultFiatAmount will be used instead.

Returns

---

FString

The generated on-ramp URL.