3、Query Orders

Query Payment Order

Request Method

• POST

Request URL

/api/v3/vn/query/collectingOrder

Request Type

"Content-Type": "application/json; charset=utf-8" 

Request Headers

Parameter	Description	Example Value
access_key	Obtained from the merchant backend	pFqV75X3
timestamp	13-digit Unix timestamp (milliseconds)	1679724896223
nonce	UUID V4 format	794c26b0-d33c-4394-b2bb-c485eca16d9e
sign	Signature calculated based on the signing rule	kAXyh+eerqrefyaF8dyFB0M4FVo=

Request Parameters

Parameter	Type	Description	Example Value	Required
externalOrderId	String	Merchant order number, max length 64 characters	241534072867503522	Yes
orderId	String	System order number	OCURRPAID202308220659471692687587691...	Yes

Response Headers

Header: { 'Content-Type': 'application/json;charset=utf-8' }

Response Example

{
	"code": "200",
	"success": true,
	"msg": "成功",
	"msgEn": "SUCCESS",
	"data": [{
		"accountName": "",
		"accountNo": "",
		"accountType": "",
		"cashierId": "OCURRPAID202506090822201749457340646U0000000200000210",
		"channelOrderId": "17494573407031twv0qa3ksb7cb5fm6w",
		"currencyType": "VND",
		"externalOrderId": "YURITEST20250609162220066906",
		"notifyUrl": "https://gw.io/api/v1/api/test/testNotifySuccess",
		"orderActualAmount": "50000",
		"orderAmount": "50000",
		"orderCompleteTime": 1749457527000,
		"orderEntryAmount": "49450",
		"orderFee": "550",
		"orderId": "OCURRPAID202506090822201749457340695U0000000400000211",
		"orderPayTime": 1749457527000,
		"orderResourceType": 2,
		"orderStatus": 2,
		"orderTime": 1749457341000,
		"orderType": 1,
		"payType": 117,
		"tradeNote": "test",
		"userId": "1785945811976196097",
		"userInfoName": "",
		"userInfoNo": "",
		"businessId": "17494573407031twv0qa3ksb7cb5fm6w",
		"payTypeCode": "",
		"orderStatusCode": "Payment success",
		"orderTypeCode": "Pay"
	}]
}

Response Parameters

Param	Type	Description
orderId	String	Order ID
cashierId	String	Checkout ID
orderType	int64	Order type
orderResourceType	int64	Business type of the order
userId	String	User ID
orderStatus	int64	Order status: 1-Pending payment, 2-Payment successful
orderTime	int64	Order creation timestamp
channelOrderId	String	Channel reference order ID
externalOrderId	String	Merchant order number
orderAmount	String	Order amount
orderActualAmount	String	Actual order amount
orderFee	int64	Transaction fee
orderPayTime	int64	Payment completion timestamp
currencyType	String	Currency type
payType	int64	Payment method: 113-BANK_SCAN_CODE, 114-CARD_TO_CARD, 115-MOMO, 116-ZALO_PAY, 117-VIETTEL_MONEY,102-BANK
tradeNote	String	Remarks
notifyUrl	String	Callback URL
markStatus	int64	Marking status
errorMsg	String	Error message (localized)
errorMsgEn	String	Error message (English)
accountType	String	Account type
accountName	String	Account holder name
accountNo	String	Account number
orderTypeCode	String	Order type code
orderResourceTypeCode	String	Business type code
orderStatusCode	String	Order status description
payTypeCode	String	Payment type code (reference payType)
userInfoName	String	User information name
userInfoNo	String	User information ID
businessId	String	Enterprise ID
orderEntryAmount	String	Settled amount

Query Transfer Order

Request Method

POST

Request URL

/api/v3/vn/query/transferOrder

Request Type

"Content-Type": "application/json; charset=utf-8" 

Request Headers

Param	Description	Example
access_key	Merchant backend key	pFqV75X3
timestamp	Unix timestamp (13 digits, milliseconds)	1679724896223
nonce	UUID V4	794c26b0-d33c-4394-b2bb-c485eca16d9e
sign	Signature string	kAXyh+eerqrefyaF8dyFB0M4FVo=

Request Parameters

{
  "externalOrderId": "241534072867503522",
  "orderId": "OCURRDRAW202308220659491692687589549DOCK02OO0000000200003653"
}

Request Parameter Descriptions

Param	Description	Required
externalOrderId	Merchant order number (max=64, String)	✅
orderId	System order number (String)	✅

Response Type

Header: { 'Content-Type': 'application/json;charset=utf-8' }

Response Example

{
    "code": "200",
    "success": true,
    "msg": "成功",
    "msgEn": "SUCCESS",
    "data": [
        {
            "accountName": "",
            "accountNo": "222333331",
            "accountType": "",
            "cashierId": "",
            "channelOrderId": "1709015847829jirrao15beq31x24826",
            "currencyType": "VND",
            "errorMsg": "Success",
            "externalOrderId": "6554516461231233222222222",
            "notifyUrl": "https://platform.hambit.co/#/home/dashboard",
            "orderActualAmount": "13.4",
            "orderAmount": "10",
            "orderCompleteTime": 1709015949000,
            "orderEntryAmount": "10",
            "orderFee": "3.4",
            "orderId": "OCURRDRAW202402270637261709015846138DEV001OO0000000200013584",
            "orderPayTime": 1709015949000,
            "orderResourceType": 2,
            "orderStatus": 8,
            "orderTime": 1709015846000,
            "orderType": 2,
            "payType": 202,
            "tradeNote": "adkasd",
            "userId": "1707285840326127617",
            "payTypeCode": "BANK",
            "orderStatusCode": "Success",
            "orderTypeCode": "Transfer"
        }
    ]
}

Response Parameter Descriptions

Param	Type	Description
bankOrderId	String	Bank order number
accountName	String	Account holder name
cashierId	String	Checkout ID
accountNo	String	Account number
accountType	String	Account type
channelOrderId	String	Channel reference order ID
currencyType	String	Fiat currency type
errorMsg	String	Error reason
externalOrderId	String	Merchant order number
notifyUrl	String	Callback URL
orderAmount	String	Order amount
orderActualAmount	String	Actual order amount
orderEntryAmount	String	Settled amount
orderFee	String	Transaction fee
orderCompleteTime	int64	Order completion timestamp
orderPayTime	int64	Payment timestamp
orderId	String	System order ID
orderResourceType	int64	Business type of the order
orderStatus	int64	Order status: 1-Accepted, 2-In bank processing, 4-Failed (terminal), 8-Completed (terminal), 16-Failed (terminal)
orderTime	int64	Order creation timestamp
orderType	int64	Order type
payType	int64	Payment method
tradeNote	String	Remarks
userId	String	Order creator ID
payTypeCode	String	Description of payType
orderStatusCode	String	Description of orderStatus (enum: Accepted, In bank processing, Bank rejection, Completed, Failed)
orderTypeCode	String	Description of orderType (enum: Collection, Disbursement)
userInfoName	String	User information name
userInfoNo	String	User ID number
businessId	String	Enterprise ID
accountCode	String	Bank account number