跳到主要内容

收款单列表

请求​

curl -X POST https://api.bitsby.app/invoices/list \
  -H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay" \
	-F "startDate=2000-01-01" \
	-F "endDate=2030-01-01" \
	-F "offset=0" \
	-F "limit=10"

请求参数​

参数数据类型说明示例是否必填默认值
invoiceIdUUID收款单 ID，UUID 格式1c48b092-9878-48f5-b441-07a8a48e7b54否
invoiceUidString收款单 ID（面向买家）F7ncQviM1N92否
projectIdUUID项目 ID，UUID 格式1c48b092-9878-48f5-b441-07a8a48e7b54否
startDateString收款单创建的起始日期，Y-m-d 格式2000-01-01否
endDateString收款单创建的结束日期，Y-m-d 格式2030-01-01否
statusString收款单状态。可选值：unpaid、canceled、paid、expiredpaid否
offsetInteger返回的第一条记录的序号0否0
limitInteger希望获取的记录数50否10

响应示例​

{
    "result": "success",
    "data": [
        {
            "id": "59302b02-d1be-4e10-960f-d6ec24bfcaaf",
            "uid": "F7nYgvxM1N92",
            "projectId": "9deea1e2-0c08-41a3-bdc2-a34eada3892d",
            "createDatetime": "2024-02-29 10:49:56",
            "timeToPayDatetime": "2024-02-29 22:49:56",
            "commissionFiatUSD": 1,
            "amountFiatUSD": 100,
            "amountFiat": 100,
            "currencyFiat": "USD",
            "description": null,
            "serviceData": null,
            "views": 0,
            "status": "canceled"
        },
        {
            "id": "f31c61f6-407f-4999-95cf-56477eff06d4",
            "uid": "riUZBnNvd2rX",
            "projectId": "9deea1e2-0c08-41a3-bdc2-a34eada3892d",
            "createDatetime": "2024-02-27 20:57:23",
            "timeToPayDatetime": "2024-02-28 08:57:23",
            "commissionFiatUSD": 0.12,
            "amountFiatUSD": 12,
            "amountFiat": 12,
            "currencyFiat": "USD",
            "description": null,
            "serviceData": "orderId:2444",
            "views": 3,
            "status": "paid",
            "payment": {
                "id": "f986ad8d-2298-473d-982a-efbc817b975d",
                "amount": 12,
                "hash": "f09352627039c088688806821b864895ff237558612d834861621fc026de5f68",
                "transactionDatetime": "2024-02-27 21:05:36"
            },
            "wallet": {
                "id": "47aa71e2-07a0-482e-9172-7114d7376ba0",
                "name": "usdt-tron",
                "blockchain": "tron",
                "cryptocurrency": "usdt",
                "address": "TKbstUwMzLrfTAGL4erYb7gc7ghmHQ9zG7"
            }
        }
    ]
}

响应参数​

参数说明
id收款单 ID，UUID 格式
uid收款单 ID（面向买家）
projectId项目 ID，UUID 格式
createDatetime收款单创建日期和时间 (UTC)
timeToPayDatetime收款单有效期截止的日期和时间 (UTC)。买家须在此时间之前支付收款单
commissionFiatUSD服务费金额，按 amountFiatUSD 金额计算
amountFiatUSD折算成 USD 的收款单金额。创建收款单时按当时汇率由 amountFiat 换算。付款时被实际收到的金额覆盖，按付款时刻的汇率折算成 USD。commissionFiatUSD 中的服务费也随之重算
amountFiat收款单的法币原始金额，不会改变
currencyFiat法币币种
description创建收款单时填写的描述，向买家展示
serviceData创建收款单时填写的服务数据，不向买家展示。用于在商户店铺中识别收款单和付款
views支付页面的浏览次数
status收款单状态
payment付款参数块。收款单已支付时存在
payment.id付款 ID，UUID 格式
payment.amount以加密货币计的付款金额
payment.hash链上交易哈希
payment.transactionDatetime链上交易的日期和时间 (UTC)
wallet收到付款的钱包参数块。收款单已支付时存在
wallet.id钱包 ID，UUID 格式
wallet.name钱包名称
wallet.blockchain加密钱包所在的区块链
wallet.cryptocurrency钱包的加密货币
wallet.address加密钱包地址
最后于 更新