Hong Kong Beneficiary
Before making a payment to an Hong Kong bank account, you must add the account as a beneficiary. Note that payments to Hong Kong beneficiaries are via bank transfer.
NOTE: Currencies available for Hong Kong are USD
, HKD
and CNY
Below is a sample request for creating a Hong Kong beneficiary:
cURL
curl --location '{{sandboxURL}}/beneficiaries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{APIKEY}}' \
--data '{
"reference": "<samplereference>",
"country": "HK",
"currency": "USD",
"destination": {
"type": "BANK",
"accountName": "John Doe",
"accountNumber": "1234567890",
"bankCode": 123,
"swiftCode": "HSBCHKHH",
"remittancePurpose": "FAMILY_SUPPORT",
"beneficiary": {
"type": "INDIVIDUAL",
"country": "US"
},
"sender": {
"type": "INDIVIDUAL",
"accountName": "Jane Smith Doe",
"country": "HK",
"city": "Hong Kong",
"address": "123 Main Street, Central",
"postCode": "999077",
"idNumber": "A1234567",
"dateOfBirth": "1990-05-15"
}
}
}'
The parameters for adding an Hong Kong bank account beneficiaries are:
Parameter | Description | Required |
---|---|---|
type | The type of destination. Must be "BANK". | ✅ |
accountName | Name of the beneficiary's account. A space separated first and last name must be provided for individual beneficiaries e.g Marie Dubois | ✅ |
accountNumber | The beneficiary's Account number. | ✅ |
remittancePurpose | Purpose of the remittance. See accepted remittance purposes here (opens in a new tab) | ✅ |
bankCode | Code of the receiving bank See accepted bankCodes here (opens in a new tab) | ✅ |
swiftCode | Code of the bank | |
sender | Sender information varies depending on type. Sender type can either be BUSINESS or INDIVIDUAL. | ✅ |
beneficiary | Beneficiary information. | ✅ |
Sender Parameters (Business)
Parameter | Description | Required |
---|---|---|
sender[type] | Type of sender. Must be "BUSINESS". | ✅ |
sender[accountName] | Name of the sender's account. A space separated first and last name must be provided for individual senders e.g John Doe | ✅ |
sender[country, city, address, postCode] | Sender's address details | ✅ |
sender[email] | Sender's email address | ✅ |
sender[businessRegistrationNumber] | Business registered number | ✅ |
Sender Parameters (Individual)
Parameter | Description | Required |
---|---|---|
sender[type] | Type of sender. Must be "INDIVIDUAL" | ✅ |
sender[accountName] | Name of the sender's account. A space separated first and last name must be provided for individual senders e.g John Doe | ✅ |
sender[country, city, address, postCode] | Sender's address details | ✅ |
sender[idNumber] | Sender's id number | ✅ |
sender[dateOfBirth] | Sender's date of birth It must be in the format YYYY-MM-DD e.g 2025-03-21 | ✅ |
Beneficiary Parameters
Parameter | Description | Required |
---|---|---|
beneficiary[type] | Type of beneficiary, either "BUSINESS" or "INDIVIDUAL" | ✅ |
beneficiary[country] | Beneficiary's country | ✅ |