corporate refund announcement details

POSThttps://b-api.longbridge.xyz/v1/datasets/corp_action_refund_announcement_details

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_corporate.corporate_query

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

Request body application/json

filtersobject

Filters

Child attributes

ann_idstringrequired

Ann Id

pageinteger

Page

page_sizeinteger

Page Size

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

Child attributes

idstring

ann_idstring

Ann Id

origin_idstring

Origin Id

refundment_idstring

Refundment Id

aaidstring

Aaid

aaid_valstring

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

stock_fee_detail_idstring

Stock Fee Detail Id

exec_statestring

Exec State

refund_fee_codestring

Refund Fee Code

amountstring

Amount

adjust_amountstring

Adjust Amount

currencystring

Currency

is_revokestring

Is Revoke

revoked_refundment_detail_idstring

Revoked Refundment Detail Id

remarkstring

Remark

created_atstring

Created At

original_charge_amountstring

Original Charge Amount

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

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/corp_action_refund_announcement_details' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "string",
        "ann_id": "string",
        "origin_id": "string",
        "refundment_id": "string",
        "aaid": "string",
        "aaid_val": "string",
        "stock_fee_detail_id": "string",
        "exec_state": "string",
        "refund_fee_code": "string",
        "amount": "string",
        "adjust_amount": "string",
        "currency": "string",
        "is_revoke": "string",
        "revoked_refundment_detail_id": "string",
        "remark": "string",
        "created_at": "string",
        "original_charge_amount": "string"
      }
    ],
    "total": 1
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/corp_action_refund_announcement_details/download

lb_hk_corporate.corporate_query

Export options Export records Download result