Query Transaction

Process

Description:

• Merchant calls the API to query detailed information about BNPL transactions by order code.
• Baokim searches for transactions based on the parameters sent by MERCHANT and returns a list of transactions that meet the request.

API Information

Method: GET

Request

(Parameters sent by the partner)

Main Parameters Table

No.	Field Name	Data Type	Required	Description
1	request_id	String(100)	✅	Unique ID of the request from Merchant to Baokim
2	request_time	String(20)	✅	Request sent time. Format: YYYY-MM-DD H:i:s
3	merchant_code	String(50)	✅	Unique merchant identifier
4	mrc_order_id	String(50)	✅	Unique transaction code sent by the partner (generated by the partner, can be considered as order code)

Request Example

{
  "request_id": "MERCHANT050015588AXE014",
  "request_time": "2020-08-11 14:41:00",
  "merchant_code": "MERCHANT",
  "mrc_order_id": "VLAD_1753867524"
}

Response

(Parameters returned by Baokim)

Main Parameters Table

No.	Field Name	Data Type	Required	Description
1	code	Number(3)	✅	Baokim error code
2	message	String(200)	✅	Error code message
3	data	Object	✅	Data returned

Data Information

No.	Field Name	Data Type	Required	Description
1	order_id	Number	✅	Baokim order code
2	mrc_order_id	String(50)	✅	Merchant order code
3	merchant_code	String(50)	✅	Unique identifier for partner: MERCHANT
4	customer_name	String(200)	✅	Full customer name, no accents, with spaces
5	customer_phone	String(10)	✅	Customer phone number
6	customer_email	String(255)	✅	Customer email
7	customer_address	String(500)	✅	Customer address
8	package_code	String(255)	✅	Loan package code
9	name	String(20)	✅	Loan package name
10	period	Number	✅	Term (1, 3, 6, 9, 12 months)
11	min_amount	Number	✅	Minimum amount to apply for this loan package
12	max_amount	Number	✅	Maximum amount to apply for this loan package
13	down_payment_percent	Number	✅	% of down payment amount
14	down_payment_amount	Number	✅	Down payment amount
15	original_amount	Number	✅	Order amount
16	merchant_fee	Number	✅	Merchant fee
17	total_paylater_amount	Number	✅	Total deferred payment amount (fees included)
18	payment_per_period	Number	✅	Payment amount per period
19	total_amount	Number	✅	Total amount user needs to pay (down payment + deferred payment)
20	difference_amount	Number	✅	Amount difference compared to straight payment
21	provider_code	String(20)	✅	Finance organization name
22	description	String(255)	✅	Order description
23	url_success	String(255)	✅	URL redirect when loan approval is successful
24	url_fail	String(255)	✅	URL redirect when loan approval fails
25	status	Number	✅	Order status
26	extension	Object	✅	Extended information (product list)
27	created_at	Datetime	✅	Order creation time
28	updated_at	Datetime	✅	Order update time

Extension Information

No.	Field Name	Data Type	Required	Description
1	items	Array	✅	List of product objects

Items Information

No.	Field Name	Data Type	Required	Description
1	item_code	String(50)	✅	Product code
2	item_name	String(255)	✅	Product name
3	item_amount	Number	✅	Product price
4	quantity	Number	✅	Product quantity
5	url	String(500)	✅	Product link

Response Example

{
  "code": 0,
  "message": "Success",
  "data": {
    "order_id": 1870436,
    "mrc_order_id": "VLAD_1753867524",
    "merchant_code": "MERCHANT",
    "customer_name": "Nguyễn Trung Quân",
    "customer_phone": "0394827170",
    "customer_email": "[email protected]",
    "customer_address": "40, ngách 16/255 đường Láng, Đống Đa, Hà Nội",
    "package_code": "homecredit_1month",
    "name": "Home Credit 1 month",
    "period": 1,
    "min_amount": 1000000,
    "max_amount": 500000,
    "down_payment_percent": 20,
    "down_payment_amount": 2000000,
    "original_amount": 10000000,
    "user_fee": 0,
    "merchant_fee": 100000,
    "total_paylater_amount": 8000000,
    "payment_per_period": 8000000,
    "total_amount": 10100000,
    "difference_amount": 100000,
    "document_required": "CCCD",
    "provider_code": "HOMECREDIT",
    "description": "Deferred payment order",
    "url_success": "https://example.com/success",
    "url_fail": "https://example.com/fail",
    "status": 1,
    "extension": {
      "items": [
        {
          "item_id": 123456,
          "item_code": "AEIQ_4562",
          "item_name": "Máy tính xách tay ABC",
          "item_amount": 10000000,
          "quantity": 1,
          "url": "https://example.com/product-detail"
        }
      ]
    },
    "created_at": "2020-08-11 14:41:00",
    "updated_at": "2020-08-11 15:41:00"
  }
}

Error Codes

Error Code	Description
100	Success
101	System error
102	Provider error
104	JWT authentication error
105	Invalid digital signature
106	Order amount is insufficient for refund
107	Order cannot be refunded
108	Order cannot be cancelled
109	Order does not exist
110	Merchant order code already exists
422	Validation error