Specifying parameters

You can specify parameters at the time of access to minimize user input. For example, if you specify a crypto for web access, users will be directed to that cryptocurrency on the MultiExchange website and will not be able to change it. In a special case, if you provide all the required parameters for creating an order during web access configuration—including appId, crypto, network, FiatCurrency, amount, payWayCode, address/merchantUser (either one), and sign—then when a user lands on the MultiExchange website, they will skip the homepage, address confirmation page, and payment method selection page, going directly to the order confirmation page.

Parameters

appId

A unique tag for you. After the contract is signed, you will receive the appId we created for you.

merchantOrder

You can upload your order number to track MultiExchange orders. We will also perform idempotent verification of the order based on this parameter.

crypto

The cryptocurrency the user intends to buy. View the list of supported cryptocurrencies. If the crypto you wish to buy is not on this list, please contact us.

network

Cryptocurrency networks. View the list of supported cryptocurrency networks. Please note that the crypto must match with the network. Otherwise the input will fail.

fiatCurrency

The fiat currency to be paid by the users. View the supported currencies.

amount

Fiat amount to pay.

payWayCode

The payment method preferred by the users. We currently support:
Credit card: CARD
Google Pay: GOOGLE_PAY
Apple Pay: APPLE_PAY

email

The email used by the user. After entering this parameter, we only display it on the user page. The user still needs to obtain a verification code sent to this email to log in. If you wish to cancel the verification code-based login, you need to enter the accessToken parameter.

• Encrypt the email address with encodeURIComponent before passing it in to avoid issues with special characters.

accessToken

You can enter this parameter to enable automatic login. The accessToken must be obtained through OpenAPI and will only be valid for 2 hours. View how to generate it.

Do not use this parameter unless you have confirmed that the user's email is correct.

address

The address where the user wishes to receive the crypto. When this parameter is provided, the user will skip the address confirmation page. This is only allowed for the on-chain mode. View the on-chain mode description.

merchantUser

User's unique tag on the client side. When this parameter is provided, the user will skip the address confirmation page. This is only allowed for the off-chain mode. View the off-chain mode description.

successUrl

The address to which the user will be redirected after completing the payment. If this parameter is not specified, the user will be redirected to the address provided during the integration.

• Encrypt the email address with encodeURIComponent before passing it in to avoid issues with special characters.

failUrl

The address to which the user will be redirected if the payment failed.

• Encrypt the email address with encodeURIComponent before passing it in to avoid issues with special characters.

callbackUrl

Webhook push address. If this parameter is not specified, MultiExchange will push to the address provided during the process of your integration.

• Encrypt the email address with encodeURIComponent before passing it in to avoid issues with special characters.

useBorder

Either "True" or "False". Will be "True" by default.
This indicates whether you wish to use MultiexcPay's border style. Users are also allowed to utilize customized border.

locale

The default language parameters. View supported languages.

sign

This is mandatory when either address or merchantUser is not empty. Passing sign verification is required for the address or merchantUser to be considered valid. View how to generate sign.