EDDA · Whale Docs

GEThttps://b-api.longbridge.xyz/v1/datasets/atm_edda_applications

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

Authorizationstringheaderlb_hk_edda.edda_queryRequired

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

Query parameters

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes

idstring

ID. Filters results by ID.

member_idstring

Member ID. Filters results by Member ID.

mandate_identificationstring

Authorization No.. Filters results by Authorization No..

user_bank_card_nostring

Client Bank Account No. Filters results by Client Bank Account No.

lb_bank_account_namestring

Beneficiary Bank Name. Filters results by Beneficiary Bank Name.

Values are dynamic. Call GET /v1/datasets/refs/receiving_bank_accounts_with_names to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

created_atobject

Created At. Filters results by Created At.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

statestring

Status. Filters results by Status.

Allowed values:

0 - Pending Review
1 - Activating
2 - Activated
3 - Denied
4 - Closed
5 - Expired
8 - Canceled

0123458

verify_statestring

Manual Confirmation. Filters results by Manual Confirmation.

Allowed values:

0 - Processing not required
1 - Pending Processing
3 - Confirmed
4 - Expired

0134

bank_codestring

Bank Code. Filters results by Bank Code.

referencestring

Reference No. Filters results by Reference No.

currencystring

Auth Currency. Filters results by Auth Currency.

Allowed values: HKD, CNH

HKDCNH

auth_typestring

Authorization Type. Filters results by Authorization Type.

Allowed values:

0 - Unmatched
1 - App Direct Initiation
2 - Initiated Via Online Banking
3 - Initiated Via Bank Counter

0123

bank_sec_fail_reasonstring

Error/Exception Remarks. Filters results by Error/Exception Remarks.

updated_atobject

Updated At. Filters results by Updated At.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

app_showstring

Display to Client. Filters results by Display to Client.

Allowed values:

0 - NO
1 - YES

01

busi_typestring

Approval Status. Filters results by Approval Status.

Allowed values:

0 - Initial
45 - Activate Pending
49 - Deactivate Pending
37 - Pending Review
36 - Delete To Approve

045493736

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated EDDA records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List. Returned value: List of list.

Child attributes

idstring

ID. Returned value: Unique identifier of the current record.

mandate_identificationstring

Authorization No.. Returned value: Authorization No..

auth_typestring

Authorization Type. Returned value: Authorization Type.

auth_type_valstring

Authorization Type (raw value). Raw value of auth_type. The auth_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

app_showstring

Display to Client. Returned value: Display to Client.

app_show_valstring

Display to Client (raw value). Raw value of app_show. The app_show field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

custom_lb_bank_accountstring

Company Bank Name. Returned value: Company Bank Name.

lb_bank_account_numstring

Account No. Returned value: Account No.

lb_bank_account_namestring

Company Bank Name. Returned value: Company Bank Name.

member_idstring

Member ID. Returned value: Member ID.

custom_client_infostring

Client Document Info. Returned value: Client Document Info.

custom_bankstring

Client Bank Account. Returned value: Client Bank Account.

user_bank_namestring

Linked Bank Account Name. Returned value: Linked Bank Account Name.

bank_codestring

Bank Code. Returned value: Bank Code.

bank_card_numstring

Linked Bank Account No. Returned value: Linked Bank Account No.

custom_amountstring

Maximum Deposit Amount(Currency). Returned value: Maximum Deposit Amount(Currency).

currencystring

Auth Currency. Returned value: Auth Currency.

max_amountstring

Maximum Deposit Amount. Returned value: Maximum Deposit Amount.

statestring

Status. Returned value: Status.

state_valstring

Status (raw value). Raw value of state. The state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

custom_bank_returnstring

Custom Bank Return. Returned value: Custom Bank Return.

referencestring

Reference No. Returned value: Reference No.

verify_statestring

Manual Confirmation. Returned value: Manual Confirmation.

verify_state_valstring

Manual Confirmation (raw value). Raw value of verify_state. The verify_state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

bank_sec_fail_reasonstring

Error/Exception Remarks. Returned value: Error/Exception Remarks.

remarkstring

Remarks. Returned value: Remarks.

created_atstring

Created At. Returned value: Created At. The date or time format follows the value returned by the API.

updated_atstring

Updated At. Returned value: Updated At. The date or time format follows the value returned by the API.

bank_account_user_namestring

User Name. Returned value: User Name.

bank_account_user_pinyinstring

Client Name in Pinyin. Returned value: Client Name in Pinyin.

hk_credentials_nostring

Account Opening Document No. Returned value: Account Opening Document No.

busi_typestring

Approval Status. Returned value: Approval Status.

busi_type_valstring

Approval Status (raw value). Raw value of busi_type. The busi_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

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 --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/atm_edda_applications' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20' \
  --data-urlencode 'orderBy=[]'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "25476",
        "mandate_identification": "",
        "auth_type": "Initiated Via Online Banking",
        "auth_type_val": "2",
        "app_show": "YES",
        "app_show_val": "1",
        "custom_lb_bank_account": "",
        "lb_bank_account_num": "示例用户",
        "lb_bank_account_name": "示例用户",
        "member_id": "1000000000000000000",
        "custom_client_info": "User Name:示例用户\nClient Name in Pinyin:示例用户\nAccount Opening Document Type:Hong Kong, China\nAccount Opening Document No:X0000000\nAuth Currency:HKD",
        "custom_bank": "Bank Account Holder Name:PAN YONG\nBank Name(eDDA Authorization):353 China Minsheng Bank Corp.,\nBank Account:4234234234\nIs Bind Card:Bound",
        "user_bank_name": "PAN YONG",
        "bank_code": "353",
        "bank_card_num": "****0000",
        "custom_amount": "99,999,999.00 HKD",
        "currency": "HKD",
        "max_amount": "99,999,999.00",
        "state": "Activated",
        "state_val": "2",
        "custom_bank_return": "Reference No:H00000000\nError/Exception Remarks:--",
        "reference": "H00000000",
        "verify_state": "Confirmed",
        "verify_state_val": "3",
        "bank_sec_fail_reason": "--",
        "remark": "绑卡超过数量，等待银行卡审核",
        "created_at": "1737700463",
        "updated_at": "1784184750",
        "bank_account_user_name": "示例用户",
        "bank_account_user_pinyin": "示例用户",
        "hk_credentials_no": "H00000000",
        "busi_type": "Deactivate Pending",
        "busi_type_val": "49"
      }
    ],
    "total": 0
  }
}