Skip to content
FX Pool Limit Configuration

Add Exchange Balance

Add Exchange Balance.

Request parameters

  • Required: params (Params)
  • 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/add/exchange/balance

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

paramsobjectrequired

The client wraps the request fields under a params key: currency (dropdown, enum from the ref tenant_currencies_for_exchange), alarm_amount (alert amount, required), remaining_amount (remaining limit, optional), and remark (optional).

Call GET /v1/datasets/refs/tenant_currencies_for_exchange to retrieve the current data dictionary, and use the returned entry's key as this field's value.

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