1.1 Create Virtual Account

Description

• Create Virtual Account

Request URL

• /api/v2/paymentCode

Request Method

• POST

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
aggregateOrderId	mandatory	string	1-32	CCP20220428011068111	Merchant order id ((unique for customer or bill) )
channelCode	mandatory	string	-	-	VA ChannelCode(fixed "CEBUANA_VA")
aggregateAmount	mandatory	int	-	20000	Amount limit
items	mandatory	string	text	-	Item info
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
expireSeconds	optional	int	-	3600	Expire seconds，if empay mean always active
remark	optional	string	-	-	Remark
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
amount	mandatory	int	-	-	Payment amount (unit: cents, Minimum amount 20 peso) PHP:500.10, should set 50010 cents
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	mandatory	string	1-100	F604602	Branch code (1-100 digits, *missing affects backend query function); Support uppercase and lowercase letters and numbers
courierNo	mandatory	string	1-100	F6046024088	The courier code (1-100 digits, *missing affects the backend query function); Support uppercase and lowercase letters and numbers
customerName	optional	string	1-100	-	Customer name, format："firstName middleName lastName" (middle name optional)
customerMobile	optional	string	11	-	Customer mobile number(09 start)
customerEmail	optional	string	1-50	-	Customer email
courierName	optional	string	1-50	-	Courier name
courierMobile	optional	string	11	-	Courier mobile number(09 start)

response params

parameter name	type of data	example	description
code	int	1000	Status code see reference
message	String	success	The message of status code
data	Object	-	Response Data
- aggregateOrderId	String	LT000000216	Merchant order id ((unique for customer or bill) )
- channelCode	String	CEBUANA_VA	VA ChannelCode(fixed "CEBUANA_VA")
- referenceNumber	String	JT20250928000001	Payment reference code
- biller	String	PH GLOBAL JET EXPRESS INC	Collection agencies
- guideUrl	String	-	The single channel repayment link
- callbackUrl	string	-	Callback url
- aggregateAmount	int	-	Aggregate amount
- aggregateFee	int	-	Aggregate fee
- totalAggregateAmount	int	-	Aggregate total amount
- items	List	-	Item info

item params

parameter name	type of data	example	description
subOrderId	string	CCP20220428011068111	Merchant order id (unique for customer) format: letter + num, 1-32 characters
customerName	string	-	Customer name, format："firstName middleName lastName" (middle name optional)
customerMobile	string	-	Customer mobile number(09 start)
customerEmail	string	-	Customer email
regionNo	string	SEL	Region name (1-50 digits, *missing affects settlement withdrawal function ); Support uppercase and lowercase letters and numbers Example: SEL
regionCode	string	907	Region code (1-50 digits, nums, unique ) Example: 907
branchNo	string	F604602	Branch code (1-100 digits, *missing affects backend query function); Support uppercase and lowercase letters and numbers
courierNo	string	F6046024088	The courier code (1-100 digits, *missing affects the backend query function); Support uppercase and lowercase letters and numbers
courierName	string	-	Courier name
courierMobile	string	-	Courier mobile number(09 start)
amount	int	-	Item amount
fee	int	-	Item fee
totalAmount	int	-	Item total amount

Successful Response Example

// 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,
    "aggregateFee": 2000,
    "totalAggregateAmount": 10000,
    "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"
      }
    ]
  }
}

failed response example code see reference

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