Off Ramp自定义参数

您在网页对接中，可以传入以下参数以减少用户的输入，这将简化用户的操作流程，提升转化率。

需要注意的是，以下参数只有appId是必须的，其他所有参数均为可选的。

示例链接：

appId 参与签名

📘

appId是必须的，您必须传入appId才能使以下参数生效

type 必填

当您在Off Ramp时，此参数必传。

示例：type=sell

merchantOrderNo

您为此订单生成的商户订单号，Alchemy Pay将会在webhook中携带此参数，由此您可以通过此参数追踪订单信息。

country 必填

这代表用户银行账户所在的国家，country需要与fiat匹配，否则将不会生效。

示例：country=US

fiat 参与签名

这代表用户想要兑换的法币币种。如果传入，用户将无法修改法币币种。Alchemy Pay支持的法币币种可以在此查看。

示例：fiat=USD

cryptoAmount 参与签名/必填

这代表用户希望卖出的数字货币的数量。如果传入，用户将无法修改数字货币数量。

当您传入cryptoAmount时，需要同时传入crypto，否则将没有意义。

示例：cryptoAmount=100

crypto 必填

这代表用户要卖出的数字货币币种。如果传入，用户将无法购买其他数字货币。Alchemy Pay支持的数字货币币种可以在此查看。

示例：crypto=USDT

network 必填

这代表用户想要卖出的数字货币网络。建议将network和crypto一起传入，这样可以准确限制用户卖出的数字货币。如果传入，用户将无法修改网络。网络可以在此查看。

crypto和network参数匹配，如果您传入的crypto和network不匹配，您传入的参数将不会生效。

示例：network=ETH

email

这代表用户使用的邮箱，当您传入此参数时，我们将会将此邮箱默认带入，但用户仍然需要输入邮箱验证码来验证次邮箱。

示例：email=[email protected]

token

如果您已验证过您的用户的邮箱，并且希望用户在AlchemyPay的体验中免去邮箱验证环节，您可以传入此参数。

关于token的生成规则，参照此处。

🚧

如果您无法确认用户的邮箱，请不要使用此参数。如果您已经生成token，则在链接中只需要传入token，不需要再传入email。

language

这代表用户打开的ramp页面的语言。

es 西班牙语
zh-HK 繁中
en-US 英语

示例：language=en-US

showTable

如果您希望打开的ramp的页面只展示off ramp选项，您可以传入此参数。

示例：showTable=sell

redirectUrl

这代表用户用户卖出后跳转的网页页面链接，您可以自定义此页面。

callbackUrl 参与签名

用户卖出后，Alchemy Pay将向此地址通知您支付结果。通知的具体内容您可以参照此处。

withdrawUrl 参与签名

如果您希望用户创建订单后前往您的网站提现，您可以传入此参数。您可以在withdrawUrl中携带您的订单信息，这样Alchemy Pay跳转至此页面时您可以获取订单对应的信息。

urlType 参与签名

只能传入app或web。这代表用户跳转的withdrawUrl的类型。

merchantName

商户自定义名称，当商户传入此名称时，订单完成页面的商户名称将按照此参数展示。

sign

当address传入时，此参数必须。其他情况下，不需要传入。

关于sign的生成规则，参照此处。