API INQUIRY STATUS

Request

The Transaction Status Inquiry API enables merchants to retrieve real-time transaction status information. Supported transaction types include Pay-in transactions, Payout transactions, and other transaction types.

Request Path:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/inquiry-status
production: https://gateway.smilepayz.com/v2.0/inquiry-status

Header Parameters

Field	Required	Type	Description
Content-Type	M	String	HTTP content type specification Fixed value: application/json Required for proper request parsing
X-TIMESTAMP	M	String	ISO 8601 datetime format with timezone offset Format: yyyy-MM-ddTHH:mm:ss±HH:mm Example: 2020-12-17T10:55:00-05:00 Note: Must be current server time within ±5 minutes
X-SIGNATURE	M	String	Digital signature for request authentication See Signature Generation
X-PARTNER-ID	M	String	Unique merchant identifier assigned by the platform Format: Alphanumeric string Used for merchant authentication and transaction routing Please enter merchantID

Body Parameters

Field	Required	Type	Description
tradeType	M	Number	Transaction type specification Format: Integer value Values: 1 (Payin), 2 (Payout) Used to identify the transaction category for status inquiry
orderNo	C	String(32)	Merchant transaction identifier Format: Alphanumeric string Maximum length: 32 characters Used when querying by merchant's transaction reference
tradeNo	C	String(32)	Internal transaction identifier Format: Alphanumeric string Maximum length: 32 characters Used when querying by system's transaction reference

Important Requirement

Transaction Identifier Required: At least one of tradeNo or orderNo must be provided for transaction status inquiry

Example Body – Inquiry Status Request:

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

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

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

Response

HTTP Response

Field	Required	Type	Description
Content-Type	M	String	HTTP response content type specification Fixed value: application/json Indicates JSON response format
X-TIMESTAMP	M	String	ISO 8601 datetime format with timezone offset Format: yyyy-MM-ddTHH:mm:ss±HH:mm Example: 2020-12-17T10:55:00-05:00

Body Parameters

Field	Required	Type	Description
code	M	String	API response status code indicating operation result Format: Two-digit string Success: "00", Error: Other codes Used for programmatic response handling
message	M	String	Human-readable response status description Format: UTF-8 encoded string Provides detailed information about the operation result Localized based on request language
tradeNo	O	String	Internal transaction reference number for system tracking Format: System-generated alphanumeric string Used for internal transaction management and support
tradeType	O	Number	Transaction type specification Format: Integer value Values: 1 (Payin), 2 (Payout) Indicates the transaction category that was queried
paymentMethod	O	String	Payment method used for transaction processing Format: Predefined payment method codes Examples: BCP, INTERBANK Indicates the actual payment channel used See Payment Method List
money	O	Object	Transaction amount details with currency specification Contains confirmed transaction amount and currency See Money Model
currency	M	String	ISO 4217 currency code specification Fixed value: PEN (Peruvian Sol) Determines payment processing rules and settlement currency
amount	M	Number	Transaction amount in smallest currency unit Format: Integer value Example: 20000 represents PEN 20000 Range: 100-999999999
status	O	String	Current transaction processing status Format: Predefined status codes Examples: PROCESSING, SUCCESS, FAILED, CANCELLED Indicates the current state of the transaction See Status Model
remark	O	String	Additional transaction information or notes Format: UTF-8 encoded string Contains supplementary details about the transaction status

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

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