Appearance
代收业务代码
订单状态代码说明
| 取值 | 说明 | 可能的原因 |
|---|---|---|
| ACCEPT | 已提交 | 订单已创建,此状态不代表业务 成功或失败 |
| PENDING | 处理中 | 订单等待付款,此状态不代表业务成功或失败 |
| SUCCESS | 成功 | 业务成功 |
| FAIL | 失败 | 业务失败 |
| REFUND | 退款 | 退款 |
接口详情
🎉 获取支付信息 API (V1)
INFO
用途: 用于获取收银台链接或支付数据
请求URL: /payin/v1
请求方式: POST
WARNING
变更内容:
"directly"参数,从原先的只接受 true 变更为 false | true
"payMethods"参数,从原先的只接受 单个支付方式编码 变更为 单个 | 多个 | 不传
IMPORTANT
- directly: false + payMethods 传单个,返回的数据中,resource 是 gspay的收银台,打开后直接是付款信息 * (优先使用 gspay的收银台,推荐使用此种传值 ✅ ✅ ✅ )*
- directly: false + payMethods(不传 | 多个), 返回的数据中,resource 是 gspay的收银台,可以在收银台页面上进行支付方式的选择 (一般用于不明确支付方式时使用)
- directly: true + payMethods(必传单个支付方式), resource 就是支付相关的信息(VA号,QRString,QRCode)* (一般用于想要自行封装收银台或支付信息)*
请求参数
| 参数 | 必选 | 类型 | 说明 | 示例 |
|---|---|---|---|---|
| clientId | 是 | String | 商户订单号 | 123456789 |
| currency | 是 | String | 国家 | 固定值填写IDR |
| amount | 是 | Number | 订单金额 | 20000 |
| directly | 是 | Boolean | 固定值true | true |
| returnUrl | 否 | String | 支付后的重定向跳转页面 | http://yourdomain.com/return_url |
| callbackUrl | 是 | String | 支付后的通知回调地址 | http://yourdomain.com/callback_url |
| phone | 是 | String | 用户手机号,格式:08开头,总长度11位~12位 | 09123654758 |
| name | 是 | String | 用户姓名,不要包含数字 | John |
| 是 | String | 用户邮箱,按照邮箱格式传入 | John080@gmail.com | |
| payMethods | 是 | String | 支付方式,(根据实时变化可能存在支付方式维护情况,当前可用支付方式请与我方人员确认) | 203001 |
请求示例
json
{
"clientId": "2371666556",
"currency": "IDR",
"amount": 20000,
"directly": true,
"payMethods": "203001",
"name": "AAujaA",
"phone": "08123654758",
"email": "k5mit6_oxt@gmail.com",
"returnUrl": "https://return_url.com",
"callbackUrl": "https://callback_url.com"
}响应参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| clientId | String | 商户订单号 | 2371666556 |
| orderId | String | 平台订单号 | CI123891203982 |
| amount | Number | 订单金额,保留2位小数 | 20000.00 |
| currency | String | 货币 | IDR |
| resource | String | 支付信息,根据支付方式可能是link、VA、QR信息 | https://xxx.gsxpay.net/link/CI123891203982 |
| type | String | 支付信息类型,固定值:PAYMENT_VALUE、PAYMENT_LINK | PAYMENT_LINK |
DANGER
注意:
PAYMENT_LINK:可直接打开resource返回的链接进行支付操作
PAYMENT_VALUE:一般需自行处理resource中的数据
响应信息
json
{
"orderId": "CI9937403982",
"clientId": "2371666556",
"amount": 20000.00,
"currency": "IDR",
"resource": "https://xxx.gsxpay.net/link/CI123891203982",
"type": "PAYMENT_LINK"
}代收方式编码
| 编码 | 名称 |
|---|---|
| 201002 | MANDIRI |
| 201003 | BSI |
| 201004 | BRI |
| 201005 | BNI |
| 201006 | PERMATA |
| 201007 | CIMB |
| 201008 | DANAMON |
| 202001 | OVO |
| 202002 | DANA |
| 202003 | SHOPEEPAY |
| 202004 | LINKAJA |
| 203001 | QRIS |
回调通知 API
INFO
用途:用于支付完成后接收通知
请求URL:商户在接口传入的callbackUrl
请求方式:POST
DANGER
注意:
接收异步通知后,需响应 SUCCESS 字符串,不包含引号,不是 JSON 格式
平台发送参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| clientId | String | 商户订单号 | 2371666556 |
| orderId | String | 平台订单号 | CI123891203982 |
| transactionId | String | 交易订单号 | 1234567890 |
| status | String | 订单状态 | SUCCESS |
| amount | Number | 订单金额,保留2位小数 | 20000.00 |
| paidAmount | Number | 实付金额,保留2位小数 | 20000.00 |
| serviceFee | Number | 手续费,保留2位小数(若有值) | 600.00 |
| payMethod | String | 支付方式 | 203001 |
| sign | String | 签名 | 5f4dcc3b5aa765d61d8327deb882cf99 |
发送给商户的数据示例
json
{
"clientId": "2371666556",
"orderId": "CI123891203982",
"transactionId": "1234567890",
"amount": 20000.00,
"paidAmount": 20000.00,
"currency": "IDR",
"status": "SUCCESS",
"serviceFee": 600.00,
"payMethod": "203001",
"sign": "5f4dcc3b5aa765d61d8327deb882cf99"
}订单状态查询 API
INFO
用途:通过商户订单号查询订单状态
请求URL:/payin/{currency}/merchant/{clientId}/status
请求方式:GET
请求参数
| 参数 | 必选 | 类型 | 说明 | 示例 |
|---|---|---|---|---|
| currency | 是 | String | 固定值IDR | IDR |
| clientId | 是 | String | 商户订单号 | 2371666556 |
响应参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| clientId | int | 商户订单号 | 2371666556 |
| orderId | String | 平台订单号 | CI123891203982 |
| status | String | 订单状态 | PENDING |
| amount | String | 订单金额,保留2位小数 | 20000.00 |
| paidAmount | Number | 实付金额,保留2位小数 | 0.00 |
| serviceFee | Number | 手续费,保留2位小数(若有值) | null |
| currency | String | 货币 | IDR |
| createTime | String | 创建时间 | 2025-01-05 15:36:37 |
| completeTime | String | 完成时间 | null |
| payMethod | String | 支付方式 | 203001 |
响应示例
json
{
"clientId": "2371666556",
"orderId": "CI123891203982",
"amount": 20000.00,
"paidAmount": 0.00,
"currency": "IDR",
"status": "PENDING",
"createTime": "2025-01-05 15:36:37",
"completeTime": null,
"serviceFee": null,
"payMethod": "203001"
}