代付业务代码
转账业务代码
json
{
"transactionStatus": 10,
"transactionMessage": "SUCCESS"
}状态代码说明
| 代码 | 说明 | 可能的原因 |
|---|---|---|
| 0 | UNKNOWN | 未知 |
| 10 | SUCCESS | 成功 |
| 20 | FAILED | 失败 |
| 40 | TIMEOUT | 调用支付渠道进行处理超时,此状态不代表业务成功还是失败 |
| 50 | PENDING | 业务已受理,等待支付渠道响应或者不在工作时间或者需要T+1完成等原因,此状态不代表业务成功还是失败 |
接口详情
转账到账户 API
INFO
用途:用于银行/钱包账户之间进行转账
请求URL:api/remit/bank/v1
请求方式:POST
WARNING
手续费另计,不在代付金额内扣除
notifyUrl字段说明:
2.1 商户后台已配置代付回调地址,接口中可不传该字段,地址以后台配置为准
2.2 商户后台未配置代付回调地址,则接口需传该字段,地址以接口传参为准
2.3 商户后台已配置代付回调地址,接口也传入该字段,地址以接口传参为准
请求参数
| 参数 | 必选 | 类型 | 说明 | 示例 |
|---|---|---|---|---|
| orderId | 是 | String | 商户订单ID | 202305250001 |
| beneficiary | 是 | Object | ||
| - country | 是 | String | 国家,可填写 ID | ID |
| - firstName | 是 | String | 名字 | Mia |
| - lastName | 是 | String | 姓氏 | Smith |
| - phoneNumber | 是 | String | 电话号码 | 62856123456 |
| beneficiaryAccount | 是 | Object | 受益人账户信息 | |
| - bank | 是 | String | 银行编码,参考银行编码表格 | 014 |
| - city | 是 | String | 受益人账户开户城市,可填写 Jakarta | Jakarta |
| - name | 是 | String | 受益人账户名称 | John Doe |
| - number | 是 | String | 受益人账户号码 | 6790153860 |
| senderAmount | 是 | Long | 支付金额 | 10000 |
| notifyUrl | 否 | String | 回调地址(用于接收订单支付状态的通知地址) | http://test.com |
| beneficiaryCity | 否 | String | 受益人所在城市名称 | Jakarta |
| beneficiaryCountry | 否 | String | 受益人所在国家, 可填写:ID | ID |
| beneficiaryCurrency | 否 | String | 受益人的货币,可填写:IDR | IDR |
| sender | 否 | Object | 若传入 sender 则相关信息为必填 | |
| - country | 否 | String | 所在国家,可填写:ID | ID |
| - firstName | 否 | String | 名字 | Mia |
| - lastName | 否 | String | 姓氏 | Smith |
| - phoneNumber | 否 | String | 电话号码 | 62856123456 |
| - birthDate | 否 | String | 出生日期(YYYY-MM-DD) | 2000-01-01 |
| - personalId | 否 | String | 个人证件号码 | 167101110100001 |
| - personalIdType | 否 | String | 个人证件类型,固定值:KTP(身份证)、PASSPORT(护照) | KTP |
| - personalIdCountry | 否 | String | 个人证件发放国家 | ID |
| senderCountry | 否 | String | 支付人的国家,可填写:ID | ID |
| senderCurrency | 否 | String | 支付人的货币,可填写:IDR | IDR |
请求示例
json
{
"orderId": "202305250001",
"notifyUrl": "http://test.com",
"beneficiary": {
"country": "ID",
"firstName": "FHILEA",
"lastName": "HERMANUS",
"phoneNumber": "628156056051"
},
"beneficiaryAccount": {
"bank": "014",
"city": "Jakarta",
"name": "FHILEA HERMANUS",
"number": "0803944123"
},
"senderAmount": 10000
}响应参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| orderId | String | 商户订单ID | 202305250001 |
| transactionId | String | 平台交易 ID | T230525999999 |
| transactionStatus | Int | 交易状态(见交易状态 代码) | 50 |
| transactionMessage | String | 交易信息(与交易状态 对应的信息) | 处理中 |
| createdTime | String | 订单创建时间,YYYY- mm-DD HH:MM:SS | 2023-05-23 17:27:58 |
| cashInTime | String | 入账时间,YYYY-mm-DD HH:MM:SS | null |
| senderAmount | Long | 支付金额 | 10000 |
| serviceFeeAmount | Long | 手续费 | 5000 |
| beneficiaryName | String | 受益人名字 | FHILEA HERMANUS |
| beneficiaryAccountNumber | String | 受益人账号 | 628156056051 |
| reason | String | 失败原因,有固定值,如下: LOW_BALANCE、INVALID_BENEFICIARY、USER_AMOUNT_EXCEED_LIMIT 若订单失败且该值为空,需根据具体订单联系我方人员核查 |
响应内容
json
{
"status": 1,
"message": "PROCESSING SUCCESS",
"data": {
"orderId": "202305250001",
"transactionId": "T230525999999",
"transactionStatus": 50,
"transactionMessage": "PENDING",
"createdTime": "2023-05-23 17:27:58",
"cashInTime": null,
"senderAmount": 10000,
"serviceFeeAmount": 5000,
"beneficiaryName": "FHILEA HERMANUS",
"beneficiaryAccountNumber": "628156056051",
"reason": ""
}
}TIP
业务是否成功依靠业务状态代码来判断,不是以请求处理状态来判断,后续可以通过“平台交易ID”来查询业务处理状态。
异步回调通知 API
INFO
用途:用于代付完成后平台发送通知给商户
请求URL:商户在后台设置的代付回调地址或者商户接口传入的 notifyUrl
请求方式:POST
WARNING
接收异步通知后,需响应 SUCCESS 字符串,不包含引号,不是 JSON 格式,通知成功后不再通知,最多发起 5 次通知。
平台发送参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| orderId | String | 商户订单ID | 202305250001 |
| transactionId | String | 平台交易 ID | T230525999999 |
| transactionStatus | Int | 交易状态(见交易状态代码) | 10 |
| transactionMessage | String | 交易信息(与交易状态对应的信息) | 成功 |
| createdTime | String | 订单创建时间,YYYY- mm-DD HH:MM:SS | 2023-05-23 17:27:58 |
| cashInTime | String | 入账时间,YYYY-mm-DD HH:MM:SS | 2023-05-23 17:30:58 |
| senderAmount | Long | 支付金额 | 10000 |
| serviceFeeAmount | Long | 手续费 | 5000 |
| beneficiaryName | String | 受益人名字 | FHILEA HERMANUS |
| beneficiaryAccountNumber | String | 受益人账号 | 628156056051 |
| reason | String | 失败原因,有固定值,如下: LOW_BALANCE、INVALID_BENEFICIARY 若订单失败且该值为空,需根据具体订单联系我方人员核查 |
平台发送给商户的数据示例
json
{
"status": 1,
"message": "PROCESSING SUCCESS",
"data": {
"orderId": "202305250001",
"transactionId": "T230525999999",
"transactionStatus": 10,
"transactionMessage": "SUCCESS",
"createdTime": "2023-05-23 17:27:58",
"cashInTime": "2023-05-23 17:30:58",
"senderAmount": 10000,
"serviceFeeAmount": 5000,
"beneficiaryName": "FHILEA HERMANUS",
"beneficiaryAccountNumber": "628156056051",
"reason": ""
}
}交易查询 API
INFO
用途:用于查询指定的交易状态
请求URL:api/remit/query/v1
请求方式:POST
请求参数
| 参数 | 必选 | 类型 | 说明 | 示例 |
|---|---|---|---|---|
| queryId | 是 | String | 查询ID,唯一即可 | 202305260001 |
| orderId | 是 | String | 商户订单ID | 202305250001 |
| transactionId | 否 | String | 平台交易ID,如果未指定则根据商户订单ID查询,同时指定会同时进行校验 | T20230525999 |
请求示例
json
{
"queryId": "202305260001",
"orderId": "202305250001",
"transactionId": "T230525999999"
}响应参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| orderId | String | 商户订单ID | 202305250001 |
| transactionId | String | 平台交易 ID | T230525999999 |
| transactionStatus | Int | 交易状态(见交易状态代码) | 10 |
| transactionMessage | String | 交易信息(与交易状态对应的信息) | 成功 |
| createdTime | String | 订单创建时间,YYYY-mm-DD HH:MM:SS | 2023-05-23 17:27:58 |
| cashInTime | String | 入账时间,YYYY-mm-DD HH:MM:SS | 2023-05-23 17:28:01 |
| senderAmount | Long | 支付金额 | 10000 |
| serviceFeeAmount | Long | 手续费 | 5000 |
| beneficiaryName | String | 受益人名字 | FHILEA HERMANUS |
| beneficiaryAccountNumber | String | 受益人账号 | 628156056051 |
| reason | String | 失败原因,有固定值,如下: LOW_BALANCE、INVALID_BENEFICIARY 若订单失败且该值为空,需根据具体订单联系我方人员核查 |
响应示例
json
{
"status": 1,
"message": "PROCESSING SUCCESS",
"data": {
"orderId": "202305250001",
"transactionId": "T230525999999",
"transactionStatus": 10,
"transactionMessage": "SUCCESS",
"createdTime": "2023-05-23 17:27:58",
"cashInTime": "2023-05-23 17:28:01",
"senderAmount": 10000,
"serviceFeeAmount": 5000,
"beneficiaryName": "FHILEA HERMANUS",
"beneficiaryAccountNumber": "628156056051",
"reason": ""
}
}WARNING
目前只支持针对单笔交易进行查询,不要针对一笔订单频繁进行查询,平台会对 查询请求进行控制。
入账时间 cashInTime 在转账成功后才有取值。
余额查询 API
INFO
用途:用于查询商户账户余额
请求URL:api/balance/query/v1
请求方式:POST
请求参数
无需请求体,只需在请求头中携带相关信息即可,信息参见 请求头部信息
响应参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| amountAvailable | Long | 可用金额 | 66000 |
| preSettledAmount | Long | 待结算金额 | 10000 |
| totalAmount | Long | 总金额=可用+待结算 | 76000 |
响应示例
json
{
"status": 1,
"message": "PROCESSING SUCCESS",
"data": {
"amountAvailable": 66000,
"preSettledAmount": 10000,
"totalAmount": 76000
}
}