Skip to content
Longport WhaleLongport Whale
Rate Setups Email

Billing Mail Action

Handle a billing configuration mail message (ignore or send).

Request parameters

  • Required: id (mail record ID), action_type (action type)
  • Optional: postscript (postscript / remark)
  • See each field description for format, value range, and business meaning.

Business notes

Ignore and send share the same endpoint, distinguished only by action_type; postscript can carry a processing note.

Risk warning

When action_type is send, this operation actually dispatches the billing-related mail. Confirm the target mail record and action type before calling.

Result

On success the mail message is processed; refer to the 200 response for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/billing/mail_action

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.ob_file_sending_list

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

Request body application/json

idstringrequired

Mail ID associated with this request.

action_typestringrequired

Specifies Action Type. This field is required.

Allowed values: 1 Send Email, 2 Skip, 3 Resend

Values
1
Send Email
2
Skip
3
Resend
postscriptstring

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