Skip to content

代收业务代码

订单状态代码说明

取值说明可能的原因
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)* (一般用于想要自行封装收银台或支付信息)*

请求参数

参数必选类型说明示例
clientIdString商户订单号123456789
currencyString国家固定值填写IDR
amountNumber订单金额20000
directlyBoolean固定值truetrue
returnUrlString支付后的重定向跳转页面http://yourdomain.com/return_url
callbackUrlString支付后的通知回调地址http://yourdomain.com/callback_url
phoneString用户手机号,格式:08开头,总长度11位~12位09123654758
nameString用户姓名,不要包含数字John
emailString用户邮箱,按照邮箱格式传入John080@gmail.com
payMethodsString支付方式,(根据实时变化可能存在支付方式维护情况,当前可用支付方式请与我方人员确认)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"
}

响应参数

参数类型说明示例
clientIdString商户订单号2371666556
orderIdString平台订单号CI123891203982
amountNumber订单金额,保留2位小数20000.00
currencyString货币IDR
resourceString支付信息,根据支付方式可能是link、VA、QR信息https://xxx.gsxpay.net/link/CI123891203982
typeString支付信息类型,固定值:PAYMENT_VALUE、PAYMENT_LINKPAYMENT_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"
}

代收方式编码

编码名称
201002MANDIRI
201003BSI
201004BRI
201005BNI
201006PERMATA
201007CIMB
201008DANAMON
202001OVO
202002DANA
202003SHOPEEPAY
202004LINKAJA
203001QRIS

回调通知 API

INFO

用途:用于支付完成后接收通知

请求URL:商户在接口传入的callbackUrl

请求方式:POST

DANGER

注意:

接收异步通知后,需响应 SUCCESS 字符串,不包含引号,不是 JSON 格式

平台发送参数

参数类型说明示例
clientIdString商户订单号2371666556
orderIdString平台订单号CI123891203982
transactionIdString交易订单号1234567890
statusString订单状态SUCCESS
amountNumber订单金额,保留2位小数20000.00
paidAmountNumber实付金额,保留2位小数20000.00
serviceFeeNumber手续费,保留2位小数(若有值)600.00
payMethodString支付方式203001
signString签名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

请求参数

参数必选类型说明示例
currencyString固定值IDRIDR
clientIdString商户订单号2371666556

响应参数

参数类型说明示例
clientIdint商户订单号2371666556
orderIdString平台订单号CI123891203982
statusString订单状态PENDING
amountString订单金额,保留2位小数20000.00
paidAmountNumber实付金额,保留2位小数0.00
serviceFeeNumber手续费,保留2位小数(若有值)null
currencyString货币IDR
createTimeString创建时间2025-01-05 15:36:37
completeTimeString完成时间null
payMethodString支付方式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"
}