FAQs

Account information retrieval

• Personal customers
• Corporate and SME customers

For Open API implementation of Hong Kong, please refer to HKMA website.

For “Education on Using Banking Services under Open APIs”, please click here.

Phase 1: Access to product and service information
Phase 2: Apply for products and services
Phase 3: Retrieve account information
Phase 4: Pay FPS merchants (app-to-app/web-to-app)

Please note that Youth i-account, WMC account, MPF account, Kid master, credit card accounts and private banking customer are not eligible for the services currently.

The steps for granting consent to share account information with TSP are as follows:

1. Log in to the TSP’s website or mobile app and select the Bank to initiate the grant consent request. Review the consent details including purpose of data for access, types of data to be accessed and consent expiry date. The TSP will then redirect you to the Bank’s Open API webpage for authentication.
2. Log in with your Cyberbanking credentials in the Bank’s Open API webpage and complete the two-factor authentication via SMS OTP (one-time password).
3. Review the consent details including the TSP’s name, consent expiry date, consent renewal frequency and types of data to be accessed.
4. Select the available accounts for data sharing from the designated list.
5. Read and acknowledge the relevant Terms & Conditions and the Personal Data (Privacy) Ordinance - Personal Information Collection (Customers) Statement (PICS) of the Bank, and confirm to provide consent to the Bank to share the account information with the TSP.
6. Confirm and redirect to the TSP’s website or mobile app to complete the process.

Upon completion, the Bank will send the notifications to your registered mobile phone number and email address through SMS and email.

TSPs would send renewal notification to you prior to the consent expiry date. TSPs may have different arrangements for sending renewal notifications, please check with the individual TSP for details. You may renew your consent following the steps below:

1. Log in to the TSPs website or mobile app and follow the instructions to renew consent to the Bank. Review the consent details including purpose of data for access, types of data to be accessed and consent expiry date. The TSP will then redirect you to the Bank’s Open API webpage for authentication.
2. Log in with your Cyberbanking credentials in the Bank’s Open API webpage and complete the two-factor authentication via SMS OTP (one time password).
3. Review the consent details including the TSP’s name, consent expiry date, consent renewal frequency and types of data to be accessed. The details should be the same as the previously granted consent except for the expiry date.
4. Read and acknowledge the relevant Terms & Conditions and the Personal Data (Privacy) Ordinance - Personal Information Collection (Customers) Statement (PICS) of the Bank, and confirm to provide consent to the Bank to share the account information with the TSP.
5. Confirm and redirect back to the TSPs website or mobile app to complete the process.

Upon completion, the Bank will send the notifications to your registered mobile phone number and email address through SMS and email.

You can revoke your consent in the channels as follows:

1. Through the TSP’s website or mobile app
2. Through Cyberbanking or BEA App
1. Log in to Cyberbanking or BEA App.
2. Go to “Settings” and select “Third Party Consent Management” to retrieve the records and details of the consent including TSP name, consent expiry date, selected accounts for data access, data accessible by TSP, consent status etc.
3. Select the desired consent record(s) and click “Revoke Consent” to proceed further.

Before revoking your consent, you should contact the TSP directly to understand the implications / consequences of doing so. Upon completion, the Bank will send the notifications to your registered email address.

1. TSP;
2. BEA App or Cyberbanking

The list of partnering TSPs and the corresponding specific products and services provided in partnership with the respective TSPs will be published on the Bank’s corporate website with timely updates.

Please refer to Bank’s corporate website for the latest list of partnering TSPs and the corresponding products and services. If you have any doubts about the TSP, please do not access to the TSP’s website or mobile app.

Before granting consent to TSP, you should understand from the TSP the scope and the usage of your account information and be aware of the associated risks.

If you would like to continue to use the Open API service, please renew your consent through the TSP prior to the expiry date.

