Skip to content
Account Transfers

Check Transfer Limit

Checks whether a cash or stock transfer exceeds an amount or count limit before submission. For a cash transfer, send type=1 with currency and transfer_balance. For a stock transfer, send type=0 without currency or amount.

If result is 0, continue with the submission. For any other value, stop the submission and explain the triggered limit to the Client using result and detail. Limits for currencies other than HKD are converted at the HKD exchange rate.

When calling through WhaleCore requestService(), set requiresTradeToken to true.

GEThttps://api.lbkrs.com/v1/app/risk_event_api/is_over_transfer_limit

Parameters

from_aaidstringqueryRequired

aaid of the source account

to_aaidstringqueryRequired

aaid of the destination account

typeintegerquery

Transfer type:

  • 1 - Cash transfer
  • 0 - Stock transfer

01

currencystringquery

Transfer currency, such as HKD. Send for cash transfers

transfer_balancestringquery

Amount to transfer as a decimal string. Send for cash transfers

Responses

HTTP 200The request succeeded. The response body contains the result of the “Check Transfer Limit” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
resultinteger

Check result:

  • 0 - Within limits
  • 1 - Daily transfer amount limit reached
  • 2 - Daily transfer count limit reached
  • 3 - Amount exceeds the per-transfer limit
Values
0
1
2
3
detailobject

The triggered limit. Returned when result is not 0

Child attributes
limitstring

Limit value: an amount when result is 1 or 3, or a count when result is 2

currencystring

Currency of the limit amount

Whale Docs