Withdrawal Rules · Whale Docs

GEThttps://b-api.longbridge.xyz/v1/datasets/atm_withdraw_package_rules

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Query parameters

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

idstring

Filters results by Withdrawal Rule ID.

lb_bank_channel_idstring

Filters results by Withdraw Channel.

Values are dynamic. Call GET /v1/datasets/refs/company_bank_channels to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

package_typestring

Filters results by Withdrawal Policy.

Allowed values:

1 - Real Time Payment Of Single Order
2 - Manual Review Of Timed Packing
3 - Manual Packing
4 - Batch Auto

1 · Real Time Payment Of Single Order2 · Manual Review Of Timed Packing3 · Manual Packing4 · Batch Auto

support_regionstring

Filters results by Supported Bank Types.

Values are dynamic. Call GET /v1/datasets/refs/cash_notice_bank_region to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

support_bank_idsstring

Filters results by Supported Bank Name.

Values are dynamic. Call GET /v1/datasets/refs/cash_notice_region_bank_name to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

statusstring

Filters results by Status.

Allowed values:

1 - Enabled
2 - Disabled

1 · Enabled2 · Disabled

audit_statusstring

Filters results by Audit Status.

Allowed values:

0 - Init
1 - New pending review
2 - Waiting Edit Review
3 - Delete pending approval

0 · Init1 · New pending review2 · Waiting Edit Review3 · Delete pending approval

original_limitstring

Filters results by Original Limit.

Allowed values:

0 - Unrestricted
1 - Restricted

0 · Unrestricted1 · Restricted

rule_codesstring

Filters results by Hit Rules.

Values are dynamic. Call GET /v1/datasets/refs/risk_rule_indicators_withdraw to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Withdrawal Rules records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

idstring

Returned value: Unique identifier of the current record.

original_limitstring

Returned value: Original Limit.

original_limit_valstring

Raw value of original_limit. The original_limit field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

rule_codesstring

Returned value: Hit Rules.

rule_codes_valstring

Raw value of rule_codes. The rule_codes field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

custom_lb_bank_channel_idstring

Returned value: Withdraw Channel.

custom_original_limit_accountsstring

Returned value: Withdrawal Account.

custom_original_limit_accounts_valstring

Raw value of custom_original_limit_accounts. The custom_original_limit_accounts field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

fee_bank_account_idstring

Returned value: Service fee account.

fee_bank_account_id_valstring

Raw value of fee_bank_account_id. The fee_bank_account_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

package_typestring

Returned value: Withdrawal Policy.

package_type_valstring

Raw value of package_type. The package_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

batch_max_countstring

Returned value: Batch Maximum Number.

charge_typestring

Returned value: Charge Type.

custom_single_quota_currency_amountstring

Returned value: Supported Currencies & Single Limit.

custom_service_timestring

Returned value: Bank Service Counter. The date or time format follows the value returned by the API.

custom_lb_service_timestring

Returned value: Company Service Period. The date or time format follows the value returned by the API.

support_regionstring

Returned value: Bank Region.

support_region_valstring

Raw value of support_region. The support_region field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

support_bank_idsstring

Returned value: Supported Bank List Name.

support_bank_ids_valstring

Raw value of support_bank_ids. The support_bank_ids field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

sec_auth_showstring

Returned value: Bank Securities Supported?.

sec_auth_show_valstring

Raw value of sec_auth_show. The sec_auth_show field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

prioritystring

Returned value: Priority.

statusstring

Returned value: Status.

status_valstring

Raw value of status. The status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

audit_statusstring

Returned value: Audit Status.

audit_status_valstring

Raw value of audit_status. The audit_status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

Returned value: Created Time. The date or time format follows the value returned by the API.

updated_atstring

Returned value: Update Time. The date or time format follows the value returned by the API.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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 --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/atm_withdraw_package_rules' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "10000006675",
        "original_limit": "Unrestricted",
        "original_limit_val": "0",
        "rule_codes": "All",
        "rule_codes_val": "all",
        "custom_lb_bank_channel_id": "DBS016DBS_API_原路退回",
        "custom_original_limit_accounts": "Bank Name:DBS\nBank Account：0725865530\nAbbreviation：DBS016DBS\nSwift Code：DBSSSGSGXXX",
        "custom_original_limit_accounts_val": "119",
        "fee_bank_account_id": "示例用户",
        "fee_bank_account_id_val": "示例用户",
        "package_type": "Real Time Payment Of Single Order",
        "package_type_val": "1",
        "batch_max_count": "100",
        "charge_type": "SHA",
        "custom_single_quota_currency_amount": "Currency: HKD Amount: 1,111,111.00",
        "custom_service_time": "HK Trading Day:00:00:00-13:00:00",
        "custom_lb_service_time": "HK Trading Day:00:00:00-23:00:00",
        "support_region": "",
        "support_region_val": "",
        "support_bank_ids": "",
        "support_bank_ids_val": "",
        "sec_auth_show": "NO",
        "sec_auth_show_val": "0",
        "priority": "998",
        "status": "Enabled",
        "status_val": "1",
        "audit_status": "Init",
        "audit_status_val": "0",
        "created_at": "1784172062",
        "updated_at": "1784172177"
      }
    ],
    "total": 1
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/atm_withdraw_package_rules/download

Export options Export records Download result