1.1 QrCode Creation Merge Order With Fee

request URL

• /api/v2/qrcode/merge

request method

• POST

request params

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) format: letter + num, 1-32 characters
channelCode	mandatory	string	-	-	channelCode: QRPH_HYBRID_QR
item	mandatory	string	text	-	customer name, format："firstName middleName lastName" (middle name optional)
callbackUrl	optional	string	-	If the callback address exists, the callback address is used. If the callback address does not exist, the callback address is used
remark	optional	string	-	-	Qrcode Remark
businessType	optional	int	-	1:COD type, 2:Station type, 3:Delivery Change, 4:STATION COD	1:COD type,2:Station type, 3:Delivery Change, 4:STATION COD (default 1:COD type)
feeSplitType	optional(Station、Delivery Change、 STATION COD type mandatory)	int	-	1:Merchant Mode, 2:User Mode	1:Merchant Mode,2:User Mode(default 2:User Mode)
sign	mandatory	string	-	45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892	sign

item params

parameter name	Is it mandatory	type of data	length	example	description
subOrderId	mandatory	string	1-32	CCP20220428011068111	Merchant order id (unique for customer) format: letter + num, 1-32 characters
customerName	mandatory	string	1-100	-	customer name, format："firstName middleName lastName" (middle name optional)
customerMobile	optional	11	string	-	customer mobile number(09 start)
amount	mandatory	int	-	amount mandatory	payment amount (unit: cents, Minimum amount 20 peso) PHP:500.10, should set 50010 cents
email	optional	string	1-50	-	customer email
regionNo	mandatory	string	1-50	SEL	Region name (1-50 digits, *missing affects settlement withdrawal function ); Support uppercase and lowercase letters and numbers Example: SEL
regionCode	mandatory	string	1-50	907	Region code (1-50 digits, nums, unique ) Example: 907;
branchNo	optional	string	1-100	F604602	Branch code (1-100 digits, *missing affects backend query function); Support uppercase and lowercase letters and numbers
courierNo	optional	string	1-100	F6046024088	The courier code (1-100 digits, *missing affects the backend query function); Support uppercase and lowercase letters and numbers
courierName	optional	string	1-50	-	courier name
stationNo	optional(station、STATION COD type mandatory)	string	1-100	SEL	Station name(1-100 digits) ; Example: SEL
stationCode	optional(station、STATION COD type mandatory)	string	1-100	907	station code(1-100 digits) ; Example: 907
courierMobile	optional	string	11	-	courier mobile number(09 start)

Required params example

{
    "appId":"f7146e62b****************bae34bf156",
    "appName":"MocaMoca",
    "aggregateOrderId":"PCW000000000046067",
    "aggregateAmount": 140000,
    "channelCode":"QRPH_HYBRID_QR",
    "items":"[{\"subOrderId\":\"PCW00000000003249\",\"customerName\":\"Customer Name\",\"customerMobile\":\"09123456789\",\"amount\":60000,\"email\":\"pay@paycools.com\",\"regionNo\":\"001\",\"regionCode\":\"001\",\"branchNo\":\"F604602\",\"courierNo\":\"F6046024088\",\"courierName\":\"Courier Name\",\"courierMobile\":\"09123456789\"},{\"subOrderId\":\"PCW00000000003250\",\"customerName\":\"Customer Name\",\"customerMobile\":\"09123456789\",\"amount\":80000,\"email\":\"pay@paycools.com\",\"regionNo\":\"001\",\"regionCode\":\"001\",\"branchNo\":\"F604602\",\"courierNo\":\"F6046024088\",\"courierName\":\"Courier Name\",\"courierMobile\":\"09123456789\"}]",
    "remark":"remark",
    "callbackUrl":"https://wwww.paycools.ph",
    "businessType": 1,
    "sign":"ouo4si4bVis***************8isUevNZ38="
    
}

Successful Response example

{
	"code":1000,
	"message":"success",
	"data":{
      "mchOrderId": "E34302809202827219113",
      "qrcodeId": "QR1007656756764275140",
      "qrcodeContent": "00020101021228770011ph.ppmi.p2m0111OPDVPHM1XXX031632948137239463980416329481372394639805030015204601653036085406500.005802PH5921Paycools John Cyril B6015City Of Mandalu62310010ph.allbank05062110000803***88310012ph.ppmi.qrph0111OPDVPHM1XXX6304E56C",
      "channelCode": "QRPH_HYBRID_QR",
      "callbackUrl": "https://www.paycools.com.ph",
      "createTime": "2022-07-02 18:12:46",
      "updateTime": "2022-07-02 18:14:05",
      "remark": "test static qrcode",
      "status": "ACTIVE",
      "qrLink": "https://a.api-dev.paycools.com/1L9zOb5",
      "aggregateAmount": 10000, // Unit: cent
      "aggregateFee": 2000, // Unit: cent
      "totalAggregateAmount": 12000, // Unit: cent
      "businessType": 1,
      "items": [
            {
            "subOrderId":"123456",
            "customerName":"Customer Name",
            "customerMobile":"09123456789",
            "channelCode":"QRPH_HYBRID_QR",
            "amount":50000,
            "fee":70,
            "totalAmount":50070,
            "email":"pay@paycools.com",
            "regionNo":"001",
            "regionCode":"001",
            "branchNo":"F604602",
            "courierNo":"F6046024088",
            "courierName":"Courier Name",
            "courierMobile":"09123456789"
            },
            {
            "subOrderId":"456789",
            "customerName":"Customer Name",
            "customerMobile":"09123456789",
            "channelCode":"QRPH_HYBRID_QR",
            "amount":80000,
            "fee":70,
            "totalAmount":80070,
            "email":"pay@paycools.com",
            "regionNo":"001",
            "regionCode":"001",
            "branchNo":"F604602",
            "courierNo":"F6046024088",
            "courierName":"Courier Name",
            "courierMobile":"09123456789"
      }],
      "warning": ""
	}
}

failed response example. code see reference (opens new window)

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