创建支付票据
通过向 币趣支付 发送 HTTP POST 消息并在请求正文中传递票据详细信息来创建票据。
提交地址:https://openapi.basicex.com/v2/invoices
请求方式:POST
Content-Type:
application/json
成功创建后,票据详细信息将在 JSON
编码响应中提供。
如果出现错误,您将收到 JSON
编码的错误响应。所有错误响应都会有一个错误字段,该字段是一个具有两个字段(称为类型和消息)的对象。请参照:错误代码
必填POST字段
orderId
商户侧内部订单编号,该订单编号在同一商户内唯一,用于将支付票据与商户订单ID进行关联。
amount
金额字段,采用整数格式。即:如果用户支付2.00
,则需传入200
。
该字段将根据amountType
字段判断传入的是法币还是加密货币金额。 |
percision
金额精度,与amountType
结合,当传入coin_amount
(加密货币)时,推荐精度2-6位,money_price
(法币)时精度为2。
amountType
金额类型字段,表示传入的amount
是法币还是加密货币金额。
coin_amount
加密货币金额 money_price
法币金额
description
商品描述字段,将展示在收银台页面商品详情
notificationUrl
用于向商户指定地址推送Webhook通知的网址,必须为HTTPS
可选字段
buyerId
商户侧客户识别编号,用于支付该票据的商户侧客户ID
fiat
ISO 4217 3位字符的法币代码,将在收银台或其他位置展示价格字段;或根据此法币进行折算对应的币种金额
currency
加密货币币种,例如: USDT, BTC等 查看币种列表,当该参数传入时,则此票据只能支付此币种
forcedChain
强制选择指定公链,例如: TRC20, ERC20等 查看公链列表,当该参数传入时,用户只能在指定公链下进行支付,且不可使用币趣钱包支付
metadata
传入的结构化元数据,用于商户本身记录相应的数据。该字段将在后续原样返回
payerEmail
商户侧的客户邮箱,如传入,则在票据支付成功后向该邮箱发送邮件
redirectUrl
用于用户在收银台支付成功后,跳转到此地址。该地址必须以https
或http
开头
buyerIp
商户侧客户的IP地址
sendPaidNotification
是否发送己支付状态的通知数据。
默认为false
,如设置为true
,则币趣将在区块链上收到用户转账款项且己有一个块确认后,发送paid
状态通知
基于区块链特性,这并不意味该笔订单完全有效,币趣将在确认该交易成功且不可逆后,再次发送complete
状态通知,paid
状态转complete
状态可能需要一些时间。
physical
是否为实物商品,默认为false
,如为实物商品时为true
币趣支付服务器响应
对创建票据请求的响应和对获取票据请求的响应都是票据对象的相同 JSON 表示形式。
通过REST API参考查看完整的资源描述以获取更多信息。