Send Reward · Whale Docs

POSThttps://b-api.longbridge.xyz/v1/whaleapi/reward/send_reward

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

request_idstringrequired

request_id

typestringrequired

奖励类型：cash

campaign_codestringrequired

campaign_code

cash_valueobject

现金奖励价值

Child attributes

currencystringrequired

现金币种

amountintegerrequired

现金数值

codestring

奖品 Code

remarkstring

remark

Responses

HTTP 200Fields are taken from the real responses definition for this operation in the published Whale OpenAPI spec (whale-openapi/Whale-openapi.json).

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

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/whaleapi/reward/send_reward' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "request_id": "<string>",
  "type": "<string>",
  "campaign_code": "<string>",
  "cash_value": {
    "currency": "<string>",
    "amount": 0
  },
  "code": "<string>",
  "remark": "<string>"
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "ref_no": "ceeeb96e52b2aa538c97037259c59834",
    "status": 12
  }
}