API 参考概览
Pelago REST API 完整参考文档。
基础 URL
| 环境 | URL |
|---|---|
| 生产 | https://api.pelago.tech/v1 |
| 沙盒 | https://api.sandbox.pelago.tech/v1 |
认证
curl https://api.pelago.tech/v1/payments \
-H "Authorization: Bearer pk_live_xxxxx" \
-H "X-Api-Secret: sk_live_xxxxx"
响应格式
所有响应均为 JSON:
{
"id": "pay_abc123",
"object": "payment",
"status": "completed",
...
}
分页
{
"object": "list",
"data": [...],
"hasMore": true,
"totalCount": 100
}
错误
{
"error": {
"type": "invalid_request_error",
"code": "missing_parameter",
"message": "The 'amount' parameter is required"
}
}
接口列表
支付
| 方法 | 端点 | 描述 |
|---|---|---|
POST | /payments | 创建支付 |
GET | /payments/:id | 获取支付 |
GET | /payments | 列出支付 |
POST | /payments/:id/cancel | 取消支付 |
退款
| 方法 | 端点 | 描述 |
|---|---|---|
POST | /refunds | 创建退款 |
GET | /refunds/:id | 获取退款 |
GET | /refunds | 列出退款 |
结算
| 方法 | 端点 | 描述 |
|---|---|---|
GET | /settlements | 列出结算 |
GET | /settlements/:id | 获取结算 |
Webhook
| 方法 | 端点 | 描述 |
|---|---|---|
POST | /webhooks | 创建 Webhook |
GET | /webhooks | 列出 Webhook |
DELETE | /webhooks/:id | 删除 Webhook |
速率限制
| 计划 | 限制 |
|---|---|
| 沙盒 | 100 次/分钟 |
| 入门 | 500 次/分钟 |
| 商业 | 2000 次/分钟 |
详细文档请查看 REST API 参考。