Skip to content
Longport WhaleLongport Whale
VA Clearing

Get Current VA Clearing Business Status

Get Current VA Clearing Business Status.

Request parameters

This endpoint does not accept business parameters.

Result

On success, the endpoint returns the requested data. See the 200 response schema for field definitions.

GEThttps://b-api.lbkrs.com/billing/va/current_busin

Production: https://b-api.lbkrs.com · Test: https://b-api.longbridge.xyz

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.billing_va_contracts

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

Responses

HTTP 200The request was processed successfully. data contains records.
Standard response envelopecodemessagedata
dataobjectdata structure
recordsarray<object>

Clearing Step Records. Returned value: List of clearing step records.

Child attributes
statenumber

State. 0=Pending, 1=In progress, 2=Success, 3=Failed

0 · Pending1 · In Progress2 · Success3 · Failed

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