Skip to content
Longport WhaleLongport Whale
Bank Card - Country／Region

Bank Card - Country／Region

Queries Bank Card - Country/Region 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_bank_country_codes

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_regionbanks.bank_country_codeRequired

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.

name_cnstring

Country/Region - Simplified. Filters results by Country/Region - Simplified.

name_enstring

Country/region - English. Filters results by Country/region - English.

is_allow_bind_cardstring

Whether Card Binding Is Allowed. Filters results by Whether Card Binding Is Allowed.

Allowed values:

  • 0 - Not Allowed
  • 1 - Allowed

01

updated_atobject

Update Time. Filters results by Update Time.

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.

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 - Country/Region 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: Records matching the query conditions.

Child attributes
idstring

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

account_channelstring

Account Channel. Returned value: Account Channel.

is_allow_bind_cardstring

Whether Card Binding Is Allowed. Returned value: Indicates whether whether card binding is allowed.

name_cnstring

Country/Region - Simplified. Returned value: Country/Region - Simplified.

name_enstring

Country/region - English. Returned value: Country/region - English.

name_tnstring

Country/Region - Traditional. Returned value: Country/Region - Traditional.

name_pnstring

Country/Region - Pinyin. Returned value: Country/Region - Pinyin.

detailstring

Country/Region - Full name. Returned value: Country/Region - Full name.

letterstring

One Letter Code. Returned value: One Letter Code.

code1string

Two Letter Code. Returned value: Two Letter Code.

code2string

Three Letter Code. Returned value: Three Letter Code.

country_nostring

Digital Code. Returned value: Digital Code.

remarkstring

Remark. Returned value: Remark.

created_atstring

Creation Time. Returned value: Creation Time. 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.

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

Whale Docs