悠悠楠杉
彩虹易支付接口文档
一、引言
随着电子商务的快速发展,在线支付已经成为不可或缺的一部分。彩虹易支付作为一款新兴的支付解决方案,旨在为商家提供简单、高效、安全的支付接口。本文将详细介绍如何接入彩虹易支付接口,帮助开发者快速实现支付功能。
二、接口概述
彩虹易支付提供了一系列RESTful风格的API接口,支持多种支付场景,包括网页支付、移动支付、退款等。通过这些接口,开发者可以轻松实现订单的创建、查询、支付和退款等操作。
三、接口功能
创建订单接口
- 功能:生成新的支付订单
- 请求方式:POST
- 请求URL:
https://api.caihongpay.com/createOrder
支付接口
- 功能:用户发起支付
- 请求方式:POST
- 请求URL:
https://api.caihongpay.com/pay
退款接口
- 功能:处理支付订单的退款请求
- 请求方式:POST
- 请求URL:
https://api.caihongpay.com/refund
查询订单接口
- 功能:查询支付订单状态
- 请求方式:GET
- 请求URL:
https://api.caihongpay.com/queryOrder
四、请求参数
4.1 创建订单请求参数
| 参数名 | 类型 | 必填 | 描述 |
|-------------|--------|------|------------------------------|
| orderId | string | 是 | 订单唯一标识 |
| amount | number | 是 | 订单金额 |
| currency | string | 是 | 货币类型,如USD、CNY等 |
| callbackUrl | string | 否 | 支付完成后的回调地址 |
4.2 支付请求参数
| 参数名 | 类型 | 必填 | 描述 |
|-----------|--------|------|-----------------------------|
| orderId | string | 是 | 订单唯一标识 |
| userId | string | 是 | 用户唯一标识 |
| paymentMethod | string | 是 | 支付方式,例如“weixin”、“alipay”等 |
4.3 退款请求参数
| 参数名 | 类型 | 必填 | 描述 |
|-----------|--------|------|------------------------------|
| orderId | string | 是 | 订单唯一标识 |
| amount | number | 是 | 退款金额 |
| reason | string | 否 | 退款原因 |
4.4 查询订单请求参数
| 参数名 | 类型 | 必填 | 描述 |
|-----------|--------|------|-----------------------------|
| orderId | string | 是 | 订单唯一标识 |
五、返回结果
接口调用的返回结果均为JSON格式,结构如下:
json
{
"code": "SUCCESS",
"message": "操作成功",
"data": {
// 返回的数据结构
}
}
5.1 结果字段说明
- code:操作状态码,SUCCESS表示成功,ERROR表示失败。
- message:操作提示信息。
- data:具体的数据内容,根据不同接口返回不同字段。
六、示例
6.1 创建订单示例
json
POST https://api.caihongpay.com/createOrder
{
"orderId": "ORDER123",
"amount": 100.00,
"currency": "CNY",
"callbackUrl": "https://yourdomain.com/callback"
}
6.2 支付示例
json
POST https://api.caihongpay.com/pay
{
"orderId": "ORDER123",
"userId": "USER456",
"paymentMethod": "weixin"
}
6.3 退款示例
json
POST https://api.caihongpay.com/refund
{
"orderId": "ORDER123",
"amount": 100.00,
"reason": "用户申请退款"
}
6.4 查询订单示例
json
GET https://api.caihongpay.com/queryOrder?orderId=ORDER123
七、总结
通过上述介绍,开发者可以了解到如何使用彩虹易支付接口完成各种支付功能的集成。希望本接口文档对您能够顺利接入彩虹易支付有所帮助。若您在使用过程中遇到任何问题,请查阅我们的常见问题解答或联系技术支持。