3. Close Payment

Request URL

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

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": "A5Vd8NcQvU3QT41Yee2jCIK58jDAKZ6kP5gEE4q7Yu92hUCY3k00FKTSlCNU+CcZm0LSrGbEMFMID3p7uvXaqy5khNv3kPndrgp7MIRHUmQnMgRK+g1XG7PzWdnrqlXc3g+L+kqVja+qrFRz+uVS6GLKLR1P4AtgTa9dok6NU7YTWOnG9r/FwIVx/At4czfEpI10pvg2TptVpiANmseGmz4G30hkaYTTNahkcOMQJn6PDFjivHvjNLZNJVOqHQzVUa+kca1yZZMPHtgxR647KjoY2oAjjl0Y45GL6zP9qHD/eVwcPPAPrRZ4K2o05OJnPf67fAcWNVqpnu6ZGQIXhQ==",
   "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
channelCode	string	Channel Code
status	string	Status (CLOSED)
closedTime	string	Closed time

Response Example

{
    "code": 10000,
    "message": "Success",
    "data": {
        "mchOrderId": "10e051066810618100",
        "transactionId": "CU510579106014826496",
        "channelCode": "PH_QRPH_DYNAMIC",
        "status": "CLOSED",
        "closedTime": "2024-07-09T15:37:52+08:00"
    }
}

Response Codes Collection

Failed Response Example

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