Banks of Hong Kong

General information

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

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.

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.

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

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:

{
    "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.

{
        "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.

{
        "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:

• Interaction models
• Signature generation and verification
• Payment models and statuses
• Information of operations performing

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 in the Analytics section for this purpose.

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 format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
• 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 means of sending requests to the /operations/get endpoint.

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