1.2 Batch Creation of Static Virtual Account

Request URL

• /api/v1/batch/paymentCode

Request Method

• POST

*Please note: mchOderId corresponds an actual payment user, each VA URL corresponds to a payment channel, merchant can request a VA URL by channelCode. VA channel is permanent, once it was acquired, merchant does not need to request it again. A group of VA codes corresponding to the same mchoderid. The VA codes of different mchoderids are different.

Request Body

parameter name	Is it mandatory	type of data	length	example	description
appId	mandatory	string	-	-	application APPID
appName	mandatory	string	1-100	-	Merchant application name, format: letter + space, 1-100 characters
mchOrderId	mandatory	string	1-32	CCP20220428011068111	Merchant order id (unique for customer or bill) format: letter + num, 1-32 characters
channelCode	mandatory	string	-	GCASH_STATIC_VA,PAYMAYA_STATIC_VA	Static VA ChannelCode: Multiple chanlcode strings and separated by commas
customerName	mandatory	string	1-100	-	customer name, format："firstName middleName lastName" (middle name optional)
email	mandatory	string	1-50	-	customer email
minAmount	optional	int	-	20000	min amount limit
maxAmount	optional	int	-	5000000	max amount limit
mobile	optional	string	11-14	- 0912345678	customer mobile
expireTime	optional	string	-	2022-05-26	expire time，if empay mean always active
description	optional	string	-	-	VA Remark
sign	mandatory	string	-	45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892	sign

response params

parameter name	type of data	length	example	description
code	int	11	1000	Status code see reference
message	String	100	success	The message of status code
data	Object		-	Response Data
- shortLink	String	100	https://a.api-dev.paycools.com/1L9zObb	Repayment guidance link
- paymentVaList	List			Bills Payment Date
-- mchOrderId	String	1-32	LT000000216	Merchant Order Number
-- channelCode	String	100	GCASH_STATIC_VA	Collection Channel Code
-- guideUrl	String	200	-	The single channel repayment link
-- referenceNumber	String	50	-	Repayment code
-- biller	String	100	Dragon Loans	Collection agencies

Successful Response Example

{
    "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"
    }
}

failed response example. code see reference

{
    "code":1002,
    "message":"merchant white ip forbidden",
}