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 apayout 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 -
businessorindividual - Destination Details
- Local payment network type -
fps_hkdfor HKD,fps_cnyfor CNY - Currency -
HKDforfps_hkd,CNYforfps_cny - Proxy type (
deposit_key_type) - Proxy value (
deposit_key)
- Local payment network type -
- 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 using the Create Beneficiary endpoint
- Step 1B: Initiating a payout using the Create Payout endpoint
Step 1A: Creating a beneficiary
Tazapay uses abeneficiary 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 samepayout 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 theprocessing state after it is successfully initiated. The payout can move to one of the following three states from the processing state:
- 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
succeededorfailed. - succeeded - The beneficiary has successfully received the funds. For a successful FPS payout,
tracking_detailscarries the payment’s UTR. - 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.