API 文档

# 3、查询订单

  • 查询订单状态

# 查询收款订单

请求方式 POST

请求 URL/api/v3/vn/query/collectingOrder

请求类型:

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

请求头参数

Param Type Description Sample
access_key String 商户后台获取 pFqV75X3
timestamp String 13 位 Unix 毫秒时间戳 1679724896223
nonce String UUID v4 随机字符串 794c26b0-d33c-4394-b2bb-c485eca16d9e
sign String 用 secret_key 加签结果 kAXyh+eerqrefyaF8dyFB0M4FVo=

请求示例

{
    "externalOrderId":"333333333222233322",
    "orderId": "OCURRPAID202402270555381709013338091DEV001OO0000000400013559"
}

请求参数说明

Param Type Required Description
externalOrderId String 选填 商户订单号
orderId String 选填 系统订单号

响应类型

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

响应示例

{
	"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"
	}]
}

响应参数说明

参数名 类型 描述
orderId String 订单ID
cashierId String 收银台ID
orderType int64 订单类型
orderResourceType int64 订单所属业务类型
userId String 用户ID
orderStatus int64 订单状态 1-待支付 2- 支付成功
orderTime int64 订单发起时间
channelOrderId String 订单关联渠道订单ID
externalOrderId String 商户订单号
orderAmount String 订单金额
orderActualAmount String 订单实际金额
orderFee int64 订单手续费
orderPayTime int64 订单支付时间
currencyType String 货币类型
payType int64 payment type 113-BANK_SCAN_CODE 114-CARD_TO_CARD 115-MOMO 116-ZALO_PAY 117-VIETTEL_MONEY,102-BANK
tradeNote String 备注
notifyUrl String 回调URL
markStatus int64 标记状态
errorMsg String 错误信息
errorMsgEn String 错误信息en
accountType String 账户类型
accountName String 账户名称
accountNo String 账户号
orderTypeCode String 订单类型code
orderResourceTypeCode String 订单所属业务类型code
orderStatusCode String orderStatusc描述
payTypaCode String 支付类型code参考payType
userInfoName String 用户信息名
userInfoNo String 用户信息ID
businessId String 企业ID
orderEntryAmount String 订单实际入账金额

# 查询代付订单

请求方式 POST

请求 URL /api/v3/vn/query/transferOrder

请求类型:

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

请求头参数

Param Type Desc Sample
access_key String 商户后台获取 pFqV75X3
timestamp int64 Unix 时间戳 13 位 1679724896223
nonce String UUID V4 794c26b0-d33c-4394-b2bb-c485eca16d9e
sign String 计算出的签名 kAXyh+eerqrefyaF8dyFB0M4FVo=

请求示例

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

请求参数说明

Param Type Require Desc
externalOrderId String 选填 商户订单号
orderId String 选填 系统订单号

响应类型

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

响应示例

{
    "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"
        }
    ]
}

响应参数说明

Param Type Desc
bankOrderId String 银行订单号
accountName String 账户名称
cashierId String 收银台ID
accountNo String 账户账号
accountType String 账户类型
channelOrderId String 订单关联渠道订单 ID
currencyType String 法币类型
errorMsg String 错误原因
externalOrderId String 商户订单号
notifyUrl String 回调地址
orderAmount String 订单金额
orderActualAmount String 订单实际金额
orderEntryAmount String 订单实际入账金额
orderFee string 订单手续费
orderCompleteTime int64 订单完成时间
orderPayTime int64 订单支付时间
orderId String 系统订单 ID
orderResourceType int64 订单所属业务类型
orderStatus int64 订单状态： 1-已受理 2-银行处理中 4-失败，未受理（终态） 8-成功（终态） 16-失败（终态）
orderTime int64 订单发起时间（时间戳）
orderType int64 订单类型
payType int64 支付类型
tradeNote String 备注
userId String 订单创建人 ID
payTypeCode String 对 payType 的描述
orderStatusCode String 对 orderStatus 的描述，枚举值： Accepted、In bank processing、Bank rejection、Completed、Failed
orderTypeCode String 对 orderType 的描述，枚举值：收款、代付
userInfoName String 用户信息名
userInfoNo String 用户信息证件号
businessId String 企业 ID
accountCode String 银行账号

← 4、查询余额 →