# 1.2 Virtual Account 批量创建接口

# 简要描述
  • 商户还款码-创建接口
# 请求URL
  • /api/v1/batch/paymentCode
# 请求方式
  • POST

# *注意:在获取VA链接时,mchOderId对应一个付款用户,该用户所须使用的每一个支付渠道都有不同的VA链接, 需要以channelCode参数请求获取VA链接。链接一旦获取后永久有效,无须重复请求, 同个mchOderId对应的一组VA码,不同mchOderId的VA码不一样。

# 请求参数
参数名 必选 类型 长度限制 示例 说明
appId string - - 应用APPID
appName string 1-100 - 商户对接应用名称, 格式:字母+空格,1-100位
mchOrderId string 1-32 CCP20220428011068111 商户-(用户/账单)唯一识别码, 格式:字母+数字,1-32位
channelCode string - GCASH_STATIC_VA,PAYMAYA_STATIC_VA 静态渠道VA Code: 多个channelCode字符串,以逗号做分隔
customerName string 1-128 - 用户名称, 格式:字母+空格,"firstName middleName lastName" (middleName 非必填)
email string 1-128 - 用户邮箱 格式:邮箱格式
minAmount int - 20000 还款最低金额
maxAmount int - 5000000 还款最高金额
mobile string 11-14 0912345678 用户手机号 格式:09 开头,纯数字,11-14位
expireTime string - 2022-05-26 过期时间,不传代表永不过期 format: yyyy-MM-dd
description string - - 还款码表述
sign string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 签名
# 响应参数
参数名 类型 长度 示例 说明
code int 11 1000 状态码, 参考列表
message String 100 success 状态码信息
data Object - 返回具体信息
- shortLink String 100 还款指引短链
- paymentVaList List 还款码集合
-- mchOrderId String 1-32 LT000000216 商户订单号
-- channelCode String 100 GCASH_STATIC_VA 还款渠道
-- guideUrl String 200 - 单个渠道的还款指引链接
-- referenceNumber String 50 PC003752 还款码
-- biller String 100 Dragon Loans 支付网关
# 返回示例
{
    "code": 1000,
    "message": "success",
    "data": {
        "paymentVaList": [
            {
                "mchOrderId": "CCP2022111405068111",
                "channelCode": "GCASH_STATIC_VA",
                "guideUrl": "https://api-dev.paycools.com/repayment/static/guide/R2VtMG5GejRtYmZFZkZlK0V2SnBzeXJjYTZUanZydHgyWXM4dUptakgrUT0=",
                "referenceNumber": "PC0000710000024",
                "biller": "PAYCOOLS LOAN"
            },
            {
                "mchOrderId": "CCP2022111405068111",
                "channelCode": "PAYMAYA_STATIC_VA",
                "guideUrl": "https://api-dev.paycools.com/repayment/static/guide/bCtvVVJobVVtdWNtQW8zSXhaMWRUa2FaN2YxZ0d3ZlJ1OTZDczdmc2xpaz0=",
                "referenceNumber": "PC0088A0",
                "biller": "Dragon Loans"
            },
            {
                "mchOrderId": "CCP2022111405068111",
                "channelCode": "7ELEVEN_STATIC_VA",
                "guideUrl": "https://api-dev.paycools.com/repayment/static/guide/emtPUVpJRzljdFNIekJScE8vWExHRGJqc2svbzVlcWJ2SEI4RVJpMGtIQT0=",
                "referenceNumber": "PC0000710000024",
                "biller": "PAYCOOLS LOAN"
            },
            {
                "mchOrderId": "CCP2022111405068111",
                "channelCode": "MLH_STATIC_VA",
                "guideUrl": "https://api-dev.paycools.com/repayment/static/guide/eW1iWUkreVJGTEUzM2NWL0VvRDNWQWN4UDZKOUFrVmhUM1ZER3BQbkdXOD0=",
                "referenceNumber": "PC0088A0",
                "biller": "Dragonpay"
            },
            {
                "mchOrderId": "CCP2022111405068111",
                "channelCode": "RDP_STATIC_VA",
                "guideUrl": "https://api-dev.paycools.com/repayment/static/guide/aUx4TURzUjZtMXJQYUdEZnhIdWRlT3ZxNTArT1hmajVkOWZ2eGIwUXliRT0=",
                "referenceNumber": "PC0088A0",
                "biller": "Dragon Loans"
            }
        ],
        "shortLink": "https://a.api-dev.paycools.com/1L9zOOL"
    }
}
# 返回失败案例 code参考列表 参考列表
{
    "code":1002,
    "message":"merchant white ip forbidden",
}