Off Ramp自定义参数

介绍

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

需要注意的是,参数列表中必选为 Y 的必须上传,其他所有参数均为可选的。

🚧

关于 email

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

参数说明

参数名必选类型说明
appIdYstringAlchemy Pay 为您分配的唯一标识,您可以在商户后台查看
timestampYstring13 位时间戳
typeYstring固定值:sell
merchantOrderNoYstring商户订单号,Alchemy Pay 将会在 webhook 中携带此参数,可以通过此参数追踪订单信息
signYstring关于 sign 的生成规则,参照此处
fiatNstring用户想要兑换的法币币种,Alchemy Pay 支持的法币币种可以在此查看
如上传fiat字段,用户无改修改法币币种,需与country字段匹配
countryNstring用户银行账户所在的国家
上传fiat字段时必传,需要与 fiat 匹配
cryptoAmountNstring用户希望卖出的数字货币的数量
如果传入,用户将无法修改数字货币数量
传入 cryptoAmount 时,需要同时传入 crypto,否则将没有意义
cryptoNstring用户要卖出的数字货币币种,Alchemy Pay 支持的数字货币币种可以在此查看
如果传入,用户将无法选择其他数字货币
networkNstring用户想要卖出的数字货币网络,建议将 network 和 crypto 一起传入,这样可以准确限制用户卖出的数字货币,网络可以在此查看
如果传入,用户将无法修改网络
crypto 和 network 参数匹配,如果不匹配,传入的参数将不会生效
emailNstring用户使用的邮箱,当您传入此参数时,我们将会将此邮箱默认带入,但用户仍然需要输入邮箱验证码来验证次邮箱。
tokenNstring如果您已验证过您的用户的邮箱,并且希望用户在 Alchemy Pay 的体验中免去邮箱验证环节,您可以传入此参数。
关于 token 的生成规则,参照此处
languageNstring用户打开的 ramp 页面的语言
Spanish: es
Traditional Chinese:zh-HK
English:en-US
Vietnamese:vi
Indonesian:id
eg:language=en-US
showTableNstring如果您希望打开的 ramp 的页面只展示 off ramp 选项,您可以传入此参数showTable=sell
redirectUrlNstring用户用户卖出后跳转的网页页面链接,您可以自定义此页面
callbackUrlNstring用户卖出后,Alchemy Pay 将向此地址通知您支付结果
withdrawUrlNstring如果您希望用户创建订单后前往您的网站提现,您可以传入此参数。您可以在 withdrawUrl 中携带您的订单信息,这样 Alchemy Pay 跳转至此页面时您可以获取订单对应的信息
urlTypeNstring只能传入 app 或 web。这代表用户跳转的 withdrawUrl 的类型
merchantNameNstring商户自定义名称,当商户传入此名称时,订单完成页面的商户名称将按照此参数展示