China Beneficiary
Before making a payment to a China account, you are to add a beneficiary. Note that we can payout WeChat, Alipay or Bank(CNY, USD) accounts.
Sample request for adding a China Alipay Beneficiary
cURL
curl --location '{{sandboxURL}}/beneficiaries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{APIKEY}}' \
--data '{
"country": "CN",
"currency": "CNY",
"reference": "ref345678ghj",
"callbackUrl": "https://webhook.com/5ffe3c237a6cc182a86103c537fccee9",
"customerEmail": "jay@email.com",
"destination": {
"accountNumber": "+8618112292223",
"accountName": "Xu Xing",
"remittancePurpose": "FAMILY_SUPPORT",
"sender": {
"firstName": "Chan",
"lastName": "Ling",
"type": "INDIVIDUAL",
"address": "Xin Hua You Ju Dui Mian",
"postCode": "213000",
"nationalityCountry": "CN",
"countryOfBirth": "CN",
"country": "CN",
"dateOfBirth": "1997-11-12",
"idType": "PASSPORT",
"idNumber": "B07539234"
},
"type": "ALIPAY"
}
}'
The parameters for adding beneficiary for China Alipay accounts are:
Parameter | Description | Required |
---|---|---|
accountNumber | Account number of the beneficiary (Account number must a Chinese Phone number) | ✅ |
accountName | Account name of the beneficiary (Account name must be first and last name) | ✅ |
remittancePurpose | Purpose of the remittance, selected from predefined options. See accepted remittance purposes here (opens in a new tab) | ✅ |
type | Specify payment type as ALIPAY . | ✅ |
sender | Sender information. Expanded below. | ✅ |
Sender Parameters
Parameter | Description | Required |
---|---|---|
sender[type] | Type of sender is "INDIVIDUAL". | ✅ |
sender[firstName] | First name of the sender. | ✅ |
sender[lastName] | Last name of the sender. | ✅ |
sender[nationalityCountry] | Nationality Country of the sender's account. | ✅ |
sender[countryOfBirth] | Sender's country of birth. | ✅ |
sender[dateOfBirth] | Sender's date of birth. | ✅ |
sender[idType, idNumber] | Sender's identification details (type, number, and country). See accepted id types here (opens in a new tab) | ✅ |
sender[country, postCode] | Sender's address details: country, and postcode. | ✅ |