Bank Card Management

Queries Bank Card Management data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

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

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_account_withdraw_card.listatm.withdrawal_markingRequired

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

member_idstring

Client. Filters results by Client.

member_id_liststring

Client List. Filters results by Client List.

raw_member_idstring

Client ID. Filters results by Client ID.

idstring

Client Bank Card ID. Filters results by Client Bank Card ID.

account_typestring

Currency. Filters results by Currency.

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

statusstring

Verification Status. Filters results by Verification Status.

Allowed values:

0 - Without Authentication
1 - Authentication In Progress
2 - Authentication Succeeded

012

accountstring

Account. Filters results by Account.

countrystring

Country. Filters results by Country.

fps_idstring

FPS ID. Filters results by FPS ID.

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.

name_enstring

Bank Card Name. Filters results by Bank Card Name.

regionstring

Region Name. Filters results by Region Name.

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

bank_codestring

Bank Code. Filters results by Bank Code.

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

multi_namestring

Bank Name. Filters results by Bank Name.

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 Bank Card Management 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

Client Bank Card ID. Returned value: Unique identifier of the current record.

id_valstring

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

member_idstring

Client ID. Returned value: Client ID.

member_id_valstring

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

origin_idsstring

A/C No.. Returned value: A/C No..

name_enstring

Bank Account Name. Returned value: Bank Account Name.

accountstring

Account. Returned value: Account.

fps_idstring

FPS ID. Returned value: FPS ID.

account_typestring

Currency. Returned value: Currency.

account_type_valstring

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

bank_multi_namestring

Bank Name. Returned value: Bank Name.

nicknamestring

Nickname. Returned value: Nickname.

bank_codestring

Bank Code. Returned value: Bank Code.

regionstring

Bank Region. Returned value: Bank Region.

region_valstring

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

countrystring

Country. Returned value: Country.

provincestring

Province. Returned value: Province.

citystring

City. Returned value: City.

postal_codestring

Postal Code. Returned value: Postal Code.

swift_codestring

Swift Code. Returned value: Swift Code.

addressstring

Address. Returned value: Address.

custom_material_urlsstring

Supporting Materials. Returned value: Supporting Materials.

statusstring

Withdrawal Verification Status. Returned value: Withdrawal Verification Status.

status_valstring

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

custom_showstring

Deposit Attestation Status. Returned value: Deposit Attestation Status.

created_atstring

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

updated_atstring

Update Time. Returned value: Update Time. The date or time format follows the value returned by the API.

remarkstring

Client's Remarks. Returned value: Client's Remarks.

admin_commentstring

Remarks. Returned value: Remarks.

ticket_busi_typestring

Approval Status. Returned value: Approval Status.

ticket_busi_type_valstring

Approval Status (raw value). Raw value of ticket_busi_type. The ticket_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_withdraw_cards' \
  --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": "385859",
        "id_val": "",
        "member_id": "1000000000000000000",
        "member_id_val": "",
        "origin_ids": "H00000000",
        "name_en": "autotest",
        "account": "478616482866216",
        "fps_id": "789",
        "account_type": "ALL",
        "account_type_val": "ALL",
        "bank_multi_name": "389 MOX Bank",
        "nickname": "",
        "bank_code": "389",
        "region": "Banks in Hong Kong",
        "region_val": "HONGKONG",
        "country": "Hong Kong",
        "province": "",
        "city": "",
        "postal_code": "",
        "swift_code": "MOXBHKHK",
        "address": "",
        "custom_material_urls": "",
        "status": "Authentication Succeeded",
        "status_val": "2",
        "custom_show": "  Without Witness ",
        "created_at": "1784184549",
        "updated_at": "1784184552",
        "remark": "",
        "admin_comment": "",
        "ticket_busi_type": "Initial",
        "ticket_busi_type_val": "0"
      }
    ],
    "total": 62858
  }
}