# 2. Check Payment Status

# Request URL

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

# Request Method

  • POST

# Request Header

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

# Request Body Param

Parameter Name Required Type Description
appId Yes string Application Id
param Yes string param
sign Yes string signature

# param

Parameter Name Required Type Length Example Description
mchOrderId No string 1-32 - Merchant order id (require one of mchOrderId and transactionId)
transactionId No string 1-32 - Platform transaction id (require one of mchOrderId and transactionId)
countryCode Yes string - - Country code (PH, ID, MY, TH, RU)
timestamp Yes long Current timestamp

# Request Example

# Request Body

{
    "appId": "733b887a4a784708bb369524db5b6ded",
    "sign": "Platform",
    "param": "{\"mchOrderId\":\"10e051066810618100\",\"countryCode\":\"PH\",\"timestamp\":1677133173758}"
}

How to construct request body

# Response Param

Parameter Name Type Description
code integer response code
message string response message
data Object data

# data

Parameter Name Type Description
mchOrderId string Merchant order id
transactionId string Platform transaction id
countryCode string Country code (PH, ID, MY, TH, RU)
channelCode string Channel Code
amount long Amount
currency string Currency (PHP, IDR, MYR, THB, RUB)
payData string Payment data(VA,URL or QR Content)
transactionStatus string Transaction status (PENDING, COMPLETED, FAILED)
createTime string Transaction create time
returnTime string Transaction finish time
remark string remark

# Response Example

{
    "code": 10000,
    "message": "Success",
    "data": {
        "mchOrderId": "10e051066810618100",
        "transactionId": "CU510579106014826496",
        "countryCode": "PH",
        "channelCode": "PH_QRPH_DYNAMIC",
        "amount": 10000,
        "currency": "PHP",
        "payData": "00020101021128760011ph.ppmi.p2m0111OPDVPHM1XXX03157771480000000170416529481372394713405030005204601653036085802PH5908PayCools6015City Of Mandalu62310010ph.allbank05062110000803***88310012ph.ppmi.qrph0111OPDVPHM1XXX630476F2",
        "transactionStatus": "PENDING",
        "createTime": "2024-07-09T15:37:52+08:00"
    }
}

Response Codes Collection

# Failed Response Example

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