API 文档

# 3、查询订单

  • 查询订单状态

# 查询收款订单

请求方式

POST

请求 URL

/api/v3/bra/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": "389508808434869257",
  "orderId": "OCURRPAID202307270301551690426915467DOCKER020000000400000744",
  "bankOrderId": ""
}

请求参数说明

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

响应类型

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

响应示例

{
  "code": "200",
  "success": true,
  "msg": "成功",
  "msgEn": "SUCCESS",
  "data": [{
    "bankOrderId":"E10573521181304110613MHu0cF9D6VR",
    "accountName": "",
    "accountNo": "",
    "accountType": "",
    "cashierId": "OCURRPAID202503250711431742886703988EDEG3OOO0000000228690148",
    "channelOrderId": "1e432e58-3144-450e-88f5-cb29e6627e08",
    "currencyType": "BRL",
    "errorMsg": null,
    "externalOrderId": "12064499",
    "markStatus": null,
    "notifyUrl": "https://gw.test.io/api/v1/test/test-api/test/testNotifySuccess",
    "orderActualAmount": "10.22",
    "orderAmount": "10.22",
    "orderCompleteTime": 1742886801000,
    "orderEntryAmount": "10.085",
    "orderFee": "0.135",
    "orderId": "OCURRPAID202503250711441742886704194EDEG3OOO0000000428690149",
    "orderPayTime": 1742886801000,
    "orderResourceType": 2,
    "orderStatus": 2,
    "orderTime": 1742886704000,
    "orderType": 1,
    "payType": 101,
    "tradeNote": "test123",
    "userId": "1820390853885063170",
    "userInfoName": "Jaime de Jesus",
    "userInfoNo": "055.***.***-08",
    "businessId": "E10573521202503250712WGZC7hvNcP4",
    "payTypeCode": "PIX",
    "orderStatusCode": "Payment success",
    "orderTypeCode": "Pay"
  }]
}

响应参数说明

参数名 类型 描述
bankOrderId String 银行订单号
accountName String 账户名称
orderActualAmount String 实际订单金额。消费者实际支付的金额，有可能与创建时的订单金额不一致，以消费者实际支付为准。
orderEntryAmount String 商户入账金额。商户实际收到的金额，等于 orderActualAmount - orderFee。
orderAmount String 订单原始金额。创建订单时发起的金额。
orderFee String 订单手续费。按照实际订单金额（orderActualAmount）进行计算。
orderPayTime int64 订单支付时间（Unix 毫秒时间戳）
orderCompleteTime int64 订单完成时间（Unix 毫秒时间戳）
errorMsg String 错误消息（中文）
errorMsgEn String 错误消息（英文）
accountNo String 账户账号
accountType String 账户类型（如 CPF、CNPJ、EMAIL 等）
cashierId String 收银台 ID
channelOrderId String 关联的渠道订单号
currencyType String 法币币种代码，枚举值：BRL
externalOrderId String 商户订单号
notifyUrl String 支付完成后回调地址
orderId String 系统生成的订单号
orderResourceType int64 订单所属业务类型，枚举值：2 2-法币订单
orderStatus int64 订单状态，枚举值：1、2 1-待支付 2-支付成功（终态）
orderTime int64 订单创建时间（Unix 毫秒时间戳）
orderType int64 订单类型，枚举值：1、2 1-收款 2-代付
payType int64 支付方式类型编码，枚举值：101 101-PIX
tradeNote String 商户备注信息
userId String 用户 ID
payTypeCode String 对 payType 的描述，枚举值：PIX
orderStatusCode String 对 orderStatus 的描述，枚举值： Wait pay、Payment Successful
orderTypeCode String 对 orderType 的描述，枚举值：收款、代付
userInfoName String 用户姓名
userInfoNo String 用户证件号
businessId String 商户企业标识 ID

# 查询代付订单

请求方式 POST

请求 URL /api/v3/bra/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",
  "bankOrderId": ""
}

请求参数说明

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

响应类型

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

**响应****示例**

{
  "code": "200",
  "success": true,
  "msg": "成功",
  "msgEn": "SUCCESS",
  "data": [{
    "bankOrderId":"E054916161234781406071483462af84",
    "accountName": "",
    "accountNo": "[email protected]",
    "accountCode": null,
    "accountType": "EMAIL",
    "cashierId": "",
    "channelOrderId": "14e5bb92-d33c-48d7-bce9-85e22d83b07d",
    "currencyType": "BRL",
    "errorMsg": null,
    "externalOrderId": "47930639",
    "markStatus": null,
    "notifyUrl": "https://gw.test.io/api/v1/test/test-api/test/testNotifyFail",
    "orderActualAmount": "1.122",
    "orderAmount": "1.11",
    "orderCompleteTime": 1743004319000,
    "orderEntryAmount": "1.11",
    "orderFee": "0.012",
    "orderId": "OCURRDRAW202503261551261743004286417EDEG1OOO0000000228730225",
    "orderPayTime": 1743004319000,
    "orderResourceType": 2,
    "orderStatus": 8,
    "orderTime": 1743004287000,
    "orderType": 2,
    "payType": 201,
    "tradeNote": "Welcome to www.hambit.com !!!",
    "userId": "1820390853885063170",
    "userInfoName": "Jaime de Jesus",
    "userInfoNo": "055.***.***-08",
    "businessId": "E082535392025032615515305867ed00",
    "payTypeCode": "PIX",
    "orderStatusCode": "Success",
    "orderTypeCode": "Transfer"
  }]
}

响应参数说明

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

← 4、查询余额 →