API 接口参考
概述
本文档提供了 Veloraya 支付系统所有 API 接口的详细参考信息，包括接口地址、请求方法、参数说明和响应格式。
基础信息
通用请求头
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| Content-Type | string | Y | application/json |
| MerchantId | string | Y | 商户 ID |
| Timestamp | string | Y | 时间戳（毫秒） |
| Nonce | string | Y | 随机字符串 |
| Signature | string | Y | 请求签名（RSA签名） |
通用响应格式
json
{
"code": 200,
"msg": "SUCCESS",
"data": {}
}支付接口
1. 代收接口（Payin）
- 接口地址：POST /api/ar/payin
- 功能描述：创建代收订单，处理收款业务
- 详细文档：代收接口文档
2. 代付接口（Payout）
- 接口地址：POST /api/ar/payout
- 功能描述：创建代付订单，处理付款业务
- 详细文档：代付接口文档
查询接口
3. 代收查询接口
- 接口地址：POST /api/ar/payin-query
- 功能描述：查询代收订单状态和详情
- 详细文档：代收查询接口文档
4. 代付查询接口
- 接口地址：POST /api/ar/payout-query
- 功能描述：查询代付订单状态和详情
- 详细文档：代付查询接口文档
5. 余额查询接口
- 接口地址：GET /api/balance
- 功能描述：查询商户账户余额
- 详细文档：余额查询接口文档
6. 代付银行查询接口
- 接口地址：GET /api/bank
- 功能描述：查询商户可用的代付银行列表
- 详细文档：代付银行查询接口文档
回调接口
7. 代收回调接口
- 接口地址：商户提供的回调 URL（代收回调地址）
- 功能描述：接收代收订单状态变更通知（订单模式）
- 详细文档：代收回调接口文档
8. 独立CVU入金回调接口
- 接口地址：商户提供的回调 URL（VA入金回调地址，需单独配置）
- 功能描述：接收独立 CVU 模式入金明细通知（含付款人 CUIT、银行流水号）
- 详细文档：独立CVU入金回调接口文档
9. 代付回调接口
- 接口地址：商户提供的回调 URL
- 功能描述：接收代付订单状态变更通知
- 详细文档：代付回调接口文档
签名验证
10. 签名生成
- 算法：RSA (SHA256withRSA)
- 步骤：构建签名内容 → UTF-8 编码 → RSA 签名 → Base64 编码
- 详细文档：签名验证文档
接口分类
按功能分类
| 功能类别 | 接口名称 | 接口地址 | 说明 |
|---|---|---|---|
| 代收业务 | 代收接口 | POST /api/ar/payin | 创建代收订单（订单模式） |
| 代收业务 | 代收查询 | POST /api/ar/payin-query | 查询代收订单 |
| 代付业务 | 代付接口 | POST /api/ar/payout | 创建代付订单 |
| 代付业务 | 代付查询 | POST /api/ar/payout-query | 查询代付订单 |
| 商户通知回调 | 代收回调 | 商户回调 URL | 代收状态通知（订单模式） |
| 商户通知回调 | 独立CVU入金回调 | 商户回调 URL | 独立CVU模式入金明细通知 |
| 商户通知回调 | 代付回调 | 商户回调 URL | 代付状态通知 |
错误处理
错误码分类
| 错误码范围 | 错误类型 | 处理方式 |
|---|---|---|
| 1000-1999 | 系统错误 | 联系技术支持 |
| 2000-2999 | 代收错误 | 检查订单参数 |
| 3000-3999 | 代付错误 | 检查收款人信息 |
| 4000-4999 | 查询错误 | 检查查询参数 |
更多错误码详情请参见 错误码。