Skip to content
Daily limits

Add Daily Limit

Create a new daily limit configuration.

Sets the daily withdrawal initial quota and the alarm level of the remaining daily quota for a given currency, tied to a specific combination of company bank name, bank account, and withdrawal method.

Request parameters

  • All configuration fields are wrapped in the params object.
  • Required: params.lb_bank_name (company bank name), params.lb_bank_account_ids (bank account), params.bank_operation_types_ids (withdrawal method), params.currency (currency), params.limit_amount (initial quota), and params.alarm_amount (alarm level of the remaining daily quota).
  • Optional: params.remark (remark).
  • See each field for its format, allowed values, default behavior, and business meaning.

Result

On success, the daily limit configuration is created. The response data does not contain additional business fields.

POSThttps://b-api.longbridge.xyz/atm/add/bank/balance

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

paramsobjectrequired

The set of fields that make up the daily limit configuration.

Child attributes
lb_bank_namestringrequired

Company bank name. This field is required.

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

lb_bank_account_idsstringrequired

Bank account, multi-select. Join multiple bank account ids with commas, for example 1001,1002; pass all to apply to every account under the selected company bank name. This field is required.

The available values depend on the selected lb_bank_name.

bank_operation_types_idsstringrequired

Withdrawal method, multi-select. Join multiple method ids with commas, for example 10,20; pass all to apply to every withdrawal method. This field is required.

The available values depend on the selected lb_bank_name and lb_bank_account_ids.

currencystringrequired

Currency. This field is required.

This dictionary is filtered by account channel. Values are dynamic; call GET /v1/datasets/refs/tenant_currencies_by_channel to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

limit_amountstringrequired

Daily initial quota, passed as a string-encoded amount. This field is required.

alarm_amountstringrequired

Alarm level of the remaining daily quota, passed as a string-encoded amount. An alert is triggered when the remaining daily quota falls below this value. This field is required.

remarkstring

Remark, optional. Free-text note recording additional information about this configuration.

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