代收业务代码

订单状态代码说明

取值	说明	可能的原因
ACCEPT	已提交	订单已创建，此状态不代表业务成功或失败
PENDING	处理中	通过收银台页面选择支付方式，等待支付渠道响应或者不在工作时间或者需要 T+1 完成等原因，此状态不代表业务成功或失败
SUCCESS	成功	成功
FAIL	失败	失败

接口详情

获取支付链接 API

INFO

用途：用于获取收银台页面或支付页面

请求URL：api/payin/desk

请求方式：POST

DANGER

注意：

只有收银台界面金额以”.”为千位分隔符显示，如 10.000（表示 IDR 10000），后台页面金额均以”,”为千位分隔符显示，如 10,000（表示 IDR 10000）
若 payment_method_types 仅传入一种支付方式，则直接跳转到支付页面，不打开收银台页面。
当用户选择 OVO 支付时，我们会通过付款用户手机号（ewallet_phone）通知用户 OVO APP，用户通过接收付款订单的推送通知进行付款操作。

请求参数

参数	必选	类型	说明	示例
*order*	是	Object
- id	是	String	订单号	123456789
- amount	是	Long	订单金额	10000
- callback	否	String	支付后的重定向跳转页面	http://yourdoma in.com/callback_ success
- return_url	否	String	支付后的通知回调地址	http://yourdoma in.com/return_url
- ewallet_phone	否	String	付款用户手机号	082652222
- customer_name	否	String	付款用户姓名	John
- customer_email	否	String	付款用户邮箱	test@gmail.com
*payment*	否	Object
payment_method_types	是	Array	支付方式，不传即默认所有支付方式，以下为支持的支付方式，可传一个或多个(*根据实时变化可能存在支付方式维护情况，当前可用支付方式请与我方人员确认*) BRI、MANDIRI、 BSI、MAYBANK、BNI、PERMATA、 CIMB、 DANAMON、 OCBC、 HANA、 DANA、 OVO、 SHOPEE PAY、 LINKAJA、 QRIS 卡接支持: VA、QRIS	["DANA","BNI"]

请求示例

json

{
  "order": {
    "id": "9bddcb4114b24aceb49daa506b7b406d",
    "amount": 10000,
    "callback": "http://yourdomain.com/callback_success",
    "return_url": " http://yourdomain.com/return_url",
    "ewallet_phone": "0829322222",
    "customer_name": "John",
    "customer_email": "test@gmail.com"
  },
  "payment": {
    "payment_method_types": [
      "BNI",
      "DANA"
    ]
  }
}

响应参数

参数	类型	说明	示例
*payment*	Object
- url	String	支付链接	http://payment.com/xxxxx
*order*	Object
- id	String	商户订单号	1234567890
- orderId	String	平台订单号	123891203982
- amount	Long	订单金额	10000
- payableAmount	Long	应付金额, 仅卡接商户返回该字段	9999

响应信息

json

{
  "status": 1,
  "message": null,
  "data": {
    "payment": {
      "url": "https://test-merchant.hzpay.net/prex/api/payin/desk/1234568457"
    },
    "order": {
      "amount": 10000,
      "orderId": "12109248012123",
      "id": "123456789"
    }
  }
}

获取 VA NUMBER API

INFO

用途：用于直接获取 VA 支付的 VA 号

请求URL：api/payin/direct

请求方式：POST

请求参数

参数	必选	类型	说明	示例
*order*	是	Object
- id	是	String	订单号	123456789
- amount	是	Long	订单金额	10000
- callback	否	String	支付后的重定向跳转页面	http://yourdoma in.com/callback_ success
- return_url	否	String	支付后的通知回调地址	http://yourdoma in.com/return_url
- ewallet_phone	否	String	付款用户手机号	082652222
- customer_name	否	String	付款用户姓名	John
- customer_email	否	String	付款用户邮箱	test@gmail.com
*payment*	是	Object
payment_method_type	是	String	只支持传一种支付方式，目前支持的支付方式如下 BRI、MANDIRI、 BSI、BNI、PERMATA、 CIMB、 DANAMON、 OCBC 卡接支持: VA	BRI

请求示例

json

{
  "order": {
    "id": "9bddcb4114b24aceb49daa506b7b406d",
    "amount": 10000,
    "callback": "http://yourdomain.com/callback_success",
    "return_url": "http://yourdomain.com/return_url",
    "ewallet_phone": "0829322222",
    "customer_name": "John",
    "customer_email": "test@gmail.com"
  },
  "payment": {
    "payment_method_type": "BRI"
  }
}

响应参数

参数	类型	说明	示例
*payment*	Object
- payment_method_type	String	支付方式	BRI
- va_num	String	VA号	123891203982
- accountName	String	账户名称, 仅卡接商户返回该字段	Asep Bo
- bankName	String	实际支付方式, 仅卡接商户返回该字段	BANK BRI
*order*	Object
- id	String	商户订单号	1234567890
- orderId	String	平台订单号	123891203982
- amount	Long	订单金额	10000
- payableAmount	Long	应付金额, 仅卡接商户返回该字段	9999

响应示例

json

{
  "status": 1,
  "message": null,
  "data": {
    "payment": {
      "payment_method_type": "BRI",
      "va_num": "12309129082"
    },
    "order": {
      "amount": 10000,
      "orderId": "12109248012123",
      "id": "123456789"
    }
  }
}

