跳转到主要内容
VelaFi REST API 让你能够以编程方式管理法币到加密货币的入金 (On-Ramp)、加密货币到法币的出金 (Off-Ramp)，以及基于稳定币通道的法币到法币全球支付。该 API 遵循 RESTful 规范——每个资源都可以通过 URL 访问，每次交互都使用标准 HTTP 方法，每个响应体都是 JSON。所有通信均通过 HTTPS 进行，并使用标准 HTTP 状态码表示每个请求的结果。

​
基础 URL

请根据你的集成阶段选择相应的环境。开发和测试时请使用沙盒环境，以免转移真实资金。只有在准备正式上线时才切换到生产环境 URL。
沙盒环境和生产环境的凭证不能互换使用。请使用为你所调用环境签发的 API key、API secret 和令牌。

​
请求格式

所有请求体均以 JSON 格式发送，并相应设置 Content-Type 请求头：
每个访问受保护资源的请求还必须在 X-BH-TOKEN 请求头中包含业务令牌。使用你的 API key 和 API secret 对请求签名，通过 GET /v2/token/generate 获取令牌。详情请参见认证页面。 请求示例

​
响应结构

成功的响应会包装在以下 JSON 结构中。错误响应包含 code 和 msg，但不包含 data；参见错误码。
​
number
成功时为 200（少数接口返回 0）。出错时，code 为错误码（除 30012 外均为负数）。它与 HTTP 状态码并不对应：携带错误 code 的响应使用 HTTP 400 或 500。参见错误码。
​
string
概括结果的简短可读信息，例如 "SUCCESS" 或错误描述。
​
object | array | null
接口返回的数据。其结构因接口而异，并在各个参考页面中分别说明。

​
HTTP 状态码

下表列出了 API 返回的 HTTP 状态码。
缺少令牌、令牌无效或已过期时，返回 400 及代码 -1002 或 -1022，而不是 401。超出速率限制时返回 400 及代码 -1006，而不是 429。请始终根据 code 字段进行分支处理。有关所有错误码以及哪些错误码表示结果未知，请参见错误码。

​
速率限制

以下接口设有默认速率限制，按 VelaFi 账户计数，且每个接口单独计算。一分钟的时间窗口从你的第一个请求开始，一分钟后重置。
超出限制的请求会被拒绝，并返回 HTTP 400 及代码 -1006（Execution status unknown.），而不是 429。此外，任何接口在收到过多并发请求时都可能返回代码 30012（HTTP 400）。请在重试前进行退避。对于创建订单的调用，请遵循错误码中“结果未知：重试前先检查”一节的说明，因为 -1006 也用于其他失败情况。
其他接口可能有各自的限制。如果你的业务场景需要更高的吞吐量额度，请联系 VelaFi 支持团队。

​
主要章节

使用下方卡片直接跳转到你需要的资源分组。

商户

配置商户资料、获取商户详情并管理商户级设置。

订单

创建、查询和管理入金、出金以及法币到法币支付订单。

收款人

添加和管理接收付款的银行账户和加密货币钱包。

Webhook

订阅订单状态变更等事件的实时通知。