Api Inquiry Status

Request

API Inquiry Status function is a critical component in modern digital services, empowering applications with the ability to programmatically request and receive updates about the current status of various operations.

Request Path:

{Base URL}/v2.0/inquiry-status

Header Parameters

Field	Attribute	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	yyyy-MM-ddTHH:mm:ss[zoneOffset] eg: 2020-12-17T10:55:00+07:00
X-SIGNATURE	M	String	Focus：How to signature
X-PARTNER-ID	M	String	merchant ID

Body Parameters

Field	Attribute	Type	Description
tradeType	M	number	Object Model TradeType
orderNo	C	String(32)	merchant transaction Unique ID
tradeNo	C	String(32)	smilepayz transaction Unique ID

Info

At least one of tradeNo and orderNo is not empty

Example Body – inquiry status Request:

POST {Base URL}/v2.0/inquiry-status HTTP/1.2

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001

{
    "tradeType": 1,
    "orderNo": "2000112900000000000001"
}

{
    "tradeType": 2,
    "tradeNo": "172200312406111311517153"
}

Response

API header format structure:

Area	Field	Attribute	Type	Description
Header	Content-Type	M	String	application/json
	X-TIMESTAMP	M	String	yyyy-MM-ddTHH:mm:ss[zoneOffset] eg: 2020-12-17T10:55:00+07:00

Response Body

Field	Attribute	Type	Description
code	M	String	success = "00"
message	M	String	Response message
tradeNo	O	String	smilepayz trade no
tradeType	O	Number	Trade Type
paymentMethod	O	String	PaymentMethod
money	O	Money	Money
status	O	String	Transaction Status
remark	O	String	remark

Example Body – Inquiry Status Request:

Content-type: application/json 
X-TIMESTAMP: 2020-12-17T10:55:00+07:00

{
    "code": "00",
    "message": "Successful",
    "money": {
        "amount": 20000,
        "currency": "PEN"
    },
    "paymentMethod": "BCP",
    "status": "SUCCESS",
    "tradeNo": "172200312406111311517153",
    "tradeType": 2
}