> ## Documentation Index
> Fetch the complete documentation index at: https://docs.velafi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取订单列表

> 每次请求获取一种订单类型的分页订单列表。可按状态和日期范围筛选。支持全部三种订单类型。

使用此端点获取分页订单列表，每次请求仅限一种订单类型 —— `fiat_to_crypto`、`crypto_to_fiat` 或 `fiat_to_fiat`。可通过状态或日期范围筛选来缩小结果范围。结果按 `completedTime` 排序，最新的在前。单币种订单与法币兑法币订单的响应记录结构不同；其结构与单个订单详情端点保持一致。可将其用于对账看板、报表流程，以及主动监控需要处理的订单。

## 端点

```text theme={null}
GET https://api.velafi.com/v2/orders
```

> [!NOTE]
>
> 在沙盒环境中测试时，请使用 `https://api-test.velafi.com/v2/orders`。

## 查询参数

**orderType** `string` *required*

要列出的订单类型。可选值为 `fiat_to_crypto`、`crypto_to_fiat` 或 `fiat_to_fiat`。

**orderStatus** `integer`

按订单状态码筛选。`0`（默认值）返回所有状态。请使用[订单状态](https://docs.velafi.com/cn/docs/order-statuses.md)中列出的状态码。对于 `fiat_to_fiat`，该筛选条件匹配的是存储的状态而非报告的状态：`10`、`11`、`12`、`60` 和 `72` 精确匹配，而 `31`、`41`、`51`、`71` 和 `90` 与报告的 `orderStatus` 不完全对应。请参阅[按状态筛选](https://docs.velafi.com/cn/docs/order-statuses.md#filtering-by-status)。

**startTime** `string`

日期范围筛选的开始时间，以毫秒级 Unix 时间戳表示（例如 `"1700000000000"`）。对于 `fiat_to_crypto` 和 `crypto_to_fiat` 订单，该范围与订单的 `completedTime` 进行匹配；对于 `fiat_to_fiat` 订单，则与其最后更新时间进行匹配。

**endTime** `string`

日期范围筛选的结束时间，以毫秒级 Unix 时间戳表示（例如 `"1800000000000"`）。与 `startTime` 匹配同一时间戳字段。

**currentPage** `integer`

要获取的页码。默认为 `1`。

**pageSize** `integer`

每页记录数。默认为 `10`，最大为 `100`。

## 响应字段

**code** `integer`

响应状态码。`200` 表示成功。

**msg** `string`

可读的响应信息。

**data** `object`

分页结果集。

**data 字段**

**data.currentPage** `integer`

返回的当前页码。

**data.size** `integer`

每页记录数。

**data.total** `integer`

所有页中匹配的订单总数。

**data.record** `array`

订单摘要对象数组。字段因 `orderType` 而异。

**法币兑加密货币 / 加密货币兑法币记录字段**

**orderId** `string`

唯一订单 ID。

**clientId** `string`

您自定义的订单参考 ID。

**merchantId** `integer`

该订单的商户 ID。

**paymentId** `integer`

该订单使用的支付方式 ID。

**country** `string`

该订单的国家名称。

**crypto** `string`

加密货币代码（例如 `"USDT"`）。

**fiat** `string`

法币代码（例如 `"MXN"`）。

**orderType** `string`

订单类型：`fiat_to_crypto` 或 `crypto_to_fiat`。

**orderPrice** `string`

订单创建时的汇率。

**cryptoAmount** `string`

该订单的加密货币金额。

**fiatAmount** `string`

该订单的法币金额。

**fiatFee** `string`

以法币收取的费用。

**orderStatus** `integer`

当前订单状态码。

**hasRefund** `integer`

如果该订单已退款则为 `1`；否则为 `0`。

**createTime** `string`

订单创建时间的 Unix 时间戳（毫秒）。

**completedTime** `string`

订单达到最终状态时的 Unix 时间戳（毫秒）。在此之前，其值等于 `createTime`。

**法币兑法币记录字段**

**orderId** `string`

唯一订单 ID。

**clientId** `string`

您自定义的订单参考 ID。

**onRampMerchantId** `integer`

入金环节的商户 ID。

**onRampPaymentId** `integer`

入金环节的支付方式 ID。

**onRampCountry** `string`

入金环节的国家。

**onRampFiat** `string`

入金环节收取的法币。

**onRampFiatAmount** `string`

入金环节收取的金额。

**onRampFiatFee** `string`

入金环节的费用。

**offRampMerchantId** `integer`

出金环节的商户 ID。

**offRampPaymentId** `integer`

出金环节的收款人支付 ID。

**offRampCountry** `string`

出金环节的国家。

**offRampFiat** `string`

出金环节交付的法币。

**offRampFiatAmount** `string`

出金环节交付的金额。

**offRampFiatFee** `string`

出金环节的费用。

**orderPrice** `string`

订单创建时的跨币种汇率。

**orderStatus** `integer`

当前订单状态码。

**createTime** `string`

订单创建时间的 Unix 时间戳（毫秒）。

**completedTime** `string`

订单完成时间的 Unix 时间戳（毫秒）。

## 示例

> [tab] 法币兑加密货币订单
>
> ```bash theme={null}
> curl -X GET "https://api.velafi.com/v2/orders?orderType=fiat_to_crypto&orderStatus=60&currentPage=1&pageSize=10" \
>   -H "X-BH-TOKEN: YOUR_TOKEN"
> ```
>
> ```json theme={null}
> {
>   "code": 200,
>   "msg": "SUCCESS",
>   "data": {
>     "size": 10,
>     "currentPage": 1,
>     "total": 1,
>     "record": [
>       {
>         "orderId": "493829236956962816",
>         "clientId": "f_c_0250222004",
>         "merchantId": 3,
>         "paymentId": 0,
>         "country": "Mexico",
>         "crypto": "USDT",
>         "fiat": "MXN",
>         "orderType": "fiat_to_crypto",
>         "orderPrice": "21.4104",
>         "cryptoAmount": "5.1376",
>         "fiatAmount": "110",
>         "fiatFee": "0",
>         "orderStatus": 60,
>         "hasRefund": 0,
>         "createTime": "1740214865000",
>         "completedTime": "1740214866000"
>       }
>     ]
>   }
> }
> ```

> [tab] 法币兑法币订单
>
> ```bash theme={null}
> curl -X GET "https://api.velafi.com/v2/orders?orderType=fiat_to_fiat&startTime=1740000000000&endTime=1741000000000&currentPage=1&pageSize=10" \
>   -H "X-BH-TOKEN: YOUR_TOKEN"
> ```
>
> ```json theme={null}
> {
>   "code": 200,
>   "msg": "SUCCESS",
>   "data": {
>     "size": 10,
>     "currentPage": 1,
>     "total": 1,
>     "record": [
>       {
>         "orderId": "494541042692263936",
>         "clientId": "c_f_0250224003",
>         "onRampMerchantId": 3,
>         "onRampPaymentId": 17,
>         "onRampCountry": "Mexico",
>         "onRampFiat": "MXN",
>         "onRampFiatAmount": "110",
>         "onRampFiatFee": "1",
>         "offRampCountry": "Argentina",
>         "offRampMerchantId": 4,
>         "offRampPaymentId": 134,
>         "offRampFiat": "ARS",
>         "offRampFiatAmount": "6156.3",
>         "offRampFiatFee": "1",
>         "orderPrice": "55.9664",
>         "orderStatus": 31,
>         "createTime": "1740384573000",
>         "completedTime": "1740384573000"
>       }
>     ]
>   }
> }
> ```


## Related topics

- [获取订单](https://docs.velafi.com/cn/api-reference/order/retrieve-a-specific-order.md)
- [入金（法币兑加密货币）](https://docs.velafi.com/cn/docs/guides/on-ramp.md)
- [创建入金订单](https://docs.velafi.com/cn/api-reference/order/create-a-fiat-to-crypto-order.md)
- [确认订单](https://docs.velafi.com/cn/api-reference/order/confirm-a-specific-order.md)
- [获取法币列表](https://docs.velafi.com/cn/api-reference/basic-configuration/get-list-of-fiat-currencies.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.