Skip to content

代付业务代码

转账业务代码

json
{
  "transactionStatus": 10,
  "transactionMessage": "SUCCESS"
}

状态代码说明

代码说明可能的原因
0UNKNOWN未知
10SUCCESS成功
20FAILED失败
40TIMEOUT调用支付渠道进行处理超时,此状态不代表业务成功还是失败
50PENDING业务已受理,等待支付渠道响应或者不在工作时间或者需要T+1完成等原因,此状态不代表业务成功还是失败

接口详情

转账到账户 API

INFO

用途:用于银行/钱包账户之间进行转账

请求URL:api/remit/bank/v1

请求方式:POST

WARNING

  1. 手续费另计,不在代付金额内扣除

  2. notifyUrl字段说明:

    2.1 商户后台已配置代付回调地址,接口中可不传该字段,地址以后台配置为准

    2.2 商户后台未配置代付回调地址,则接口需传该字段,地址以接口传参为准

    2.3 商户后台已配置代付回调地址,接口也传入该字段,地址以接口传参为准

请求参数

参数必选类型说明示例
orderIdString商户订单ID202305250001
beneficiaryObject
- countryString国家,可填写 IDID
- firstNameString名字Mia
- lastNameString姓氏Smith
- phoneNumberString电话号码62856123456
beneficiaryAccountObject受益人账户信息
- bankString银行编码,参考银行编码表格014
- cityString受益人账户开户城市,可填写 JakartaJakarta
- nameString受益人账户名称John Doe
- numberString受益人账户号码6790153860
senderAmountLong支付金额10000
notifyUrlString回调地址(用于接收订单支付状态的通知地址)http://test.com
beneficiaryCityString受益人所在城市名称Jakarta
beneficiaryCountryString受益人所在国家, 可填写:IDID
beneficiaryCurrencyString受益人的货币,可填写:IDRIDR
senderObject若传入 sender 则相关信息为必填
- countryString所在国家,可填写:IDID
- firstNameString名字Mia
- lastNameString姓氏Smith
- phoneNumberString电话号码62856123456
- birthDateString出生日期(YYYY-MM-DD)2000-01-01
- personalIdString个人证件号码167101110100001
- personalIdTypeString个人证件类型,固定值:KTP(身份证)、PASSPORT(护照)KTP
- personalIdCountryString个人证件发放国家ID
senderCountryString支付人的国家,可填写:IDID
senderCurrencyString支付人的货币,可填写:IDRIDR

请求示例

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
}

响应参数

参数类型说明示例
orderIdString商户订单ID202305250001
transactionIdString平台交易 IDT230525999999
transactionStatusInt交易状态(见交易状态 代码)50
transactionMessageString交易信息(与交易状态 对应的信息)处理中
createdTimeString订单创建时间,YYYY- mm-DD HH:MM:SS2023-05-23 17:27:58
cashInTimeString入账时间,YYYY-mm-DD HH:MM:SSnull
senderAmountLong支付金额10000
serviceFeeAmountLong手续费5000
beneficiaryNameString受益人名字FHILEA HERMANUS
beneficiaryAccountNumberString受益人账号628156056051
reasonString失败原因,有固定值,如下:
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 次通知。

平台发送参数

参数类型说明示例
orderIdString商户订单ID202305250001
transactionIdString平台交易 IDT230525999999
transactionStatusInt交易状态(见交易状态代码)10
transactionMessageString交易信息(与交易状态对应的信息)成功
createdTimeString订单创建时间,YYYY- mm-DD HH:MM:SS2023-05-23 17:27:58
cashInTimeString入账时间,YYYY-mm-DD HH:MM:SS2023-05-23 17:30:58
senderAmountLong支付金额10000
serviceFeeAmountLong手续费5000
beneficiaryNameString受益人名字FHILEA HERMANUS
beneficiaryAccountNumberString受益人账号628156056051
reasonString失败原因,有固定值,如下:
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

请求参数

参数必选类型说明示例
queryIdString查询ID,唯一即可202305260001
orderIdString商户订单ID202305250001
transactionIdString平台交易ID,如果未指定则根据商户订单ID查询,同时指定会同时进行校验T20230525999

请求示例

json
{
  "queryId": "202305260001",
  "orderId": "202305250001",
  "transactionId": "T230525999999"
}

响应参数

参数类型说明示例
orderIdString商户订单ID202305250001
transactionIdString平台交易 IDT230525999999
transactionStatusInt交易状态(见交易状态代码)10
transactionMessageString交易信息(与交易状态对应的信息)成功
createdTimeString订单创建时间,YYYY-mm-DD HH:MM:SS2023-05-23 17:27:58
cashInTimeString入账时间,YYYY-mm-DD HH:MM:SS2023-05-23 17:28:01
senderAmountLong支付金额10000
serviceFeeAmountLong手续费5000
beneficiaryNameString受益人名字FHILEA HERMANUS
beneficiaryAccountNumberString受益人账号628156056051
reasonString失败原因,有固定值,如下:
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

请求参数

无需请求体,只需在请求头中携带相关信息即可,信息参见 请求头部信息

响应参数

参数类型说明示例
amountAvailableLong可用金额66000
preSettledAmountLong待结算金额10000
totalAmountLong总金额=可用+待结算76000

响应示例

json
{
  "status": 1,
  "message": "PROCESSING SUCCESS",
  "data": {
    "amountAvailable": 66000,
    "preSettledAmount": 10000,
    "totalAmount": 76000
  }
}