Banks of Hong Kong

Overview

Introduction

Banks of Hong Kong is a payment method which allows you to process payments in Hong Kong dollars and Chinese yuan by using bank accounts in Hong Kong. This method supports payouts.

This article provides information about working with the Banks of Hong Kong method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Payment method type bank payments
Payment instruments bank accounts
Countries and regions HK
Payment currencies HKD, CNY
Currency conversion
One-time purchases
Credential-on-file purchases
Full refunds
Partial refunds
Payouts +
Chargebacks
Special considerations
Obtaining access to the payment method and access fee refer to your ecommpay key account manager; additional information is available in ecommshop

Interaction diagram

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



Operations support

Various platform interfaces can be used to process payments and perform operations using the Banks of Hong Kong method. Payouts can be processed by using Gate and Dashboard. At the same time, regardless of the interfaces used, the following limitations are applicable.

When working with the Banks of Hong Kong the following limitations are applicable.

Amounts, HKD
minimum maximum
Payouts 4,000,000.00

Processing scenarios

To process a payout, you need to notify the customer via the web service.

Figure 1. Payout by using Gate


At the same time, the specifics of working with the method include the necessity of selecting a bank for each payment. When payments are initiated through Gate, the bank must be selected on the side of the web service and the identifier of this bank must be specified in requests. Ways of using bank identifiers are described in the next subsection, Supported banks.

Supported banks

The following table lists the names and identifiers of some banks supported by the Banks of Hong Kong method, the list 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.

Figure 2. List of 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

If you have any questions about working with banks supported by the Banks of Hong Kong method, refer to your ecommpay account manager.

Payout by using Gate

General information

To process a payout through Gate by using the Banks of Hong Kong method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of payout processing are provided below.



Figure 3. Payout processing by using Gate: step-by-step description
  1. A customer initiates a payout by using the Banks of Hong Kong method in the web service.
  2. The web service sends the request for processing the payout by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the provider service.
  7. The payout is processed on the side of the provider service.
  8. The provider service sends the result notification to the payment platform.
  9. The payment platform sends the result callback to the web service.
  10. The customer receives the payout result information from the web service.

Information about the formats of requests and callbacks used for processing payouts by using the Banks of Hong Kong method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending payout requests by using the Banks of Hong Kong method:

  1. To initiate each payout send a separate POST request to the /v2/payment/banks/hk/payout endpoint. This endpoint belongs to the group /v2/payment/banks/{payment_method}/payout.
  2. Each request must include the following objects and parameters:
    • Object general—general payout information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) details
    • Object payment—payment information:
      • amount—payout amount in the smallest currency unit
      • currency—payout currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payout
    • Object account—customer account information:
      • bank_id—bank identifier
      • number—customer account number
      • customer_name—customer name
  3. The currency of payment can only be HKD or CNY.
  4. Additionally, any other parameters included in the specification can be used.

Thus, a correct payout request by using the Banks of Hong Kong method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and IP address, as well as account information and signature.

{
    "general": {
      "project_id": 383000,
      "payment_id": "12278b5d662764c9506b4db9df8c5c35",
      "signature": "GINgwlggTvpF9AnkT8rUUVC7bmSCAaQlYc9Mtb3Lv...5vOA7w=="
    },
    "customer": {
      "id": "fr-2374245",
      "ip_address": "192.0.2.0"
    },
    "payment": {
      "amount": 10000,
      "currency": "HKD"
  },
    "account": {
      "bank_id": 22791,
      "number": "1234567890",
      "customer_name": "John Doe"
  }
}
Figure 4. Example of sufficient data in a payout request
{
    "general": {
      "project_id": 383000,
      "payment_id": "12278b5d662764c9506b4db9df8c5c35",
      "signature": "GINgwlggTvpF9AnkT8rUUVC7bmSCAaQlYc9Mtb3Lv...5vOA7w=="
    },
    "customer": {
      "id": "fr-2374245",
      "ip_address": "192.0.2.0"
    },
    "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 information about a 100.00 HKD payout made for the customer3 customer in the 789 project.

Figure 5. Example of callback data indicating that the payout has been processed
{
        "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 with information about a declined payout.

Figure 6. Example of callback data indicating that the payout has been declined
{
        "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=="
    }
}

Useful links

The following articles can be useful when implementing payouts via Gate:

Payouts by using Dashboard

When working with Dashboard, you can process single and mass payouts by using the Banks of Hong Kong method.

  • To process a single payout, open the payout form, specify all required parameters (including the payment method), send a request and verify that the payout has been processed.
  • To process a mass payout, prepare and upload a file with information about all target payouts, send a batch request, and verify that the payouts have been processed.

    Use a CSV file structured according to the requirements presented in the Mass payments data section. The payout parameters must comply with the requirements (you do not have to generate a signature because it is specified by Dashboard).

More information about processing payouts by using Dashboard is presented in a separate section.

Analysis of payment results

To analyse information about payments made with the Banks of Hong Kong method and other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.

If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.