Banks of Hong Kong

Overview

Banks of Hong Kong is a payment method allowing to make payouts to bank accounts in Hong Kong. Payouts can be performed by using Gate or Dashboard (Old Dashboard).

General information

Payment method type bank transfers
Countries and regions HK
Payment currencies HKD, CNY
Currency conversion
Purchases
Payouts +
Credential-on-file (COF) purchases
Full refunds
Partial refunds
Chargebacks
Special considerations
Obtaining access to the payment method and access fee refer to your ECommPay Key Account Manager

Interaction diagram

Payment processing by using the Banks of Hong Kong payment method requires the use of merchant web service, one of the ECommPay interfaces, the ECommPay payment platform, and provider's technical facilities.



Operations support

  Interfaces Amounts, HKD Timespans*
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) minimum maximum basic time threshold time
Payouts + + 4,000,000.00
* The basic time and the threshold time are defined as follows:
  • The basic time is the average time from the moment a payment is initiated in the payment platform to the moment the information about the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). You can use the basic time to define the moment of reacting to the absence of payment result callbacks or checking payment status.
  • The threshold time is the maximum possible time from the moment a payment is initiated in the payment platform to the moment the information about the payment result is sent to the initiator. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ECommPay technical support.

Processing scenarios

For payout processing by using the Banks of Hong Kong method you need to notify customer via merchant's web service.

Figure: Payout by using Gate



Supported banks

Payments by using the Banks of Hong Kong method are carried out through banks that support the work with this method. Banks have their own identifiers which are used to initiate payouts by using Gate.

Note: The table below provides information on some of the supported banks for informational purposes, it may change without additional notice. For more details, see the List of the supported banks. For the most recent list of supported banks, contact your ECommPay Key Account Manager.
Table 1. Non-exhaustive list of supported banks
Bank ID
BANK OF CHINA (HONG KONG) LIMITED Cheung Chau Branch 54661
BANK OF COMMUNICATIONS CO., LTD. Hong Kong Branch 53911
CHANG HWA COMMERCIAL BANK LTD Hong Kong Branch 53121
CHINA CITIC BANK INTERNATIONAL LIMITED Mei Foo Branch 36991
CHINA CONSTRUCTION BANK (ASIA) CORPORATION LIMITED Hunghom Ma Tau Wai Road Branch 53571
CHONG HING BANK LTD Hong Kong Main Branch 31061
CHONG HING BANK LTD North Point Branch 54311
CIMB BANK BERHAD Hong Kong Branch 54021
CITIBANK (HONG KONG) LIMITED Mei Foo Sun Chuen Branch 54481
DAH SING BANK LTD Fortress Hill Branch 54071
DAH SING BANK LTD Tai Po Branch 53181
DBS BANK (HONG KONG) LIMITED Yaumatei Branch 54441
FUBON BANK (HONG KONG) LIMITED Chai Wan Branch 53851
FUBON BANK (HONG KONG) LIMITED Yuen Long Branch 48651
HANG SENG BANK LTD Fortune Kingswood Branch 35031
HANG SENG BANK LTD Tai Po Branch 54651
INDUSTRIAL AND COMMERCIAL BANK OF CHINA (ASIA) LTD Central Branch 54471
NANYANG COMMERCIAL BANK LTD Western Branch 54221
OCBC WING HANG BANK LIMITED Fortress Hill Branch 53031
PUBLIC BANK (HONG KONG) LIMITED Prince Edward Branch 53821
PUBLIC BANK (HONG KONG) LIMITED Tai Po Branch 44931
SHANGHAI COMMERCIAL BANK LTD Mongkok Branch 54511
SHANGHAI COMMERCIAL BANK LTD West Point Branch 54551
STANDARD CHARTERED BANK (HONG KONG) LIMITED Kwun Tong Branch 54011
TAI YAU BANK LTD Head Office 25681
THE BANK OF EAST ASIA, LTD Chai Wan Branch 43941
THE BANK OF EAST ASIA, LTD Main Branch 27401
THE HONGKONG AND SHANGHAI BANKING CORPORATION LTD Paterson Street HPC 54601
TMB BANK PUBLIC COMPANY LIMITED, HONG KONG Hong Kong Branch 54061
WING LUNG BANK LTD Happy Valley Branch 53991

The following sections provide detailed information about what you need to do in order to perform payments and how you can analyse the information on payments and operations.

Payout by using Gate

General information

To perform a payout through the Banks of Hong Kong method, merchant's web service sends a request with all the required parameters and signature to ECommPay URL, and receives a callback with the payment result. The full sequence of the payout process is provided below.



Figure: Payout by using Gate

  1. In the merchant's web service the customer orders a payout.
  2. Merchant's web service sends the request for the payout processing by using Gate to the appropriate ECommPay URL.
  3. Gate redirects the request to the ECommPay payment platform.
  4. The payment platform performs all the necessary checks and processes the request.
  5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
  6. The payment platform redirects the payout request to the provider service.
  7. The payout is processed on the side of the provider.
  8. The provider service sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. The customer receives the notification about the payout result from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Banks of Hong Kong payment method and provide the information on the format of callbacks with payout results.

