Activate or Claim Voucher/Card

POSThttps://api.lbkrs.com/rewards/activate_card

Request body application/json

card_idstringrequired

Card/Coupon id

aaidstring

Target account aaid; provided when activating cash or stock cards in multi-account scenarios

account_channelstring

Broker channel; provided when activating cash cards or stock cards in multi-account scenarios

display_idstring

Target account display id (account). Provided when activating cash or stock cards in multi-account scenarios

counter_idstring

Stock id of the underlying used for redemption for face-value stock cards; provided when activating this type of stock card

sharesstring

Number of shares to be redeemed for face-value stock cards (calculated at intraday price); provided when activating this type of stock card

Responses

HTTP 200The request succeeded. The response body contains the result of the “Activate or claim voucher/card” operation.

Standard response envelopecodemessagedata

dataobjectdata structure

start_timestring

Start timestamp (seconds)

end_timestring

Expiry timestamp (seconds)

card_statusinteger

Coupon/voucher status：

0 - Not activated
1 - Used
2 - Expired
3 - Locked
4 - Activated

01234

activate_timestring

Voucher/card activation timestamp (seconds)

coupon_idstring

Third-party id for coffee voucher; returned only when activating a coffee voucher

Request

let request = WhaleCoreHTTPRequest(
    method: .post,
    path: "/rewards/activate_card"
)
request.body = [
    "card_id": "<CARD_ID>"
]

let response = try await WhaleCoreService.requestService.send(request)
print(response.bodyString)

Example response

{
  "code": 0,
  "message": "success",
  "data": {
    "start_time": "<START_TIMESTAMP>",
    "end_time": "<END_TIMESTAMP>",
    "card_status": 4,
    "activate_time": "<ACTIVATION_TIMESTAMP>",
    "coupon_id": ""
  }
}