# 订单列表查询接口

通过该接口，查询完结时间在一定范围内的订单列表。接口正常将返回一个包含 [`orderList`](#orderlist) 的 `data`

on-ramp订单仅返回“已完结”订单（orderStatus=3），即链上交易已确认、用户已收到加密货币的订单

NFT订单已支付、已结算状态会触发通知

## 订单列表查询接口

<mark style="color:blue;">`GET`</mark> `https://api.ramp.fatpay.xyz/open/api/onramp/order`

基于订单起止时间和订单类型查询订单列表

#### Query Parameters

| Name                                        | Type    | Description                                    |
| ------------------------------------------- | ------- | ---------------------------------------------- |
| startTime<mark style="color:red;">\*</mark> | Long    | <p>订单完结时间。Unixime 时间戳，秒<br>e.g. 1661346861</p> |
| endTime<mark style="color:red;">\*</mark>   | Long    | <p>订单完结时间。Unixime 时间戳，秒<br>e.g. 1661346861</p> |
| page                                        | Integer | 分页号，默认 1                                       |
| size                                        | Integer | 每页条数，默认20                                      |
| buyType                                     | String  | <p>buyType=nft：返回NFT订单<br>不传则返回on-ramp订单</p>   |

#### Headers

| Name                                              | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                                |
| ------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Content-Type<mark style="color:red;">\*</mark>    | String  | application/json                                                                                                                                                                                                                                                                                                                                                                                           |
| X-Fp-Version<mark style="color:red;">\*</mark>    | String  | <p>FaTPay API 接口版本<br>e.g. v1.0</p>                                                                                                                                                                                                                                                                                                                                                                        |
| X-Fp-Timestamp<mark style="color:red;">\*</mark>  | Integer | <p>Unixtime 时间戳，秒<br>e.g. 1661346861</p>                                                                                                                                                                                                                                                                                                                                                                   |
| X-Fp-Nonce<mark style="color:red;">\*</mark>      | Integer | <p>6位随机正整数<br>e.g. 868964</p>                                                                                                                                                                                                                                                                                                                                                                              |
| X-Fp-Partner-Id<mark style="color:red;">\*</mark> | String  | <p>申请高级合作伙伴时，由 FaTPay 分配的 partner ID<br>e.g. 2yQrS9A0xmM8xpfa</p>                                                                                                                                                                                                                                                                                                                                          |
| X-Fp-Signature<mark style="color:red;">\*</mark>  | String  | <p>由 <code>APIPrivateKey</code> 生成的签名<br>e.g. zbBQ+1nv/5up9riH1wbTSSMmkb26LQj3g1cNWsutOordOrtpk8agcA5D5bdYaGeVlHK0qZ2MlUV+ZfOK9cXMuficeIm5fnEjMEm7s1IZtSivMt5te7EFqe52dtVFafE4hUgwqH6QBZB0yZ1FSqHs2dOCI0e8RKJQBDitxtHkibStl1Jt5wulzzq96qWbbVnwoBqGDT52OtwwEcDqMI4SIAzUAdBhAuLqUig1U4Ne9ufT8B1aAohEk5fvn/Sbom21bEjLdgbt5PwH2wmmuBx4tq31IgcP4V+qEBILY2eMAFzkvxNXaX3PsLbj9NpgyIc3HQl0FtRq3gdN7FsSvyvcWA==</p> |

{% tabs %}
{% tab title="200: OK 正常返回" %}

```javascript
{
    "code": 10000,
    "msg": "Success",
    "data":
    {
        "page": 1,
        "size": 20,
        "totalCount": 2,
        "list": [
        {
            "orderId": "jIdvChO85Bw.",
            "orderStatus": 3,
            "userId": "test-4Q4-zf4mDKh7h3FNXPFNaA..",
            "payTime": 1661177568,
            "deliverTime": 1661177536,
            "finishTime": 1661177536,
            "fiatCurrency": "USD",
            "currencyAmount": 100,
            "cryptoCurrency": "USDC",
            "cryptoCurrencyCode": "USDC_Polygon",
            "cryptoCurrencyAmount": 93.09000000,
            "cryptoCurrencyUnitPrice": 1.03,
            "walletAddress": "0x9a078d5109a9268cE307884e825576520733e2FE",
            "walletAddressTag": "88888888",
            "gasFee": 0.01,
            "gasFeeUnit": "USDC",
            "platformFee": 5.00,
            "platformFeeUnit": "USDC",
            "totalFee": 5.01,
            "totalFeeUnit": "USDC",
            "payment": "CREDIT_DEBIT_CARD",
            "txHash": "0x777fb52e7f77d14f7d6d51eefa90c4c2f03d0b6d21e51dcc4c056baedf5f7e4e",
            "network": "polygon_mumbai",
            "blockchainExplorer": "https://mumbai.polygonscan.com/tx/"
        },
        {
            "orderId": "s0cec3BQ8i4.",
            "orderStatus": 3,
            "nftDetails": [
                {
                    "externalCustomerId": "123333",
                    "tokenId": "",
                    "nftNetwork": "ethereum",
                    "transferWalletAddress": "0x0B4DF75c947e225b459B949F1625AcAb171053c4",
                    "merchantUniqueId": "112233",
                    "contractAddress": "0xe785E82358879F061BC3dcAC6f0444462D4b5330",
                    "mintQuantity": 2,
                    "type": "MINT",
                    "merchantOrderNo": "123321"
                    }
            "userId": "test-4Q4-zf4mDKh7h3FNXPFNaA..",
            "payTime": 1661163885,
            "deliverTime": 1661163847,
            "finishTime": 1661163847,
            "fiatCurrency": "USD",
            "currencyAmount": 10,
            "cryptoCurrency": "USDC",
            "cryptoCurrencyCode": "USDC_Polygon",
            "cryptoCurrencyAmount": 9.30000000,
            "cryptoCurrencyUnitPrice": 1.03,
            "walletAddress": "0x9a078d5109a9268cE307884e825576520733e2FE",
            "gasFee": 0.01,
            "gasFeeUnit": "USDC",
            "platformFee": 0.50,
            "platformFeeUnit": "USDC",
            "totalFee": 0.51,
            "totalFeeUnit": "USDC",
            "payment": "CREDIT_DEBIT_CARD",
            "txHash": "0x93da31ee10015ecf3c0dee4a5fa1c74a7a2e02f88ec71f60317c2055f80f3d3c",
            "network": "polygon_mumbai",
            "blockchainExplorer": "https://mumbai.polygonscan.com/tx/",
            "ext": "ext"
        }]
    }
}
```

{% endtab %}
{% endtabs %}

## 返回的对象

### `OrderList`

| 参数名称       | 类型      | 类型 | 参数说明             |
| ---------- | ------- | -- | ---------------- |
| page       | Integer | 是  | 当前页码，如 1         |
| size       | Integer | 是  | 每页条数，如 20        |
| totalCount | Integer | 是  | 总 Item 数         |
| list       | Object  | 是  | 订单列表，`Order` 的数组 |

### `Order`

<table><thead><tr><th width="287">参数名称</th><th width="125">类型</th><th width="122">是否必须</th><th>参数说明</th></tr></thead><tbody><tr><td>orderId</td><td>String</td><td>是</td><td>订单id，如 jIdvChO85Bw.</td></tr><tr><td>orderStatus</td><td>Integer</td><td>是</td><td><p>On-ramp：<br> - 固定值 3，发货完结<br></p><p>NFT Checkout：</p><p> - 1：已支付<br> - 2：结算中<br> - 3：已结算</p></td></tr><tr><td>userId</td><td>String</td><td>是</td><td>FaTPay 用户id，如 test-4Q4-zf4mDKh7h3FNXPFNaA..</td></tr><tr><td>payTime</td><td>String</td><td>是</td><td>订单完成支付时间<br>Unixtime 时间戳，秒<br>e.g. 1661346861</td></tr><tr><td>deliverTime</td><td>String</td><td>是</td><td>订单上链时间<br>Unixtime 时间戳，秒<br>e.g. 1661346861</td></tr><tr><td>finishTime</td><td>String</td><td>是</td><td>链上交易完成时间<br>Unixtime 时间戳，秒<br>e.g. 1661346861</td></tr><tr><td>fiatCurrency</td><td>String</td><td>是</td><td>法币ISO代码：USD、THB</td></tr><tr><td>currencyAmount</td><td>Long</td><td>是</td><td>加密货币数量，最多 2 位小数，如 182</td></tr><tr><td>cryptoCurrency</td><td>String</td><td>是</td><td>加密货币名称，如 USDT</td></tr><tr><td>cryptoCurrencyCode</td><td>String</td><td>是</td><td>加密货币标识码，如 USDT_ERC20</td></tr><tr><td>cryptoCurrencyAmount</td><td>Decimal</td><td>是</td><td>法币金额，最多 2 位小数，如 199</td></tr><tr><td>cryptoCurrencyUnitPrice</td><td>Decimal</td><td>是</td><td>加密货币单价，最多 2 位小数，如 1.03</td></tr><tr><td>walletAddress</td><td>String</td><td>是</td><td>钱包地址，如 0xbe188d6641e8b680743a4815dfa0f6208038960f</td></tr><tr><td>walletAddressTag</td><td>String</td><td>是</td><td>钱包地址附加的Tag/Memo，如888888</td></tr><tr><td>gasFee</td><td>Decimal</td><td>是</td><td>网络手续费，最多 2 位小数，如 1.32</td></tr><tr><td>gasFeeUnit</td><td>String</td><td>是</td><td><p>网络手续费计价单位，如BTC</p><p>2022-10-18后的订单均按照所购加密货币单位来计价，如购买BTC，则gasFee按照BTC单位来收取</p></td></tr><tr><td>platformFee</td><td>Decimal</td><td>是</td><td>平台支付手续费，最多 2 位小数，如 11.94</td></tr><tr><td>platformFeeUnit</td><td>String</td><td>是</td><td>平台手续费计价单位，如USD</td></tr><tr><td>totalFee</td><td>Decimal</td><td>是</td><td>总计支付手续费<br>2022-10-18后的订单，totalFee=platformFee</td></tr><tr><td>totalFeeUnit</td><td>String</td><td>是</td><td>总计手续费计价单位，如USD</td></tr><tr><td>payment</td><td>String</td><td>是</td><td>法币付款方式，见 <a data-mention href="../list-all-fiat-currencies#paymentoption">#paymentoption</a></td></tr><tr><td>txHash</td><td>String</td><td>是</td><td>链上交易号，如 0x93da31ee10015ecf3c0dee4a5fa1c74a7a2e02f88ec71f60317c2055f80f3d3c</td></tr><tr><td>network</td><td>String</td><td>是</td><td>加密货币所在公链，如ethereum_mainnet</td></tr><tr><td>blockchainExplorer</td><td>String</td><td>是</td><td>链上交易查询地址，如 <a href="https://mumbai.polygonscan.com/tx/">https://mumbai.polygonscan.com/tx/</a></td></tr><tr><td>ext</td><td>String</td><td>是</td><td>URL入参提交的ext内容</td></tr></tbody></table>

### `nftDetails`

{% hint style="info" %}
若订单类型为NFT，则会返回NFT信息
{% endhint %}

<table><thead><tr><th width="289">参数名称</th><th width="111">类型</th><th>是否必须</th><th>参数说明</th></tr></thead><tbody><tr><td>contractAddress</td><td>String</td><td>是</td><td>NFT合约地址地址</td></tr><tr><td>nftNetwork</td><td>String</td><td>是</td><td>NFT合约所属公链</td></tr><tr><td>tokenId</td><td>String</td><td>否</td><td>NFT的TokenID</td></tr><tr><td>merchantUniqueId</td><td>String</td><td>否</td><td>URL传入的NFT的唯一标识</td></tr><tr><td>type</td><td>String</td><td>是</td><td>MARKET / MINT</td></tr><tr><td>mintQuantity</td><td>String</td><td>否</td><td>MINT数量</td></tr><tr><td>ownerWalletAddress</td><td>String</td><td>否</td><td>NFT当前持有人钱包地址</td></tr><tr><td>transferWalletAddress</td><td>String</td><td>是</td><td>支付后，NFT转让的钱包地址</td></tr><tr><td>merchantOrderNo</td><td>String</td><td>否</td><td>URL传入的外部商户订单号</td></tr><tr><td>externalCustomerId</td><td>String</td><td>否</td><td>URL传入的外部商户客户ID</td></tr></tbody></table>