The list of partnering TSPs and the corresponding specific products and services provided in partnership with the respective TSPs will be published on the Bank’s corporate website with timely updates. Please refer to Bank’s corporate website for the latest list of partnering TSPs and the corresponding products and services. If you have any doubts about the TSP, please do not access to the TSP’s website or mobile app or contact the Bank for assistance.

For Open API implementation of Hong Kong, please refer to HKMA website.

For “Education on Using Banking Services under Open APIs”, please click here.

Phase 1: Access to product and service information
Phase 2: Apply for products and services
Phase 3: Retrieve account information
Phase 4: Pay FPS merchants (app-to-app/web-to-app)

1. Log in BEA Corporate Online
2. Go to “Others > Open API > Open API Service – Set Up” to enable the Open API Service.
3. Log in to the TSP’s website and select the Bank to initiate the grant consent request. Review the consent details including purpose of data for access, types of data to be accessed and consent expiry date. The TSP will then redirect you to the Bank’s Open API webpage for authentication.
4. Log in with your BEA Corporate Online credentials in the Bank’s Open API webpage and complete the two-factor authentication via SMS OTP (one-time password).
5. Review the consent details including the TSP’s name, consent expiry date, consent renewal frequency and types of data to be accessed.
6. Select the available accounts for data sharing from the designated list.
7. Confirm and redirect to the TSP’s website to complete the process.

Upon completion, the Bank will send the notifications to your registered mobile phone number and email address (includes company email address) through SMS and email.

TSPs would send renewal notification to you prior to the consent expiry date. TSPs may have different arrangements for sending renewal notifications, please check with the individual TSP for details. You may renew your consent following the steps below:

1. Log in to the TSPs website and follow the instructions to renew consent to the Bank. Review the consent details including purpose of data for access, types of data to be accessed and consent expiry date. The TSP will then redirect you to the Bank’s Open API webpage for authentication.
2. Log in with your BEA Corporate Online credentials in the Bank’s Open API webpage and complete the two-factor authentication via SMS OTP (one time password).
3. Review the consent details including the TSP’s name, consent expiry date, consent renewal frequency and types of data to be accessed. The details should be the same as the previously granted consent except for the expiry date.
4. Read and acknowledge the relevant Terms & Conditions and the Personal Information Collection (Customers) Statement (PICS) of the Bank, and confirm to provide consent to the Bank to share the account information with the TSP.
5. Confirm and redirect back to the TSPs website to complete the process.

Upon completion, the Bank will send the notifications to your registered mobile phone number and email address (includes company email address) through SMS and email.

You can revoke your consent in the channels as follows:

1. Through the TSP’s website or mobile app
2. Through BEA Corporate Online
1. Log in to BEA Corporate Online.
2. Go to “Others > Open API > Third Party Service Provider Consent Management” to retrieve the records and details of the consent including TSP name, consent expiry date, consent status etc.
3. Select the desired consent record(s) and click “Revoke Consent” to proceed further.

Before revoking your consent, you should contact the TSP directly to understand the implications / consequences of doing so. Upon completion, the Bank will send the notifications to your company and consent owner’s email address.

1. TSP;
2. BEA Corporate Online

The list of partnering TSPs and the corresponding specific products and services provided in partnership with the respective TSPs will be published on the Bank’s corporate website with timely updates.

Please refer to Bank’s corporate website for the latest list of partnering TSPs and the corresponding products and services. If you have any doubts about the TSP, please do not access to the TSP’s website or mobile app.

Before granting consent to TSP, you should understand from the TSP the scope and the usage of your account information and be aware of the associated risks.

If you would like to continue to use the Open API service, please renew your consent through the TSP prior to the expiry date.

The list of partnering TSPs and the corresponding specific products and services provided in partnership with the respective TSPs will be published on the Bank’s corporate website with timely updates. Please refer to Bank’s corporate website for the latest list of partnering TSPs and the corresponding products and services. If you have any doubts about the TSP, please do not access to the TSP’s website or mobile app or contact the Bank for assistance.