Skip to content
Withdrawal Checks

Check Withdrawal Questionnaire

Checks, by withdrawal scenario, whether the Client must complete a questionnaire first. The Broker App calls it at two points. Before the Client confirms a withdrawal, it checks withdrawChangeBank and withdrawOversea and passes the bank card, amount, and currency of this withdrawal so that the service can evaluate the withdrawal ratio condition and information changes. After the withdrawal request is submitted, the result page checks withdrawHK and withdraw and passes is_all.

When result is true and hit_position is returned, guide the Client to the questionnaire for hit_position. If this happens before withdrawal, pause the submission. When the pre-withdrawal check returns a draft_id greater than 0, an unlinked questionnaire draft from the same day with the same withdrawal details already exists. Save the value and, after the withdrawal request succeeds, call POST /v1/questionnaire/submit to link the draft to the withdrawal request. Overwrite the saved value with each new check result, and clear it when draft_id is 0.

After the Client completes the questionnaire, this operation may still return result as true for the same scenario, so the Broker App must remember that the questionnaire for this withdrawal has been handled to avoid guiding the Client again. If this operation fails, the Broker App does not block the withdrawal flow. The same operation also decides whether questionnaires apply in other scenarios, such as deposits.

GEThttps://api.lbkrs.com/v2/questionnaire/has

Parameters

account_channelstringqueryRequired

Broker channel

positionsstringquery

Questionnaire scenarios to check, separated by commas. Pass only scenarios that the Broker has enabled and whose preconditions the Broker App has confirmed:

  • withdrawChangeBank - Bank card change questionnaire, checked before withdrawal. Precondition: the Client has at least 2 bound bank cards
  • withdrawOversea - Overseas withdrawal questionnaire, checked before withdrawal. Precondition: the Client is located in Greater China and the receiving bank card is outside it
  • withdrawHK - Hong Kong stock withdrawal questionnaire, checked after the withdrawal request is submitted
  • withdraw - General withdrawal questionnaire, checked after the withdrawal request is submitted
card_idintegerquery

Receiving bank card id of this withdrawal, from list[].id of “Get Withdrawal Bank Cards”. Pass it in the pre-withdrawal check

amountstringquery

Amount of this withdrawal. Pass it in the pre-withdrawal check

currencystringquery

Currency of this withdrawal, such as HKD. Pass it in the pre-withdrawal check

is_allbooleanquery

Whether the amount of this withdrawal equals the withdrawable maximum (max_amount). Pass it in the post-withdrawal check

Responses

HTTP 200The request succeeded. The response body contains the result of the “Check Withdrawal Questionnaire” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
resultboolean

Whether the Client must complete a questionnaire

hit_positionstring

Matched questionnaire scenario, using the same values as positions. Use it to decide which questionnaire to show

draft_idinteger

Id of the questionnaire draft that can be linked. 0 means there is no draft to link

Whale Docs