Merchant Query Order Status API

Revision & Version

• Version: 1.0
• Last Updated: 2025-03-14

Endpoint

• URL: /api/v2/merchant/transaction-request
• Method: GET
• Authentication: Required (refer to Global Authentication Guidelines)

Request Parameters

Parameter	Type	Required	Description
requestCode	String (Optional)	false	Required if merchantOrderNo is not provided. At least one must be present.
merchantOrderNo	String (Optional)	false	Required if requestCode is not provided. At least one must be present.

Response Parameters

APIMerchantTransactionRequestResponse Fields

Parameter	Type	Description
requestCode	String	Unique request identifier assigned by the system
tradeType	TradeType	Type of transaction: Deposit or Withdraw
clientName	String	Real name of the client
requestAmount	BigDecimal	Requested amount for the transaction
requestCurrency	String	Currency of the requested amount
fiatCurrency	CurrencyCode	Fiat currency: CNY or HKD
paymentMethod	PaymentOption (optional)	Payment method used: BankCard, WeChatPay, Alipay, Blockchain, Account
status	RequestStatus	Transaction status: Reviewing, Matching, InProgress, Finished, Failed, Cancelled
endedAt	Long (timestamp)	Time when the transaction was completed or terminated
endedReason	String	Reason for transaction completion, failure, or cancellation
source	String	Request source: MerchantBackend, API_V1, API_V2
merchantOrderNo	String	Unique order number assigned by the merchant
internalOrderNo	String	Internal system-generated order number
unitPrice	BigDecimal	Exchange rate applied per unit
transactionAmount	BigDecimal	Actual amount processed in requestCurrency
receivedAmount	BigDecimal	Amount received by the client in fiat currency
transactionFee	BigDecimal	Transaction fee deducted
paymentAmount	BigDecimal	Total amount paid by the client
expiredAt	Long (timestamp)	Expiration time of the request/order
createdAt	Long (timestamp)	Time when the request was created
modifiedAt	Long (timestamp)	Last modification time of the request/order

Request Example

curl -X GET https://{YOUR_ENDPOINT}/api/v2/merchant/transaction-request?merchantOrderNo=TEST_ORDER \
  -H "Content-Type: application/json;charset=UTF-8" \
  -H "access_key: {YOUR_ACCESS_KEY}" \
  -H "signature: {GENERATED_BY_Hmac256}" \
  -H "timestamp: {TIMESTAMP_IN_MILLISECONDS}"

Response Example

{
  "data": {
    "requestCode": "fd9ef3a5cc7b49a088d0cecca789f27f",
    "tradeType": "Deposit",
    "clientName": "TEST_USER",
    "requestAmount": 1234.56,
    "requestCurrency": "CNY",
    "fiatCurrency": "CNY",
    "paymentMethod": "BankCard",
    "status": "Finished",
    "endedAt": 1741725033033,
    "endedReason": "",
    "source": "API_V2",
    "merchantOrderNo": "TEST_ORDER",
    "internalOrderNo": "AT-D-3TEHN1X9U",
    "unitPrice": 7.47,
    "transactionAmount": 165.27,
    "receivedAmount": 160.31,
    "transactionFee": 4.96,
    "paymentAmount": 1234.56,
    "expiredAt": 1741732188336,
    "createdAt": 1741724988336,
    "modifiedAt": 1741725033228
  },
  "isSuccess": true,
  "statusCode": "SUCCESS",
  "message": "",
  "version": "2.0"
}