Skip to content
Funds Alloc Config

Create Whale Package Rule

Create Whale Package Rule.

Request parameters

  • Required: transfer_type (Transfer Type), from_type (From Type), from_main_account (From Main Account), from_main_account_type (From Main Account Type), from_account_id (From Account ID), to_type (To Type), to_main_account (To Main Account), to_main_account_type (To Main Account Type), to_account_id (To Account ID), allocation_channel (Allocation Channel), transfer_strategy (Transfer Strategy), package_type (Package Type), currency (Currency), amount (Amount), status (Status)
  • Optional: service_time (Service Time), postscript (Postscript)
  • See each field for its format, allowed values, and business meaning.

Risk notice

This operation may change real cash balances, positions, or transaction state. Verify the target records and parameters before calling it.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

POSThttps://b-api.longbridge.xyz/atm/whale/package/rule

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

transfer_typestringrequired

Specifies Transfer Type. This field is required.

from_typestringrequired

Specifies From Type. This field is required.

from_main_accountstringrequired

Specifies From Main Account. This field is required.

from_main_account_typestringrequired

Specifies From Main Account Type. This field is required.

from_account_idstringrequired

From Account ID associated with this request.

to_typestringrequired

Specifies To Type. This field is required.

to_main_accountstringrequired

Specifies To Main Account. This field is required.

to_main_account_typestringrequired

Specifies To Main Account Type. This field is required.

to_account_idstringrequired

To Account ID associated with this request.

allocation_channelstringrequired

Specifies Allocation Channel. This field is required.

transfer_strategystringrequired

Specifies Transfer Strategy. This field is required.

package_typestringrequired

Specifies Package Type. This field is required.

currencystringrequired

Currency code used for this request. This field is required.

amountstringrequired

Amount involved in this business operation. This field is required.

service_timestring

Specifies Service Time.

postscriptstring

Specifies Postscript.

statusstringrequired

Fund-transfer rule status. This field is required.

Allowed values:

  • 1 - Enabled
  • 2 - Disabled

12

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

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

Whale Docs