Skip to main content
Payouts via FPS offer a fast and cost-effective way to disburse funds in Hong Kong using the Faster Payment System (FPS). FPS lets you send money to a beneficiary using the proxy identifier they registered with FPS: a mobile number, an email address or an FPS ID. You don’t need to collect the beneficiary’s bank account details. This documentation will guide you through the technical and operational steps required to manage payouts via FPS in Hong Kong.

Key Features

  • Payouts are delivered in near real-time
  • No cut-off times
  • Supported currencies - HKD, CNY
  • Minimum limit - 1 HKD / 1 CNY
  • Maximum limit - 1,000,000 HKD / 1,000,000 CNY

Building an integration

Step 1: Initiate a payout request

Tazapay uses a payout object to represent your intent to initiate a payout. The payout object tracks state changes from when the payout is initiated to when the beneficiary receives the funds. Create a payout on your server using Tazapay’s payout API with the following information:
  • Payout Amount - The amount in HKD or CNY you want to transfer to the beneficiary
  • Type of Payout - local_payment_network
  • Beneficiary Details
    • Name - The beneficiary’s name
    • Type - business or individual
    • Destination Details
      • Local payment network type - fps_hkd for HKD, fps_cny for CNY
      • Currency - HKD for fps_hkd, CNY for fps_cny
      • Proxy type (deposit_key_type)
      • Proxy value (deposit_key)
  • Reason for Payout
  • Transaction Description - Additional Description for a payout

Possible values for deposit_key_type

To pay a Hong Kong bank account over FPS instead of a proxy, create a local bank payout with local.fund_transfer_network set to fps. See Create Payout.

Validations for proxy value

Ensure the following validations on your application for customer input for the proxy value. Proper error handling should be implemented for cases where validations fail. A payout or beneficiary with an invalid proxy value, or with a deposit_key_type other than phone, email or fps_id, is rejected with error code 20301 (Field is required and must be a valid deposit key).

Sample Request cURL

Response

id is the unique identifier you can use to track the payout.

Alternatively, Creating a beneficiary and then initiating a payout

To align with your workflow, you can also choose to split Step 1 into two steps

Step 1A: Creating a beneficiary

Tazapay uses a beneficiary object to represent the receiver of funds of a payout. Pass the beneficiary name, type, the local payment network type and currency, the proxy type and the proxy value to the /v3/beneficiary endpoint. The proxy value is validated when the beneficiary is created. The possible values for deposit_key_type and the validations for the proxy value are the same as in Step 1.

Sample Request cURL

Response

id is the unique identifier for a beneficiary. Pass this in the Create Payout API to initiate a payout.

Step 1B: Initiating a payout to the existing beneficiary

Create a payout on your server using Tazapay’s payout API with the following information:
  • Payout Amount and Currency - The amount you want to transfer to the beneficiary
  • Beneficiary ID
  • Type of Payout - local_payment_network
  • Reason for Payout
  • Transaction Description - Additional Description for a payout

Sample cURL

Response

The response is the same payout object as in Step 1.
id is the unique identifier for a payout. You can use this to track the payout.

Handle Payout Events

A payout is in the processing state after it is successfully initiated. The payout can move to one of the following three states from the processing state:
  1. requires_action - This is when the payout requires additional information. These additional information are typically required for reasons of regulatory compliance. Tazapay will reach out to your registered email address specifying the exact requirements and the next steps. After you have provided the necessary information, Tazapay will review and the payout can subsequently move to either succeeded or failed.
  2. succeeded - The beneficiary has successfully received the funds. For a successful FPS payout, tracking_details carries the payment’s UTR.
  3. failed - This is the state when the payout fails. Any funds deducted for the payout will be credited back to your account. Tazapay specifies the reason for the failure in the field status_description
Tazapay delivers webhooks to your registered endpoint notifying you of any event of interest for the payout.