Request format

There are several things you must consider when using payout requests in the Banks of Hong Kong method:
  1. You send payout requests by sending request to /v2/payment/banks/hk/payout by using HTTP method POST. This is an online banking request group: /v2/payment/banks/{payment_method}/payout
  2. The following objects and parameters must be specified in any request:
    • Object general—general payout information:
      • project_id—project identifier
      • payment_id—unique payout identifier
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • Object customer—customer information:
      • ip_address—customer IP address
      • id—customer ID unique within the project
    • Object account—customer account information:
      • bank_id—bank identifier
      • number—customer account number
      • customer_name—customer name
    • Object payment—payout information:
      • amount—payout amount in minor units
      • currency—payout currency in the ISO-4217 alpha-3 format
  3. The currency of payment can only be HKD or CNY.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Banks of Hong Kong method must include project, customer, bank and payment IDs, account number and customer name, customer IP address, currency and amount of the payout, and signature, as shown in the following example:

Figure: Example of a payout request

{
    "general": {
      "project_id": 383000,
      "payment_id": "12278b5d662764c9506b4db9df8c5c35",
      "signature": "GINgwlggTvpF9AnkT8rUUVC7bmSCAaQlYc9Mtb3Lv...5vOA7w=="
    },
    "customer": {
      "id": "fr-2374245",
      "ip_address": "1.1.1.1"
    },
    "payment": {
      "amount": 10000,
      "currency": "HKD"
  },
    "account": {
      "bank_id": 22791,
      "number": "1234567890",
      "customer_name": "John Doe"
  }
}

Callback format

The Banks of Hong Kong method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 100.00 HKD payout made for the customer3 customer in the 789 project.

Figure: Example of a successful payout callback

{
        "project_id": 789,
        "payment": {
            "id": "ABC1234321",
            "type": "payout",
            "status": "success",
            "date": "2021-04-26T08:41:59+0000",
            "method": "hk",
            "sum": {
                "amount": 10000,
                "currency": "HKD"
            },
            "description": ""
        },
        "account": {
            "number": "1234567"
        },
        "customer": {
            "id": "customer3"
        },
        "operation": {
            "id": 4348000010681,
            "type": "payout",
            "status": "success",
            "date": "2021-04-26T08:41:59+0000",
            "created_date": "2021-04-26T08:41:54+0000",
            "request_id": "3d7ef0727decad0829d608cabd0f8a6d96fbd3a...006256",
            "sum_initial": {
                "amount": 10000,
                "currency": "HKD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "HKD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 5181,
                "payment_id": "aff0b...cf9f2cd",
                "auth_code": "",
                "date": "2021-04-26T08:41:55+0000"
            }
        },
        "signature": "1L2fmnHY/51dZPI1j/IVa9LqzEPR67j9pPghn...c545R1xsGzw0zQ=="
    }
}

The following is the example of a callback for a declined payout.

Figure: Example of a declined payout callback

{
        "project_id": 0123,
        "payment": {
            "id": "ABC1234567",
            "type": "payout",
            "status": "decline",
            "date": "2021-04-26T08:41:59+0000",
            "method": "hk",
            "sum": {
                "amount": 10000,
                "currency": "HKD"
            },
            "description": ""
        },
        "account": {
            "number": "123456789"
        },
        "customer": {
            "id": "customer1234"
        },
        "operation": {
            "id": 4348000010681,
            "type": "payout",
            "status": "decline",
            "date": "2021-04-26T08:41:59+0000",
            "created_date": "2021-04-26T08:41:54+0000",
            "request_id": "a19b65b2463fa7377f518d49674275cbaa4397a7...004349",
            "sum_initial": {
                "amount": 10000,
                "currency": "HKD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "HKD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 5181,
                "payment_id": "aff0b...cf9f2cd",
                "auth_code": "",
                "date": "2021-04-26T08:41:55+0000"
            }
        },
        "signature": "eQxj9hXHVWFBDMcko2Tj0071CvnFPsp...A9CchCgVr/Hqbu6w=="
    }
}

Related topics

The following topics might be useful when implementing payments through Gate:

Payouts by using Dashboard (Old Dashboard)

To make a payout through Dashboard (Old Dashboard), the merchant sends a request, and receives a notification with the request processing result. There are two ways to initiate payouts through Dashboard (Old Dashboard):
  • as a single payout—in this case, you must specify the currency and amount for a payout available for this method, and fill in all fields required on the Dashboard (Old Dashboard) interface in accordance with the selected payment method
  • as a part of a mass payment—in this case, all parameters are specified in a CSV file in accordance with the requirements in the Payouts by using Gate section (except for the signature)

Information about performed payouts is displayed in the Payments section of Dashboard (Old Dashboard).

More detailed information on the payout processing by using Dashboard (Old Dashboard) is provided in the Performing payouts section.

Analysis of payment results

As with other payment methods ECommPay offers, when using the Banks of Hong Kong method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

  • Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
  • Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ECommPay technical support.