Loam Customer API · 预览

开发者中心

从此处开始构建 Loam Customer API。

五分钟快速入门从新的 API 客户端到实时响应：生成令牌、读取已结算余额，然后请求外汇报价。启用该功能时包含市场流程。按快速入门指南操作 OpenAPI 3.1 API 参考逐端点阅读已发布合约——包括每个作用域、请求与响应模式以及错误代码，并对每条路由提供请求构建器。打开 API 参考

两条路径都需要凭据。首先创建 API 客户端。

一笔付款，按 API 的写入方式

使用 amount 和 currency 向已批准的目的地付款。写入返回 202，其中包含 { id, state } 和一个 Location。需要 money.write scope、在 step-up authentication 下的 owner grant；在预览环境中该功能仍处于关闭状态。

POST /api/v1/payments

curl -X POST "$LOAM_API_BASE/payments" \  -H "Authorization: Bearer $LOAM_TOKEN" \  -H "Content-Type: application/json" \  -H "Idempotency-Key: $(uuidgen)" \  -d '{    "destination_id": "2f4cbb59-3ab1-4b6d-8d10-9cd2236cf94e",    "amount": 2500000,    "currency": "USD"  }'// Response
HTTP/1.1 202 Accepted
Location: /api/v1/payments/<payment-id>

{
  "ok": true,
  "data": {
    "id": "<payment-id>",
    "state": "processing"
  }
}

API 当前覆盖的内容

预览访问权限刻意比已发布合约更窄。下面的所有内容要么现在可调用，要么标明了它正在等待的授权。

在预览中打开作用域 read 和 write

已结算余额 GET /api/v1/balances
已列出的付款 GET /api/v1/payments
金库条款 GET /api/v1/vaults
外汇报价 POST /api/v1/fx/quotes

在预览中关闭作用域 money.write

支付至已批准的目的地 POST /api/v1/payments
从银行账户的资金流入 POST /api/v1/onramp
向银行账户的资金流出 POST /api/v1/offramp
金库存取款 POST /api/v1/vaults/…

资金移动需要由人类组织所有者在强化认证下授予该作用域、设置每笔交易限额并事先批准目的地。这些端点在预览结束前保持关闭。

API 的行为方式

OAuth 2.0

客户端凭证授权

通过一次表单编码的请求，用客户端 id 和 secret 交换到短期有效的承载令牌。每次请求的作用域从客户端读取，因此缩小某个作用域会立即生效。
信封

每个路由采用统一格式

成功为 ok 然后 data；失败为 ok: false，并带有机器可读的错误代码。
幂等性

重试不产生成本

每次写入都需要一个 Idempotency-Key。相同的键与相同的请求体会重放第一次的结果，而不会写入两次。
分页

游标，而非偏移量

列表路由返回 page.next_cursor。在它返回 null 之前，把它作为 cursor 传回。

从这里选择路径：如果想先得到一个可运行的请求，请使用快速入门；如果你已知道需要的调用，请查看参考文档。

按快速入门指南操作打开 API 参考