Skip to main content
GET
/
trading
/
v5
/
account
/
{subAccountId}
/
user-rights
cURL
curl \
  -H "X-FH-APIKEY: $FINHAY_API_KEY" \
  -H "X-FH-TIMESTAMP: $TIMESTAMP_MS" \
  -H "X-FH-NONCE: $NONCE_UUID" \
  -H "X-FH-SIGNATURE: $SIGNATURE_HEX" \
  "https://open-api.fhsc.com.vn/trading/v5/account/$SUB_ACCOUNT_NORMAL/user-rights"

{
  "error_code": "0",
  "message": "success",
  "result": [
    {
      "accountId": "0001234567",
      "depositoryNumber": "0123456",
      "fullName": "Nguyen Van A",
      "ownNumberOfShare": 1000,
      "ratio": "1:1",
      "status": "COMPLETED",
      "userRightRegisterStatus": "RECEIVED",
      "caMastId": "CAM987",
      "amount": 1000000,
      "symbol": "VNM",
      "toSymbol": null,
      "numberOfWaitingStock": 0,
      "waitingAmountForReturn": 0,
      "rightOffRate": "0",
      "buyPrice": 0,
      "allowRegister": false,
      "totalStocksCanBuy": 0,
      "totalPayAmount": 0,
      "startDate": "2024-03-01",
      "finishDate": "2024-03-31",
      "startDateTransfer": "2024-03-05",
      "actionDate": "2024-03-15",
      "finishDateTransfer": "2024-03-20",
      "reportDate": "2024-03-15",
      "type": "CASH_DIVIDEND",
      "stockName": "CTCP Sữa Việt Nam",
      "totalVolume": 0,
      "totalValue": 0,
      "referencePrice": 72000,
      "closePrice": 72500,
      "ceilingPrice": 77500,
      "floorPrice": 67500,
      "predictPrice": 0,
      "changePrice": 500,
      "hasRead": true
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developers.fhsc.com.vn/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-FH-APIKEY
string
header
required

API key dài hạn của client. Cấu hình 1 lần lúc khởi tạo; có thể wire thẳng vào static setter của SDK tự-gen. Đi kèm với FINHAY_API_SECRET — secret này chỉ dùng ở phía client để tính X-FH-SIGNATURE, không bao giờ gửi qua mạng.

​
X-FH-TIMESTAMP
string
header
required

Unix time hiện tại tính bằng milliseconds, đưới dạng chuỗi số thập phân.

Được tính per-request bởi signing middleware. Không set thủ công — dùng middleware mẫu trong README.

​
X-FH-NONCE
string
header
required

UUIDv4 duy nhất per-request (ví dụ crypto.randomUUID()). Server cache cặp (apiKey, nonce) trong 5 phút; nếu nonce được reuse với cùng apiKey trong window này, request sẽ bị từ chối với AUTH_NONCE_REUSED (401).

Server chấp nhận chuỗi opaque bất kỳ về mặt kỹ thuật, nhưng nên dùng UUIDv4 để đảm bảo tính unique.

Được tính per-request bởi signing middleware. Không set thủ công — xem middleware mẫu trong tài liệu Authentication.

​
X-FH-SIGNATURE
string
header
required

HMAC-SHA256 của canonical signing payload, encode hex (lowercase).

Signing payload:

{X-FH-TIMESTAMP}\n{METHOD}\n{REQUEST_PATH}[?{QUERY}]\n{BODYHASH}
  • ?{QUERY} chỉ nối vào path khi request có query string.
  • {BODYHASH} là chuỗi rỗng khi body rỗng (vẫn không có newline sau đó).

Được tính per-request bởi signing middleware. Không set thủ công — dùng middleware mẫu trong README.

Path Parameters

​
subAccountId
string
required

subAccountId được lấy từ bootstrap flow (GET /users/v1/users/{userId}/sub-accounts), chọn NORMAL hoặc MARGIN tuỳ mục đích.

Example:

"0001234567"

Response

Trả về result mảng các quyền cổ đông của tiểu khoản, sort theo reportDate giảm dần.

Các field chung của envelope trong mọi response của Finhay API.

  • error_code là "0" (string) khi thành công, mã khác "0" khi lỗi.
  • message là thông điệp ngắn từ server.
​
result
object[]
required
​
error_code
string

"0" khi thành công, khác "0" khi lỗi.

Example:

"0"

​
message
string

Thông điệp trạng thái dễ đọc.

Example:

"success"