1.2 Get Virtual Account Detail

Description

• Virtual Account Detail

Request URL

• /api/v2/paymentCode/detail

Request Method

• POST

Request Body

parameter name	Is it mandatory	type of data	length	example	description
appId	mandatory	string	-	-	Application APPID
sign	mandatory	string	-	45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892	sign
aggregateOrderId	mandatory	string	1-32	CCP20220428011068111	Merchant order id ((unique for customer or bill) )

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	long	-	Aggregate amount
- aggregateFee	int	-	Aggregate fee
- totalAggregateAmount	long	-	Aggregate total amount
- items	List	-	Item info
- paymentList	List	-	Payment info

items 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	long	-	Item amount
fee	int	-	Item fee
totalAmount	long	-	Item total amount

paymentList params

参数名	类型	示例	说明
transactionId	String	C1007654524064590031	PayCools Unique transaction number
transactionCreateTime	String	2022-06-06 22:01:05	Transaction create time
transactionReturnTime	String	2022-06-06 22:01:05	Transaction completion time
transactionAmount	long	1000	Transaction amount
transactionStatus	String	COMPLETE	Transaction status
remark	String	-	remark

Successful Response Example

{
  "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": 12000,
    "paymentList": [
      {
        "transactionId": "C1007654524064590031",
        "transactionCreateTime": "2022-06-06 22:01:05",
        "transactionReturnTime": "2022-06-06 22:01:05",
        "transactionAmount": 100000,
        "transactionStatus": "COMPLETE",
        "remark": null
      },
      {
        "transactionId": "C1007654524370814038",
        "transactionCreateTime": "2022-06-06 22:06:11",
        "transactionReturnTime": "2022-06-06 22:06:11",
        "transactionAmount": 100000,
        "transactionStatus": "COMPLETE",
        "remark": null
      }
    ],
    "items": [
      {
        "subOrderId": "123456",
        "customerName": "Customer Name",
        "customerMobile": "09123456789",
        "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",
        "amount": 80000,
        "fee": 70,
        "totalAmount": 80070,
        "email": "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",
}