Skip to content
Statement Query

Send Statement

Send statements to customers in bulk.

Request parameters

  • Required: force_send (whether to force sending)
  • Optional: ids (statement ID list), type (statement type), dt (statement date), total_notify_allowed (whether the aggregate notification is allowed)
  • See each field description for format, value range, and business meaning.

Business notes

Targets specific statements via ids, or a range via type and dt. For a batch send by range, the admin console sends type, dt, total_notify_allowed: true, and force_send: false; if the backend returns error 820513 (confirmation required), it resends the same request with force_send: true.

Risk warning

This operation actually sends statements and notifications to customers. Confirm the target scope and parameters before calling.

Result

On success the statements are sent in bulk; refer to the 200 response for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/statement/send_statement

Authorization

AuthorizationstringheaderRequired

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

Permission

b2b_statement.list

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

Request body application/json

idsarray<string>

Statement record IDs to send, taken from the id field of atm_statement_histories rows. When sending specific records, the admin console also passes type (the row's file_type_val) and dt (the row's dt) with force_send set to true.

typestring

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

dtstring

Date associated with this request. Use the date format defined by the API.

total_notify_allowedboolean

Boolean flag for total notify allowed.

Boolean values:

  • true - The condition applies
  • false - The condition does not apply
force_sendbooleanrequired

Boolean flag for force send. this field is required.

Boolean values:

  • true - The condition applies
  • false - The condition does not apply

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
okboolean
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