Skip to main content

Query Order

Process​

Description:

  • Merchant calls this API to retrieve detailed information about an order.

API Information​

Method: POST

URL: /b2b/core/api/ext/mm/order/get-order

Request​

Main Parameters​

NoParameterData TypeRequiredDescription
1request_idString✅Request ID
2request_timeDatetime✅Request time. Format: YYYY-MM-DD H:m:s
3master_merchant_codeString(50)❌Master merchant code provided by Baokim
4sub_merchant_codeString(50)❌Sub merchant code provided by Baokim
5mrc_order_idString✅Merchant order ID

Request Example​

{
"request_id": "7T53RI2IDS5JWAF",
"request_time": "2023-08-18 10:00:00",
"master_merchant_code": "BAOKIMMASTERMERCHANT",
"sub_merchant_code": "BAOKIMSUBMERCHANT",
"mrc_order_id": 24121706176582
}

Response​

Main Parameters​

NoParameterData TypeRequiredDescription
1codeInteger✅Result code
2messageString✅Status message
3dataObject✅Response data

Order Information (data.order)​

NoParameterData TypeRequiredDescription
1idInteger✅Baokim order ID
2mrc_order_idString✅Merchant order ID
3total_amountInteger✅Order amount
4payment_methodInteger✅Payment method
5statusInteger✅Order status (see table below)
6completed_atDatetime✅Success time
7created_atDatetime✅Creation time
8updated_atDatetime✅Last update time

Order Status Information (data.order.status)​

ValueStatus
0Created
1Success
2Rejected
3Pending approval
4Pending FX conversion
5Processing
6Pending prepayment
7Expired
8Refunding
9Refunded

Transaction Information (data.transactions)​

NoParameterData TypeRequiredDescription
1idInteger✅Baokim transaction ID
2typeInteger✅Transaction type: 1 = Payment, 2 = Refund
3payment_methodInteger✅Payment method
4sub_merchant_feeInteger✅Sub merchant fee
5master_merchant_feeInteger✅Master merchant fee
6user_feeInteger✅User fee
7total_amountInteger✅Total amount customer pays after fees
8amountInteger✅Amount of sub merchant balance change
9descriptionString✅Transaction content
10statusInteger✅Status: 0 = Created, 1 = Success, 2 = Failed, 3 = Pending
11completed_atDatetime✅Success time
12created_atDatetime✅Creation time
13updated_atDatetime✅Last update time
14bnplObject❌BNPL information (if applicable)
15installmentObject❌Installment information (if applicable)
16ft_numberString❌Bank transaction reference number (FT number), may be null

Transaction BNPL Information (data.transactions.bnpl)​

NoParameterData TypeRequiredDescription
1payment_per_monthInteger❌Monthly payment amount
2paylater_amountInteger❌Pay later amount
3down_paymentInteger❌Down payment amount
4providerInteger❌BNPL provider

Transaction Installment Information (data.transactions.installment)​

NoParameterData TypeRequiredDescription
1card_brandInteger❌Card brand
2periodInteger❌Installment period
3payment_per_periodInteger❌Payment per period
4bank_codeInteger❌Bank code

Response Example​

{
"code": 200,
"message": "Lấy đơn hàng thành công!",
"data": {
"order": {
"id": 1080000,
"mrc_order_id": "TT1790310848",
"total_amount": 3000000,
"payment_method": 1,
"status": 1,
"completed_at": "2026-09-25 11:35:44",
"created_at": "2026-09-25 11:34:10",
"updated_at": "2026-09-25 11:35:44"
},
"transactions": [
{
"id": 10000106,
"type": 1,
"payment_method": 3,
"sub_merchant_fee": 30000,
"master_merchant_fee": 0,
"user_fee": 70000,
"total_amount": 3070000,
"amount": 2970000,
"description": null,
"status": 2,
"completed_at": null,
"created_at": "2026-09-25 11:34:53",
"updated_at": "2026-09-25 11:35:44",
"bnpl": null,
"installment": null,
"ft_number": null
},
{
"id": 10000107,
"type": 1,
"payment_method": 1,
"sub_merchant_fee": 30000,
"master_merchant_fee": 30000,
"user_fee": 70000,
"total_amount": 3070000,
"amount": 2970000,
"description": null,
"status": 1,
"completed_at": "2026-09-25 11:35:44",
"created_at": "2026-09-25 11:35:19",
"updated_at": "2026-09-25 11:35:44",
"bnpl": null,
"installment": null,
"ft_number": null
}
]
}
}

Error Codes​

Error CodeDescription
102Provider error
104Authentication error
710Sub merchant does not exist
711Master merchant does not exist
712Sub merchant is not active
713Master merchant is not active
714Sub merchant does not belong to master merchant