# 3、Query Orders

Query Order Status

# Query Collecting Orders

Request Method

POST

Request URL

/api/v3/bra/query/collectingOrder

Request Type

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

Request Header Parameters

Param	Type	Description	Sample
access_key	String	Merchant's backend access key	pFqV75X3
timestamp	String	13-digit Unix timestamp in milliseconds	1679724896223
nonce	String	UUID v4 random string	794c26b0-d33c-4394-b2bb-c485eca16d9e
sign	String	Signature generated using the secret_key	kAXyh+eerqrefyaF8dyFB0M4FVo=

Request Example

{
  "externalOrderId": "389508808434869257",
  "orderId": "OCURRPAID202307270301551690426915467DOCKER020000000400000744",
  "bankOrderId": ""
}

Request Parameters Description

Param	Type	Required	Description
externalOrderId	String	Optional	Merchant Order ID
orderId	String	Optional	System Order ID
bankOrderId	String	Optional	Bank Order ID

Response Header

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

Response Example

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

Response Parameter Description

Parameter Name	Type	Description
bankOrderId	String	Bank order number
accountName	String	Account name
orderActualAmount	String	Actual order amount. The amount actually paid by the consumer, which may differ from the order amount at creation; the actual payment by the consumer is the correct value.
orderEntryAmount	String	Merchant received amount. The amount the merchant actually receives, which equals orderActualAmount - orderFee.
orderAmount	String	Original order amount. The amount initiated when the order was created.
orderFee	String	Order fee. Calculated based on the actual order amount (orderActualAmount).
orderPayTime	int64	Order payment time (Unix timestamp in milliseconds)
orderCompleteTime	int64	Order completion time (Unix timestamp in milliseconds)
errorMsg	String	Error message (in Chinese)
errorMsgEn	String	Error message (in English)
accountNo	String	Account number
accountType	String	Account type (e.g., CPF, CNPJ, EMAIL, etc.)
cashierId	String	Cashier ID
channelOrderId	String	Associated channel order number
currencyType	String	Fiat currency type code, enumeration value: BRL
externalOrderId	String	Merchant order number
notifyUrl	String	Callback URL after payment completion
orderId	String	System-generated order number
orderResourceType	int64	Business type of the order, enumeration value: 2 (Fiat order)
orderStatus	int64	Order status, enumeration values: 1, 2 (1 - Pending Payment, 2 - Payment Successful (Final State))
orderTime	int64	Order creation time (Unix timestamp in milliseconds)
orderType	int64	Order type, enumeration values: 1, 2 (1 - Collection, 2 - Payout)
payType	int64	Payment method type code, enumeration value: 101 (PIX)
tradeNote	String	Merchant note information
userId	String	User ID
payTypeCode	String	Description of payType, enumeration value: PIX
orderStatusCode	String	Description of orderStatus, enumeration values: Wait pay, Payment Successful
orderTypeCode	String	Description of orderType, enumeration values: Collection, Payout
userInfoName	String	User's name
userInfoNo	String	User's identification number
businessId	String	Merchant business ID

# Query Payout Orders

Request Method

POST

Request URL

/api/v3/bra/query/transferOrder

Request Type

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

Request Header Parameters

Param	Type	Description	Sample
access_key	String	Obtained from merchant backend	pFqV75X3
timestamp	int64	Unix timestamp (13 digits)	1679724896223
nonce	String	UUID V4	794c26b0-d33c-4394-b2bb-c485eca16d9e
sign	String	Calculated signature	kAXyh+eerqrefyaF8dyFB0M4FVo=

Request Example

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

Request Parameters Explanation

Param	Type	Required	Description
externalOrderId	String	Optional	Merchant Order Number
orderId	String	Optional	System Order Number
bankOrderId	String	Optional	Bank Order Number

Response Type

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

Response Example

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

Response Parameters Explanation

Param	Type	Description
bankOrderId	String	Bank Order Number
accountName	String	Account Name
accountNo	String	Account Number
accountType	String	Account Type
channelOrderId	String	Channel Order ID associated with the order
currencyType	String	Currency Type, enum value: BRL
errorMsg	String	Error Message
externalOrderId	String	Merchant Order Number
notifyUrl	String	Callback URL
orderAmount	String	Order Amount
orderActualAmount	String	Actual Order Amount
orderEntryAmount	String	Actual Amount Credited to Account
orderFee	String	Order Fee
orderCompleteTime	int64	Order Completion Time (timestamp)
orderPayTime	int64	Order Payment Time (timestamp)
orderId	String	System Order ID
orderResourceType	int64	Order Business Type, enum value: 2 (Fiat Currency Order)
orderStatus	int64	Order Status: 1-Processed, 2-Bank Processing, 4-Failed, 8-Success, 16-Failed (Final)
orderTime	int64	Order Initiation Time (timestamp)
orderType	int64	Order Type, enum value: 1 (Collection), 2 (Disbursement)
payType	int64	Payment Type, enum value: 201 (PIX)
tradeNote	String	Remarks
userId	String	Order Creator ID
payTypeCode	String	Description of payType, enum value: PIX
orderStatusCode	String	Description of orderStatus, enum values: Accepted, In Bank Processing, Bank Rejection, Completed, Failed
orderTypeCode	String	Description of orderType, enum values: Collection, Disbursement
userInfoName	String	User Information Name
userInfoNo	String	User Information ID Number (e.g., CPF)
businessId	String	Business ID
accountCode	String	Bank Account (EMAIL / PHONE / CPF / EVP, etc.)

← 2、Create payment out 4、 Query Balance →