Skip to content
Longport WhaleLongport Whale
Withdrawal Configuration

Add Withdraw Prompt

Add Withdraw Prompt.

Request parameters

  • Required: region_codes (Region Codes), bank_ids (Bank IDs), currency (Currency), time_type (Time Type), time_left (Time Left), time_right (Time Right), priority (Priority), rule_status (Rule Status), prompts (Prompts)
  • See each field for its format, allowed values, and business meaning.

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/withdraw/prompt/add

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

region_codesarray<string>required

Submit Region Codes as a JSON array. This field is required.

bank_idsarray<string>required

Submit Bank IDs as a JSON array. This field is required.

currencystringrequired

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

time_typestringrequired

Specifies Time Type. This field is required.

time_leftstringrequired

Specifies Time Left. This field is required.

time_rightstringrequired

Specifies Time Right. This field is required.

prioritynumberrequired

Processing priority. Interpret the value and sort order according to the allowed-value definitions. This field is required.

rule_statusstringrequired

Specifies Rule Status. This field is required.

promptsarray<string>required

Each item contains amount_left/amount_right/plat_fee/bank_fee/arrive_time (all multilingual objects)/arrive_rule.

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