Skip to content
Reward Locks

Get Reward Locks Affected by Withdrawal

Returns the reward-lock campaigns the Client participates in that a withdrawal would disqualify or charge a campaign fee for. Used by the reward forfeiture confirmation page before withdrawal.

Show each item to the Client with the campaign name, reward, reward status, campaign requirements, and consequence (violate_type), and choose the confirmation copy according to whether the list contains 1 (loss of eligibility), 2 (fee deduction), or both. After the Client agrees, resubmit the withdrawal by calling POST /v5/portfolio/withdraw again with confirm=1. When activities is empty, you do not need to show the confirmation page.

GEThttps://api.lbkrs.com/rewards/lock_activities

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Reward Locks Affected by Withdrawal” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
activitiesarray<object>

Affected reward-lock campaigns

Child attributes
activity_namestring

Campaign name

campaign_codestring

Campaign code

remarkstring

Description of the campaign requirements

disclaimer_urlstring

URL of the campaign rules page. When empty, do not show a rules entry

reward_typestring

Reward type:

  • 0 - Cash
  • 1 - Physical item
  • 2 - Card or coupon
Values
0
1
2
goods_namestring

Reward name. Use it to show the reward when reward_type is not 0

amountstring

Amount in cents (for example, 10000 means 100.00). When reward_type is 0, it is the cash reward amount; when violate_type is 2, it is also the campaign fee deducted from the account balance

currencystring

Currency of amount, such as HKD

violate_typestring

Consequence of withdrawing:

  • 1 - The Client loses campaign eligibility and forfeits further rewards
  • 2 - A campaign fee is deducted from the account balance
Values
1
2
statusstring

Reward issuance status:

  • 1 - Pending
  • 2 - Partially issued
  • 3 - Issued
Values
1
2
3
Whale Docs