Skip to content
Longport WhaleLongport Whale
Auto Convert Query

Auto Repayment Enablement Query

Returns the enrollment status of clients' automatic repayment (auto currency-conversion repayment), letting operations and risk control see which clients have enabled auto repayment to cover debit or margin obligations.

Request parameters

  • Combine business filters through filters (optional fields are listed in the filter field descriptions below), and use page, page_size, and orderBy for pagination and sorting.

Business notes

Each record represents one client's enrollment status, including whether auto repayment is enabled, the enrollment source (for example, enabled by default at account opening), the client identifier, and the last update time.

Records can be filtered by client and enrollment status to audit the coverage of auto repayment in bulk.

Returns

On success, returns the matching records with pagination info. See the response definition for the meaning of each returned column.

POSThttps://b-api.lbkrs.com/v1/datasets/atm_auto_repayment_settings

Authorization

AuthorizationstringheaderRequired

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

Permission

margin_call.auto_convert_query

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

filtersobject

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

Child attributes
aaidstring

Select Customers. Filters results by Select Customers.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

is_autostring

Is Auto. Filters results by Is Auto.

Allowed values: true Open, false Closed

Values
true
Open
false
Closed
pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Auto Repayment Enablement Query records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: List of list.

Child attributes
idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

origin_idstring

Account No. Returned value: Account No.

real_namestring

Name. Returned value: Name.

member_idstring

Member ID. Returned value: Member ID.

is_autostring

Is Auto. Returned value: Indicates whether is auto.

is_auto_valstring

Is Auto (raw value). Raw value of is_auto. The is_auto field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

originstring

Origin. Returned value: Origin.

origin_valstring

Origin (raw value). Raw value of origin. The origin field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

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

updated_atstring

Updated At. Returned value: Updated At. The date or time format follows the value returned by the API.

totalintegerrequired

Total. 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

Whale Docs