2. Check Checkout Order status

Request URL

• {domain}/open-api/payment/checkout/query

Request Method

• POST

Request Headers

Parameter Name	Required	Type	Description
Content-Type	mandatory	string	application/json

Request Body Parameters

Parameter Name	Required	Type	Description
appId	Yes	string	Application APPID
param	Yes	string	Parameter Body
sign	Yes	string	Signature

param

Parameter Name	Required	Type	Length Limit	Example	Description
timestamp	Yes	long	-	1677495496979	Current Timestamp
checkoutId	Yes	string	1-32	-

Request Example

Request Body

{
   "appId": "733b887a4a784708bb369524db5b6ded",
   "sign": "A5Vd8NcQvU3QT41Yee2jCIK58jDAKZ6kP5gEE4q7Yu92hUCY3k00FKTSlCNU+CcZm0LSrGbEMFMID3p7uvXaqy5khNv3kPndrgp7MIRHUmQnMgRK+g1XG7PzWdnrqlXc3g+L+kqVja+qrFRz+uVS6GLKLR1P4AtgTa9dok6NU7YTWOnG9r/FwIVx/At4czfEpI10pvg2TptVpiANmseGmz4G30hkaYTTNahkcOMQJn6PDFjivHvjNLZNJVOqHQzVUa+kca1yZZMPHtgxR647KjoY2oAjjl0Y45GL6zP9qHD/eVwcPPAPrRZ4K2o05OJnPf67fAcWNVqpnu6ZGQIXhQ==",
   "param": "{\"timestamp\":1715595802,\"checkoutId\":\"CH1789920394875113472\"}"
}

How to construct request body

---

Response Parameters

Parameter Name	Type	Description
code	integer	Response Code
message	string	Response Message
data	Object	Data

data Parameters

Parameter Name	Type	Description
checkoutId	string	Checkout Order ID
status	string	Checkout Order Status (PENDING, PAID, CLOSED)
expiresTime	string	Expiration Time
transactionList	string	Successful Transactions List
- transactionId	string	PayCools Transaction ID
- transactionStatus	string	Transaction Status(PENDING, COMPLETED, FAILED)
- channelCode	string	Channel Code
- transactionCreateTime	string	Transaction Create Time
- transactionReturnTime	string	Transaction Return Time

Response Example

{
  "code": 10000,
  "message": "Success",
  "data": {
    "checkoutId": "CH1789920394875113472",
    "status": "PAID",
    "expiresTime": "2024-05-14 15:27:32",
    "transactionList": [
      {
        "transactionId": "CU4Y9920490660433920",
        "transactionStatus": "COMPLETED",
        "channelCode": "PH_GCASH_URL",
        "transactionCreateTime": "2024-05-13 15:27:55",
        "transactionReturnTime": "2024-05-13 15:29:21"
      }
    ]
  }
}

Response Codes Collection

Failed Response Example

{
  "code": 21016,
  "message": "Merchant ip forbidden"
}