1.1 QRCODE Creation

request URL

• /api/v1/qrcode

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 or bill) format: letter + num, 1-32 characters
channelCode	mandatory	string	-	-	channelCode: QRPH_STATIC_QR、QRPH_DYNAMIC_QR、QRPH_HYBRID_QR
amount	optional	int	-	For channelCode is QRPH_DYNAMIC_QR & QRPH_HYBRID_QR is Mandatory, and the min amount 20 peso	Payment amount (unit: cents) PHP:500.10, should set 50010 cents
customerName	mandatory	string	1-128	-	customer name, format："firstName middleName lastName" (middle name optional)
email	optional	string	1-128	-	customer email
callbackUrl	optional	string	1-256	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	1-256	-	Qrcode Remark
expireSeconds	optional	int	-	-	Expiration seconds (minimum 60s, maximum 3600s), if not uploaded, the default is 3600s(Effective only for QRPH_DYNAMIC_QR、QRPH_HYBRID_QR)
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
- mchOrderId	String	1-32	E34302809202827219113	Merchant order id (unique for customer)
- qrcodeId	String	50	QR1007656756764275140	Qr code ID
- qrcodeContent	String	text	-	Qrcode Content (If you need to customize the repayment guidance page, you can generate the QR code by this content)
- channelCode	String	100	QRPH_STATIC_QR	Collection Channel Code
- callbackUrl	String	150	-	The callback url
- createTime	string	-	2022-07-02 18:12:46	QrCode create time
- updateTime	string	-	2022-07-02 18:14:05	QrCode update time
- expiresTime	String	2022-07-02 18:15:05	QrCode expire time
- remark	String	255	-	remark
- status	String	50	ACTIVE	QrCode status
- qrLink	String	100	-	QrCode repayment guidance link

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_STATIC_QR",
      "callbackUrl": "https://www.paycools.com.ph",
      "createTime": "2022-07-02 18:12:46",
      "updateTime": "2022-07-02 18:14:05",
      "expiresTime": "2022-07-02 18:14:05",
      "remark": "test static qrcode",
      "status": "ACTIVE",
      "qrLink": "https://a.api-dev.paycools.com/1L9zOb5"
	}
}

failed response example. code see reference

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