代付订单 · 玻利维亚

请求

代付 API 用于向受益人发起代付交易。本页为 玻利维亚（国家码 bo，币种 BOB）的代付说明。bankCode 使用平台银行或钱包编码，完整清单见 地区支付说明 — 玻利维亚。

请求路径

域名：推荐使用统一域名 openapi.toppayment.com（路径不变）；原国别域名（如 global-bo-openapi.toppayment.com）仍可用。

环境	地址
沙箱	https://openapi.toppayment.com/sandbox/bo/disbursement/cash
生产	https://openapi.toppayment.com/bo/disbursement/cash

请求头

字段	必填	类型	描述
Content-Type	M	String	固定值：application/json

请求体

字段	必填	类型	描述
mchNo	M	String(32)	商户编号
orderNum	M	String(50)	商户订单号
amount	M	Number(32,8)	交易金额；须为正数、整数或最多两位小数
bankCode	M	String(32)	收款银行或钱包编码，见玻利维亚编码清单
bankCard	M	String(50)	收款账号；选择 YAPE 时填写收款人 Yape 账号
accountName	M	String(50)	收款人姓名
description	O	String(255)	交易描述
feeType	M	Number	手续费类型：0 代付金额内扣除；1 手续费另计
downNotifyUrl	M	String(164)	异步通知 URL
timestamp	M	String(13)	毫秒级时间戳
sign	M	String	签名，见签名规则

请求体示例

Content-type: application/json

{
  "mchNo": "{{mchNo}}",
  "orderNum": "BOPAYOUT1234561",
  "amount": 100.50,
  "bankCode": "YAPE",
  "bankCard": "70012345",
  "accountName": "Maria Lopez",
  "description": "test",
  "feeType": 1,
  "downNotifyUrl": "https://example.com/notify",
  "timestamp": "1749451858772",
  "sign": "按签名规则生成后替换"
}

响应

响应字段

字段	必填	类型	描述
success	M	Boolean	请求是否成功
code	M	String	9999：受理成功；其他结果请结合订单状态判断
msg	O	String	响应消息
timeStamp	M	Number	响应时间戳（毫秒）
data	M	Object	交易数据
orderNum	M	String	商户订单号
platOrderNum	M	String	平台订单号
amount	M	Number	交易金额
fee	M	Number	手续费
feeType	M	Number	手续费类型
status	M	Number	交易状态，见交易状态码
statusMsg	M	String	状态描述
bankCode	M	String	银行或钱包编码
bankCard	M	String	收款账号
accountName	M	String	收款人姓名
description	O	String	交易描述

{
  "success": true,
  "code": "9999",
  "msg": "SUCCESS",
  "timeStamp": 1767772957433,
  "data": {
    "orderNum": "BOPAYOUT1234561",
    "platOrderNum": "TRANS2008811496544403456",
    "amount": 100.50,
    "fee": 2,
    "feeType": 1,
    "status": 1,
    "statusMsg": "ORDER_RECEIVED_PROCESSING",
    "bankCode": "YAPE",
    "bankCard": "70012345",
    "accountName": "Maria Lopez",
    "description": "test"
  }
}

通知

HTTP请求

字段	必填	类型	描述
Content-Type	M	String	固定值：application/json

通知体

字段	必填	类型	描述
platOrderNum	M	String	平台订单号
version	M	String	接口版本号
orderNum	M	String	商户订单号
amount	M	Number	交易金额
fee	M	Number	手续费
feeType	M	Number	手续费类型
status	M	Number	交易状态，见交易状态码
statusMsg	M	String	状态描述
bankCode	M	String	银行或钱包编码
bankCard	M	String	收款账号
accountName	M	String	收款人姓名
description	O	String	交易描述
sign	M	String	通知签名

返回

校验签名后，仅返回字符串 SUCCESS。

SUCCESS

通知示例

{
  "platOrderNum": "TRANS2008812168572567552",
  "version": "v1",
  "orderNum": "BOPAYOUT1234561",
  "amount": 100.50,
  "fee": 2,
  "feeType": 1,
  "status": 2,
  "statusMsg": "SUCCESS",
  "bankCode": "YAPE",
  "bankCard": "70012345",
  "accountName": "Maria Lopez",
  "description": "test",
  "sign": "…"
}