Appearance
代收业务代码
订单状态代码说明
| 取值 | 说明 | 可能的原因 |
|---|---|---|
| ACCEPT | 已提交 | 订单已创建，此状态不代表业务成功或失败 |
| PENDING | 处理中 | 订单等待付款，此状态不代表业务成功或失败 |
| SUCCESS | 成功 | 业务成功 |
| FAIL | 失败 | 业务失败 |
| PARTIAL | 部分付款 | 部分付款 |
| REFUND | 退款 | 退款 |
接口详情
🎉 获取支付信息 API （V1）
INFO
用途: 用于获取收银台链接
请求URL: /payin/v1
请求方式: POST
请求参数
| 参数 | 必选 | 类型 | 说明 | 示例 |
|---|---|---|---|---|
| clientId | 是 | String | 商户订单号 | 2371666556 |
| currency | 是 | String | 国家 | 固定值填写 |
| amount | 是 | Number | 订单金额 | 100 |
| directly | 是 | Boolean | 固定值填写true | true |
| returnUrl | 否 | String | 支付后的重定向跳转页面 | url |
| callbackUrl | 是 | String | 支付后的通知回调地址 | url |
| phone | 是 | String | 付款用户手机号（填写真实数据），格式：09开头，总长度11位 | 09123654758 |
| name | 是 | String | 用户姓名（填写真实数据），格式：不要包含数字 | John |
| 是 | String | 用户邮箱，按照邮箱格式传入 | xxx@gmail.com | |
| payMethods | 是 | String | 支付方式，参考下方的代收方式编码，只能传入一个(根据实时变化可能存在支付方式维护情况，当前可用支付方式请与我方人员确认) | 301001 |
请求示例
json
{
"clientId": "eijVqVUIqG",
"currency": "PHP",
"amount": 292,
"name": "TvxvlMep",
"phone": "13977877216",
"email": "rydkjv.pc217@yahoo.com.cn",
"returnUrl": "https://babyish-sand.net",
"callbackUrl": "https://separate-violin.org",
"directly": true,
"payMethods": "301001"
}响应参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| clientId | String | 商户订单号 | 2371666556 |
| orderId | String | 平台订单号 | CI123891203982 |
| amount | Number | 订单金额，保留2位小数 | 100.00 |
| currency | String | 货币 | PHP |
| resource | String | 代收链接 | https://xxx.yoyipayment.com/CI123891203982?payMethodNo=301001 |
| type | String | 支付信息类型，固定值：PAYMENT_VALUE、PAYMENT_LINK | PAYMENT_LINK |
DANGER
注意：
PAYMENT_LINK：可直接打开resource返回的链接进行支付操作
PAYMENT_VALUE：一般需自行处理resource中的数据
响应信息
json
{
"orderId": "CI123891203982",
"clientId": "2371666556",
"amount": 100.00,
"currency": "PHP",
"resource": "https://xxx.yoyipayment.com/CI123891203982?payMethodNo=301001",
"type": "PAYMENT_LINK"
}代收方式编码
| 编码 | 名称 |
|---|---|
| 301001 | QRPH |
| 301003 | QRPH_WAKEN |
| 302001 | GCASH |
| 302002 | MAYA |
| 302003 | GRABPAY |
支付通知 API
INFO
用途：用于支付完成后接收通知
请求URL：商户在接口传入的callbackUrl
请求方式：POST
DANGER
注意：
接收异步通知后，需响应 SUCCESS 字符串，不包含引号，不是 JSON 格式
平台发送参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| clientId | String | 商户订单号 | 2371666556 |
| orderId | String | 平台订单号 | CI123891203982 |
| transactionId | String | 交易订单号 | 1234567890 |
| status | String | 订单状态 | SUCCESS |
| amount | Number | 订单金额，保留2位小数 | 100.00 |
| paidAmount | Number | 实付金额，保留2位小数 | 100.00 |
| serviceFee | Number | 手续费，保留2位小数（若有值） | 10.00 |
| payMethod | String | 支付方式 | 301001 |
| sign | String | 签名 | 5f4dcc3b5aa765d61d8327deb882cf99 |
发送给商户的数据示例
json
{
"clientId": "2371666556",
"orderId": "CI123891203982",
"transactionId": "1234567890",
"amount": 100.00,
"paidAmount": 100.00,
"currency": "PHP",
"status": "SUCCESS",
"serviceFee": 10.00,
"payMethod": "301001",
"sign": "5f4dcc3b5aa765d61d8327deb882cf99"
}订单状态查询 API
INFO
用途：通过商户订单号查询订单状态
请求URL：/payin/{currency}/merchant/{clientId}/status
请求方式：GET
请求参数
| 参数 | 必选 | 类型 | 说明 | 示例 |
|---|---|---|---|---|
| currency | 是 | String | 固定值INR | PHP |
| clientId | 是 | String | 商户订单号 | 2371666556 |
响应参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| clientId | int | 商户订单号 | 2371666556 |
| orderId | String | 平台订单号 | CI123891203982 |
| status | String | 订单状态 | PENDING |
| amount | String | 订单金额，保留2位小数 | 100.00 |
| paidAmount | Number | 实付金额，保留2位小数 | 0.00 |
| serviceFee | Number | 手续费，保留2位小数（若有值） | null |
| currency | String | 货币 | PHP |
| createTime | String | 创建时间 | 2025-01-05 15:36:37 |
| completeTime | String | 完成时间 | null |
| payMethod | String | 支付方式 | 301001 |
响应示例
json
{
"clientId": "2371666556",
"orderId": "CI123891203982",
"amount": 100.00,
"paidAmount": 0.00,
"currency": "PHP",
"status": "PENDING",
"createTime": "2025-01-05 15:36:37",
"completeTime": null,
"serviceFee": null,
"payMethod": "301001"
}