获取 QRIS 编码 API

INFO

用途：用于直接获取 QRIS 支付的字符串编码

请求URL：api/payin/qris

请求方式：POST

请求参数

参数	必选	类型	说明	示例
*order*	是	Object
- id	是	String	订单号	123456789
- amount	是	Long	订单金额	10000
- callback	否	String	支付后的重定向跳转页面	http://yourdomain.com/callback_success
- return_url	否	String	支付后的通知回调地址	http://yourdomain.com/return_url
- ewallet_phone	否	String	付款用户手机号	082652222
- customer_name	否	String	付款用户姓名	John
- customer_email	否	String	付款用户邮箱	test@gmail.com

请求示例

json

{
  "order": {
    "id": "123456789",
    "amount": 10000,
    "callback": "http://yourdomain.com/callback_success",
    "return_url": " http://yourdomain.com/return_url",
    "ewallet_phone": "0829322222",
    "customer_name": "John",
    "customer_email": "test@gmail.com"
  }
}

响应参数

参数	类型	说明	示例
*payment*	Object
- payment_method_type	String	支付方式	QRIS
- qris_text	String	QRIS 编码	0002012165498794017 ID.CO.DANAMON.0654984816521
*order*	Object
- id	String	商户订单号	1234567890
- orderId	String	平台订单号	123891203982
- amount	Long	订单金额	10000
- payableAmount	Long	应付金额, 仅卡接商户返回该字段	9999

响应示例

json

{
  "status": 1,
  "message": null,
  "data": {
    "payment": {
      "payment_method_type": "QRIS",
      "qris_text ": " 0002012165498794017ID.CO.DANAMON.0654984816521"
    },
    "order": {
      "amount": 10000,
      "orderId": "12109248012123",
      "id": "123456789"
    }
  }
}

支付通知 API

INFO

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

请求URL：商户在接口传入的return_url，或者后台设置的代收回调地址（优先级：接口传入 > 后台配置）

请求方式：POST

DANGER

注意：

接收异步通知后，需响应 SUCCESS 字符串，不包含引号，不是 JSON 格注意式，通知成功后不再通知，最多发起 5 次通知。
若接收到通知，请通过订单状态 SUCCESS/FAIL 判断订单成功/失败。

平台发送参数

参数	类型	说明	示例
status	int	订单状态	1
order	Object
- id	String	商户订单号	1234567890
- status	String	订单状态，状态取值如下： ACCEPT 已提交 SUCCESS 成功 PENDING 处理中 FAIL 失败	SUCCESS
- orderId	String	平台订单号	128372437618
- amount	Long	金额	10000
- fee	Long	手续费	500
- payMethod	String	支付方式	BRI
- receivedAmount	Long	到账金额, 仅卡接商户返回该字段	9999

发送给商户的数据示例

json

{
  "status": 1,
  "data": {
    "order": {
      "id": "9bddcb4114b24aceb49daa506b7b406d",
      //  代表订单状态,
      "status": "SUCCESS",
      "orderId": "128372437618",
      "amount": 10000,
      "fee": 500,
      "payMethod": "BRI"
    }
  }
}

订单状态查询 API

INFO

用途：用于商户查询订单状态

请求URL：api/payin/status

请求方式：POST

请求参数

参数	必选	类型	说明	示例
order	是	Object
- id	是	String	商户订单号	1234567890

请求示例

json

{
  "order": {
    "id": "1234567890"
  }
}

响应参数

参数	类型	说明	示例
status	int	订单状态	1
*order*	Object
- id	String	商户订单号	1234567890
- status	String	订单状态，状态取值如下： ACCEPT 已提交 SUCCESS 成功 PENDING 处理中 FAIL 失败	SUCCESS
- orderId	String	平台订单号	123891203982
- amount	Long	订单金额	10000
- fee	Long	手续费	500
- payMethod	String	支付方式	BRI
- payableAmount	Long	应付金额, 仅卡接商户返回该字段	9999

响应示例

json

{
  "status": 1,
  "data": {
    "order": {
      "id": "1234567890",
      //  代表订单状态, 
      "status": "SUCCESS",
      "orderId": "128372437618",
      "amount": 10000,
      "fee": 500,
      "payMethod": "BRI"
    }
  }
}

余额查询 API

与代付接口文档一致，点击跳转查看余额查询

代收业务代码 ​

订单状态代码说明 ​

接口详情 ​

获取支付链接 API ​

请求参数 ​

请求示例 ​

响应参数 ​

响应信息 ​

获取 VA NUMBER API ​

请求参数 ​

请求示例 ​

响应参数 ​

响应示例 ​

获取 QRIS 编码 API ​

请求参数 ​

请求示例 ​

响应参数 ​

响应示例 ​

支付通知 API ​

平台发送参数 ​

发送给商户的数据示例 ​

订单状态查询 API ​

请求参数 ​

请求示例 ​

响应参数 ​

响应示例 ​

余额查询 API ​

代收业务代码

订单状态代码说明

接口详情

获取支付链接 API

请求参数

请求示例

响应参数

响应信息

获取 VA NUMBER API

请求参数

请求示例

响应参数

响应示例

获取 QRIS 编码 API

请求参数

请求示例

响应参数

响应示例

支付通知 API

平台发送参数

发送给商户的数据示例

订单状态查询 API

请求参数

请求示例

响应参数

响应示例

余额查询 API