Broker API documentation
Broker API documentation
These pages organize the /mer-api/v1 interfaces used by Finger Admin customer, order, and risk-control workflows. They are served by the merchant BFF; availability and authorization depend on the broker account and assigned permissions.
Broker API documentation
These pages organize the /mer-api/v1 interfaces used by Finger Admin customer, order, and risk-control workflows. They are served by the merchant BFF; availability and authorization depend on the broker account and assigned permissions.
Merchant BFF base URL and authentication
Send JSON POST requests to the selected merchant BFF environment. The Finger Admin client sends its signed-in broker-staff access token in the Authorization header as a Bearer token.
Authorization: Bearer <BROKER_STAFF_ACCESS_TOKEN>
Browse API groups
Customer list
Paged customer search; query keys are based on UserQueryDTO.
/mer-api/v1/customer/listRequest example
{
"page": 1,
"pageSize": 20,
"query": {
"userNumber": "",
"brokerNumber": "",
"marketType": 0,
"startTime": "",
"endTime": ""
}
}Request fields
pagenumberpageSizenumberqueryobjectResponse example
Examples are illustrative. Replace identifiers with values from your authorized account. Response payload shapes are examples inferred from Finger Admin client usage; confirm the exact contract with your broker. Configuration and order-action requests can change live data.
{
"code": 0,
"data": {
"total": 1,
"items": [
{
"id": "sample-id",
"userNumber": "U10001",
"status": 1
}
]
},
"msg": "success"
}Try this request · /mer-api/v1/customer/list
Ready. The request is not sent until you press Send.
Response—
The token is held only in this page session and is not saved by this documentation page. Avoid shared devices and clear the token when finished.
Market order pool
Queries the market order pool using MarketQueryDTO.
/mer-api/v1/order/market-order-listRequest example
{
"marketType": 0
}Request fields
marketTypenumberResponse example
Examples are illustrative. Replace identifiers with values from your authorized account. Response payload shapes are examples inferred from Finger Admin client usage; confirm the exact contract with your broker. Configuration and order-action requests can change live data.
{
"code": 0,
"data": {
"total": 1,
"items": [
{
"id": "sample-id",
"userNumber": "U10001",
"status": 1
}
]
},
"msg": "success"
}Try this request · /mer-api/v1/order/market-order-list
Ready. The request is not sent until you press Send.
Response—
The token is held only in this page session and is not saved by this documentation page. Avoid shared devices and clear the token when finished.
Customer open positions
Paged customer holdings query.
/mer-api/v1/order/get-user-order-holding-listRequest example
{
"page": 1,
"pageSize": 20,
"query": {
"userNumber": "",
"brokerNumber": "",
"marketType": 0,
"startTime": "",
"endTime": ""
}
}Request fields
pagenumberpageSizenumberqueryobjectResponse example
Examples are illustrative. Replace identifiers with values from your authorized account. Response payload shapes are examples inferred from Finger Admin client usage; confirm the exact contract with your broker. Configuration and order-action requests can change live data.
{
"code": 0,
"data": {
"total": 1,
"items": [
{
"id": "sample-id",
"userNumber": "U10001",
"status": 1
}
]
},
"msg": "success"
}Try this request · /mer-api/v1/order/get-user-order-holding-list
Ready. The request is not sent until you press Send.
Response—
The token is held only in this page session and is not saved by this documentation page. Avoid shared devices and clear the token when finished.
User matching configuration
Reads the matching configuration for a market/user context.
/mer-api/v1/trade/user-match-configRequest example
{
"marketType": 0
}Request fields
marketTypenumberResponse example
Examples are illustrative. Replace identifiers with values from your authorized account. Response payload shapes are examples inferred from Finger Admin client usage; confirm the exact contract with your broker. Configuration and order-action requests can change live data.
{
"code": 0,
"data": {
"id": "sample-id",
"status": 1
},
"msg": "success"
}Try this request · /mer-api/v1/trade/user-match-config
Ready. The request is not sent until you press Send.
Response—
The token is held only in this page session and is not saved by this documentation page. Avoid shared devices and clear the token when finished.