Skip to content

创建支付票据

提交地址:https://openapi.basicex.com/v2/invoices

请求方式:POST

Content-Type:application/json

请求传参

参数是否必填类型描述
buyerIdstring商户侧客户识别编号,用于支付该票据的商户侧客户 ID
orderIdstring商户侧内部订单编号,该订单编号在同一商户内唯一,用于将支付票据与商户订单 ID 进行关联
fiatstring币趣会根据此法币币种进行折算,转换为对应的所有加密币种对应金额(当前共支持22种加密货币),即客户可任选一加密货币进行支付,商家得到该币种,此字段与currency之间必传一个。
ISO 4217 3 位字符的法币币种代码,支付法币种类:CNY/USD/EUR/HKD/INR/IDR/PHP/THB
currencystring加密货币币种,例如: BCNY(推荐,CNY 1:1),USDT, BTC 等 查看币种列表,当该参数传入时,则此票据只能支付此币种,此字段与fiat之间必传一个
forcedChainstring强制选择指定公链,例如: TRC20, ERC20 等 查看公链列表,当该参数传入时,用户只能在指定公链下进行支付,且不可使用币趣钱包支付
amountdecimal金额字段,与precision精度字段结合,采用整数格式。即:如果precision为2(amount÷10²),用户支付2.00,则需传入200
precisionint金额精度
amountType结合,当传入coin_amount(加密货币)时,推荐精度 2-6 位,money_price(法币金额)时精度为 2。
amountTypestring金额类型字段,表示传入的amount是法币还是加密货币金额。
coin_amount 加密货币金额, money_price 法币金额
descriptionstring商品描述字段,将展示在收银台页面商品详情
metadatajson传入的结构化元数据,用于商户本身记录相应的数据。该字段将在后续原样返回
payerEmailstring商户侧的客户邮箱,如传入,则在票据支付成功后向该邮箱发送邮件
notificationUrlstring用于向商户指定地址推送 Webhook 通知的网址,必须为HTTPS
redirectUrlstring用于用户在收银台支付成功后,跳转到此地址。该地址必须以httpshttp开头
buyerIpstring商户侧客户的 IP 地址
sendPaidNotificationbool是否发送己支付状态的通知数据。
默认为false,如设置为true,则币趣将在区块链上收到用户转账款项且己有一个块确认后,发送paid状态通知
基于区块链特性,这并不意味该笔订单完全有效,币趣将在确认该交易成功且不可逆后,再次发送complete状态通知,paid状态转complete状态可能需要一些时间。
physicalbool是否为实物商品,默认为false,如为实物商品时为true

返回参数

币趣支付返回参数,具体取值请根据业务需求

订单请求成功后,响应code为0000

InvoiceObject

支付票据返回参数

字段类型描述
invoiceIdstring支付票据订单 ID
merOrderIdstring商户侧内部订单编号
fiatstringISO 4217 3 位字符的法币代码
currencystring如果支付票据订单限制了支付币种或选择了支付币种,则返回该字段
currencyInfoCoinInfo如果支付票据订单限制了支付网络,或选择了支付网络,则返回该字段
查看详情
forcedChainstring如果支付票据订单限制了支付网络,或选择了支付网络,则返回该字段
查看详情
fiatAmountstring该支付票据的法币金额
fiatInfoFiatCurrencyInfo法币详细信息
查看详情
descriptionstring支付票据订单描述
metadatamap传入的结构化元数据,用于商户本身记录相应的数据。该字段将原样返回
payerEmailstring商户侧的客户邮箱,如传入,则在票据支付成功后向该邮箱发送邮件
merchantCodestring商户编码
merchantNamestring商户名称
currenciesList支持的加密货币币种信息列表
fiatCurrenciesList支持的法币货币信息列表
paymentInfoInvoicePaymentInfo支付信息
查看详情
exchangeRateInvoiceExchangeRate汇率信息
typeint支付票据订单类型,该订单类型通过异或形式进行读取。
1. FIAT_CURRENCY_EXCHANGE: 表示该支付票据创建为法币汇率折算加密货币形式
2. FORCE_SELECTED_CHAIN: 表示该支付票据创建为强制选择公链形式,后续不能变更币种和支付公链,仅在此链下进行支付
3. FORCE_SELECTED_COIN: 表示该支付票据创建为强制选择加密货币币种形式,后续不能变更币种,仅支持支付此币种
statusstring支付票据的当前状态(created: 表示该支付票据创建未支付, completed: 表示该支付票据已支付并完成, expired: 表示该支付票据已过期)
invoiceTimelong支付票据的创建时间戳(13 位)
expirationTimelong支付票据的过期时间戳(13 位)
cashierUrlstring该支付票据对应的币趣收银台订单网址,可用于再次支付该笔未完成的订单,以避免用户多次提交未支付订单

CoinInfo

币种信息

字段类型描述
currencystring币种名称
fullNamestring币种全称
coinIconstring币种图标
precisionstring币种精度
networkListstring币种支持的公链列表信息

CoinChainInfo

公链信息

字段类型描述
networkstring公链网络名称
fullNamestring公链网络全称
contractAddressstring合约地址

FiatCurrencyInfo

法币信息

字段类型描述
fullNamestring法币全名
namestring法币名称
symbolstring币种符号
iconstring币种图标

InvoicePaymentInfo

票据订单信息

字段类型描述
allowPaymentstring是否允许支付,如果为true,表示该支付订单允许支付。如果为false,表示前置条件未满足,例如:订单没有支付金额/没有选择币种/没有选择公链/收款地址已过期等
payeeAddressstring接收方地址,用户实际向该地址进行转账完成支付
networkCoinChainInfo网络信息
查看详情
totalAmountstring用户总计需要支付的金额
paidAmountstring用户已支付的金额
payeeAddressExpireTimeint收款地址过期时间,单位毫秒,需要在过期时间前完成支付或者重新获取收款地址