Skip to content
Longport WhaleLongport Whale
Withdrawal - Pending

Withdrawal - Pending - Batch List

Queries the withdrawal batches in withdrawal processing, used to manage packaged batch payouts.

Request parameters

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

Business notes

The data comes from withdrawal batches joined with their disbursing channel, bank account, and ticket information; each record represents a batch that packages multiple withdrawals for disbursement.

A record carries the batch number, batch name, disbursing channel, batch status, total count, total amount, total fee, disbursing bank account and fee account, applicant, auditor, batch source, auto-withdrawal rule number, associated ticket number, and creation/update times.

It is commonly used to search batches by batch number, disbursing channel, and creation time, and to track the review and disbursement progress of batch payouts.

Returns

On success, returns the matching records and pagination information. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

cmbc.withdraw_batch

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

Request body application/json

filtersobject

Filters

Child attributes
idstring

Batch No.

lb_bank_channel_idstring

Withdraw Channel. Values are dynamically queried from atm_select_lb_bank_channel_id_name (not fixed); fetch them live via GET /v1/datasets/refs/withdraw_company_bank_channels.

created_atobject

Created Time. Range filter; both bounds are optional (omit a bound to leave that side unbounded). Defaults to the range [6 day(s) ago, today] when omitted (gte/lte roll with the request date).

Child attributes
gtestring

Greater Than or Equal

ltestring

Less Than or Equal

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
idstring

Batch No.

batch_namestring

Batch Name

lbc_namestring

Bank Channel

statestring

Status

state_valstring

Status (raw value). Raw value behind field state: state returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

counterstring

Total Records

detail_currency_amountsstring

Total Amount

detail_currency_feesstring

Total Fees

lb_bank_account_idstring

Withdrawal Bank Account Info

lb_bank_account_id_valstring

Withdrawal Bank Account Info (raw value). Raw value behind field lb_bank_account_id: lb_bank_account_id returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

fee_bank_account_idstring

Service fee account

fee_bank_account_id_valstring

Service fee account (raw value). Raw value behind field fee_bank_account_id: fee_bank_account_id returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

applicantstring

Applicant

applicant_valstring

Applicant (raw value). Raw value behind field applicant: applicant returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

auditorstring

Auditor

auditor_valstring

Auditor (raw value). Raw value behind field auditor: auditor returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

origin_fromstring

Origin Form

origin_from_valstring

Origin Form (raw value). Raw value behind field origin_from: origin_from returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

created_atstring

Created Time

updated_atstring

Update Time

rule_idstring

Withdrawal Rule ID

totalintegerrequired

Total

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