Skip to content
Longport WhaleLongport Whale
Reward Center

Send Reward

Grants a cash, physical, or voucher reward to a specified customer through an external interface.

Request parameters

  • Required: request_id (unique request ID; must be a 36-character UUID such as 3f1c2a9e-6b1d-4c1e-9a7a-2b9d1e0f4c55), member_id (customer ID of the recipient, not account_no or aaid), type (reward type), and campaign_code (campaign code).
  • Cash rewards (type is cash) require cash_value: currency is one of CNY, HKD, USD, SGD, and amount is a positive integer in cents.
  • Physical (merch) and voucher (coupon) rewards require code.
  • Optional: remark (up to 200 characters).
  • Example: {"request_id":"3f1c2a9e-6b1d-4c1e-9a7a-2b9d1e0f4c55","member_id":"10594038","type":"cash","campaign_code":"M20221130","cash_value":{"currency":"HKD","amount":100},"remark":"e2e"}.

Risk warning

This operation grants a real reward to the customer and changes funds or entitlements. Confirm the recipient, reward type, and amount before calling.

POSThttps://b-api.lbkrs.com/v1/whaleapi/reward/send_reward

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

reward_center.update_record

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

request_idstringrequired

Unique ID of the reward request; must be a 36-character UUID (such as 3f1c2a9e-6b1d-4c1e-9a7a-2b9d1e0f4c55).

member_idstringrequired

Customer ID (member_id) of the reward recipient; not the securities account number account_no or the aaid.

typestringrequired

Reward type: cash (cash), merch (physical item), or coupon (voucher).

Values
cash
merch
coupon
campaign_codestringrequired

campaign_code

cash_valueobject

Cash reward value

Child attributes
currencystringrequired

Cash currency. Required only for cash rewards.

Values
CNY
HKD
USD
SGD
amountintegerrequired

Cash amount in cents; a positive integer. Required only for cash rewards.

codestring

Prize code

remarkstring

Reward remark, up to 200 characters.

Responses

HTTP 200OK
Standard response envelopecodemessagedata
dataobjectdata structure
ref_nostringrequired

ref_no

statusintegerrequired

status

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs