Skip to content
Longport WhaleLongport Whale
Withdrawal Configuration

Withdrawal Configuration

Query the withdrawal-parameter configuration.

Request parameters

  • Combine business filter conditions through filters (see the filter-field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Maintains withdrawal-related parameter rules — rule status and rule name; used to configure prompts and parameter control in the withdrawal flow.

Returns

On success, returns the matching record list with pagination information. See the response schema for the meaning of each returned column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

withdrawalparameter.withdrawal_parameter_query

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

Request body application/json

filtersobject

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

Child attributes
idstring

Filters results by Id.

rule_statusstring

Filters results by Status.

Allowed values: 1 Enabled, 2 Disabled

Values
1
Enabled
2
Disabled
rule_namestring

Filters results by Rule Name.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Withdrawal Configuration 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.

region_codesstring

Returned value: Bank Region.

region_codes_valstring

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

bank_idsstring

Returned value: Bank Name.

bank_ids_valstring

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

custom_timestring

Returned value: Submission Deadline. The date or time format follows the value returned by the API.

currencystring

Returned value: Currency.

prioritystring

Returned value: Priority.

rule_statusstring

Returned value: Status.

rule_status_valstring

Raw value of rule_status. The rule_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 At. 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.

modify_operatorstring

Returned value: Modify Operator.

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

Whale Docs