# 1.1 Virtual Account 创建接口

# 简要描述
  • 商户VA码-创建接口
# 请求URL
  • /api/v2/paymentCode
# 请求方式
  • POST
# 请求参数
参数名 必选 类型 长度限制 示例 说明
appId string - - 应用APPID
appName string 1-100 - 商户对接应用名称, 格式:字母+空格,1-100位
aggregateOrderId string 1-32 CCP20220428011068111 商户-(用户/账单)唯一识别码, 格式:字母+数字,1-32位
channelCode string - - 渠道VA Code(固定值"CEBUANA_VA")
aggregateAmount int - 20000 金额
callbackUrl string - - 终端支付成功后的回调地址,存在则使用该回调地址,否则走统一配置的回调地址
expireSeconds int - 3600 过期秒数,不传代表永不过期
remark string - - 备注
sign string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 签名
items string text - 子订单详情
# items 参数说明
参数名 必选 类型 长度 说明 description
subOrderId string 1-32 CCP20220428011068111 子订单编号 格式:字母+数字,1-32位
amount int - - 金额必传(单位为分, 最小金额20peso)例如PHP:500.10, 需要设置50010分
regionNo string 1-50 SEL 大区名称(1-50 位,字母*缺失影响结算提现功能 ); 示例: SEL
regionCode string 1-50 907 大区编码(1-50 位,数字,唯一); 示例: 907
branchNo string 1-100 F604602 网点编码(1-100 位, *缺失影响后台查询功能) ; 支持大小写字母和数字
courierNo string 1-100 F6046024088 快递员编码(1-100 位, *缺失影响后台查询现功能) ; 支持大小写字母和数字
customerName string 1-100 - 用户姓名,格式:字母+空格,1-100位, "firstName middleName lastName" (middleName 非必填)
customerMobile string 11 - 用户手机号(长度11位 09 开头)
customerEmail string 1-50 - 用户邮箱
courierName string 1-50 - 快递员姓名(1-50 位)
courierMobile string 11 - 快递员手机号(长度11位 09 开头)
# 响应参数
参数名 类型 示例 说明
code int 1000 状态码, 参考列表
message String success 状态码信息
data Object - 返回具体信息
- aggregateOrderId String LT000000216 商户订单号
- channelCode String CEBUANA_VA 渠道
- referenceNumber String JT20250928000001 VA码
- biller String PH GLOBAL JET EXPRESS INC 支付网关
- guideUrl String - 指引链接
- callbackUrl string - 回调地址
- aggregateAmount int - 订单金额
- aggregateFee int - 手续费
- totalAggregateAmount int - 支付总金额
- items List - 子订单详情
# items 参数说明
参数名 类型 示例 说明
subOrderId string CCP20220428011068111 子订单编号 格式:字母+数字,1-32位
customerName string - 用户姓名,格式:字母+空格,1-100位, "firstName middleName lastName" (middleName 非必填)
customerMobile string - 用户手机号(长度11位 09 开头)
customerEmail string - 用户邮箱
regionNo string SEL 大区名称(1-50 位,字母*缺失影响结算提现功能 ); 示例: SEL
regionCode string 907 大区编码(1-50 位,数字,唯一); 示例: 907
branchNo string F604602 网点编码(1-100 位, *缺失影响后台查询功能) ; 支持大小写字母和数字
courierNo string F6046024088 快递员编码(1-100 位, *缺失影响后台查询现功能) ; 支持大小写字母和数字
courierName string - 快递员姓名(1-50 位)
courierMobile string - 快递员手机号(长度11位 09 开头)
amount int - 子单金额
fee int - 子单手续费
totalAmount int - 子单支付总金额
# 返回示例
// CEBUANA VA Guide Link
{
  "code": 1000,
  "message": "success",
  "data": {
    "aggregateOrderId": "CCP2022111405068111",
    "channelCode": "CEBUANA_VA",
    "guideUrl": "https://api-dev.paycools.com/repayment/static/guide/R2VtMG5GejRtYmZFZkZlK0V2SnBzeXJjYTZUanZydHgyWXM4dUptakgrUT0=",
    "callbackUrl": "https://www.paycools.com.ph",
    "referenceNumber": "JT20250928000001",
    "biller": "PH GLOBAL JET EXPRESS INC",
    "aggregateAmount": 10000,// Unit: cent
    "aggregateFee": 2000,// Unit: cent
    "totalAggregateAmount": 10000,// Unit: cent
    "items": [
      {
        "subOrderId": "123456",
        "customerName": "Customer Name",
        "customerMobile": "09123456789",
        "amount": 50000,
        "fee": 70,
        "totalAmount": 50000,
        "customerEmail": "pay@paycools.com",
        "regionNo": "001",
        "regionCode": "001",
        "branchNo": "F604602",
        "courierNo": "F6046024088",
        "courierName": "Courier Name",
        "courierMobile": "09123456789"
      },
      {
        "subOrderId": "456789",
        "customerName": "Customer Name",
        "customerMobile": "09123456789",
        "amount": 80000,
        "fee": 70,
        "totalAmount": 80000,
        "customerEmail": "pay@paycools.com",
        "regionNo": "001",
        "regionCode": "001",
        "branchNo": "F604602",
        "courierNo": "F6046024088",
        "courierName": "Courier Name",
        "courierMobile": "09123456789"
      }
    ]
  }
}
# 返回失败案例 code参考列表 参考列表
{
    "code":1002,
    "message":"merchant white ip forbidden",
}