Skip to main content

API INQUIRY STATUS

smilepayz teamsAbout 1 min

USDT region transaction status inquiry API (USDT).

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

FieldRequiredTypeDescription
Content-TypeMStringapplication/json request body.
X-TIMESTAMPMStringDatetime with zone offset, format yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATUREMStringSignature of JSON body (see product Signature doc).
X-PARTNER-IDMStringYour merchantID

Body Parameters

FieldRequiredTypeDescription
tradeTypeMNumberTransaction type specification Format: Integer value Values: 1 (Payin), 2 (Payout) Used to identify the transaction category for status inquiry
orderNoCString(32)Merchant-unique id
tradeNoCString(32)Smilepayz tradeNo for this order.

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+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001

Response

HTTP Response

FieldRequiredTypeDescription
Content-TypeMStringapplication/json response or callback body.
X-TIMESTAMPMStringDatetime with zone offset, format yyyy-MM-ddTHH:mm:ss±HH:mm

Body Parameters

FieldRequiredTypeDescription
codeMString00 success, other values error.
messageMStringUTF-8 human-readable result line.
tradeNoOStringSmilepayz tradeNo for this order.
tradeTypeONumberTransaction type specification Format: Integer value Values: 1 (Payin), 2 (Payout) Indicates the transaction category that was queried
paymentMethodOStringSee Payment methods doc.
moneyOObjectCurrency plus amount for this transaction.
    currencyMStringFixed to USDT.
    amountMNumberAmount
statusOStringOrder or payment​ status enum value.
remarkOStringAdditional 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+07:00