检索支付票据
提交地址:https://openapi.basicex.com/v2/invoices/${invoiceId}
请求方式:GET
Content-Type:application/json
请求传参
| 参数 | 类型 | 描述 |
|---|---|---|
| invoiceId | string | 支付票据的 ID,该票据 ID 附加在查询 Path 中进行查询 |
返回参数
币趣支付返回参数,具体取值请根据业务需求
订单请求成功后,响应code为0000
InvoiceObject
支付票据返回参数
| 字段 | 类型 | 描述 |
|---|---|---|
| invoiceId | string | 支付票据订单 ID |
| merOrderId | string | 商户侧内部订单编号 |
| fiat | string | ISO 4217 3 位字符的法币代码 |
| currency | string | 如果支付票据订单限制了支付币种或选择了支付币种,则返回该字段 |
| currencyInfo | CoinInfo | 如果支付票据订单限制了支付网络,或选择了支付网络,则返回该字段 查看详情 |
| forcedChain | string | 如果支付票据订单限制了支付网络,或选择了支付网络,则返回该字段 查看详情 |
| fiatAmount | string | 该支付票据的法币金额 |
| fiatInfo | FiatCurrencyInfo | 法币详细信息 查看详情 |
| description | string | 支付票据订单描述 |
| metadata | map | 传入的结构化元数据,用于商户本身记录相应的数据。该字段将原样返回 |
| payerEmail | string | 商户侧的客户邮箱,如传入,则在票据支付成功后向该邮箱发送邮件 |
| merchantCode | string | 商户编码 |
| merchantName | string | 商户名称 |
| currencies | List | 支持的加密货币币种信息列表 |
| fiatCurrencies | List | 支持的法币货币信息列表 |
| paymentInfo | InvoicePaymentInfo | 支付信息 查看详情 |
| exchangeRate | InvoiceExchangeRate | 汇率信息 |
| type | int | 支付票据订单类型,该订单类型通过异或形式进行读取。 1. FIAT_CURRENCY_EXCHANGE: 表示该支付票据创建为法币汇率折算形式2. FORCE_SELECTED_CHAIN: 表示该支付票据创建为强制选择公链形式,后续不能变更币种和支付公链,仅在此链下进行支付3. FORCE_SELECTED_COIN: 表示该支付票据创建为强制选择币种形式,后续不能变更币种,仅支持支付此币种 |
| status | string | 支付票据的当前状态(created: 表示该支付票据创建未支付, completed: 表示该支付票据已支付并完成, expired: 表示该支付票据已过期) |
| invoiceTime | long | 支付票据的创建时间戳(13 位) |
| expirationTime | long | 支付票据的过期时间戳(13 位) |
| cashierUrl | string | 该支付票据对应的币趣收银台订单网址,可用于再次支付该笔未完成的订单,以避免用户多次提交未支付订单 |
CoinInfo
币种信息
| 字段 | 类型 | 描述 |
|---|---|---|
| currency | string | 币种名称 |
| fullName | string | 币种全称 |
| coinIcon | string | 币种图标 |
| precision | string | 币种精度 |
| networkList | string | 币种支持的公链列表信息 |
CoinChainInfo
公链信息
| 字段 | 类型 | 描述 |
|---|---|---|
| network | string | 公链网络名称 |
| fullName | string | 公链网络全称 |
| contractAddress | string | 合约地址 |
FiatCurrencyInfo
法币信息
| 字段 | 类型 | 描述 |
|---|---|---|
| fullName | string | 法币全名 |
| name | string | 法币名称 |
| symbol | string | 币种符号 |
| icon | string | 币种图标 |
InvoicePaymentInfo
票据订单信息
| 字段 | 类型 | 描述 |
|---|---|---|
| allowPayment | string | 是否允许支付,如果为true,表示该支付订单允许支付。如果为false,表示前置条件未满足,例如:订单没有支付金额/没有选择币种/没有选择公链/收款地址已过期等 |
| payeeAddress | string | 接收方地址,用户实际向该地址进行转账完成支付 |
| network | CoinChainInfo | 网络信息 查看详情 |
| totalAmount | string | 用户总计需要支付的金额 |
| paidAmount | string | 用户已支付的金额 |
| payeeAddressExpireTime | int | 收款地址过期时间,单位毫秒,需要在过期时间前完成支付或者重新获取收款地址 |